xdm/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{
    "meta:license": [
        "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/experience/campaign/notificationsubscription",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Notification Subscription",
    "type": "object",
    "meta:extensible": true,
    "description": "Adobe Campaign notification subscriptions allow end-users opt into topics that can be used for communication such as marketing subscription lists.",
    "definitions": {
        "notificationSubscription": {
            "properties": {
                "xdm:topicID": {
                    "title": "Topic Identifier",
                    "type": "string",
                    "description": "The topic that the end-user has subscribed to and opted into notifications for.",
                    "meta:titleId": "notificationsubscription##xdm:topicID##title##21351",
                    "meta:descriptionId": "notificationsubscription##xdm:topicID##description##59461"
                },
                "xdm:type": {
                    "title": "Subscription type",
                    "type": "string",
                    "description": "The type of notification/subscription.",
                    "meta:titleId": "notificationsubscription##xdm:type##title##70941",
                    "meta:descriptionId": "notificationsubscription##xdm:type##description##61421"
                },
                "xdm:subscriptionDate": {
                    "title": "Subscription Date",
                    "type": "string",
                    "format": "date-time",
                    "description": "Date and time when the end-user has subscribed to a notification topic. An end-user is subscribed if they have a Subscription Date and the `unsubscriptiondetails/unsubscriptionDate` is empty.",
                    "meta:titleId": "notificationsubscription##xdm:subscriptionDate##title##90581",
                    "meta:descriptionId": "notificationsubscription##xdm:subscriptionDate##description##28471"
                },
                "xdm:notificationTarget": {
                    "title": "Target/destination for the notification",
                    "description": "Target/destination for where to send/receive the notification.",
                    "$ref": "https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget",
                    "meta:titleId": "notificationsubscription##xdm:notificationTarget##title##22231",
                    "meta:descriptionId": "notificationsubscription##xdm:notificationTarget##description##54351"
                },
                "xdm:unsubscriptionDetails": {
                    "title": "Adobe Campaign Notification Unsubscription details",
                    "description": "Adobe Campaign notification unsubscription details.",
                    "$ref": "https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails",
                    "meta:titleId": "notificationsubscription##xdm:unsubscriptionDetails##title##97961",
                    "meta:descriptionId": "notificationsubscription##xdm:unsubscriptionDetails##description##90291"
                }
            },
            "required": [
                "xdm:topicID",
                "xdm:type",
                "xdm:subscriptionDate"
            ]
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/notificationSubscription"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "notificationsubscription##title##11091",
    "meta:descriptionId": "notificationsubscription##description##35941",
    "examples": [
        {
            "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
            "xdm:type": "Campaign/SubscriptionList",
            "xdm:subscriptionDate": "2017-02-26T15:52:25+00:00",
            "xdm:emailAddress": "johnDoe@adobe.com",
            "xdm:unsubscriptionDetails": {
                "xdm:unsubscriptionDate": "2017-09-26T15:52:25+00:00",
                "xdm:remarkID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3be",
                "xdm:remarkText": "Sorry, leave me alone. These are my personal comments"
            }
        },
        {
            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
            "xdm:type": "Campaign/SubscriptionList",
            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
            "xdm:emailAddress": "johnDoe@adobe.com"
        }
    ]
}