xdm/docs/reference/fieldgroups/profile/profile-responses.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
{
    "meta:license": [
        "Copyright 2022 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/xdm/mixins/profile-responses",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Phone Responses (Experimental, please expect breaking changes)",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "Use this to add various profile responses like email, postal mail etc(Experimental, please expect breaking changes).",
    "definitions": {
        "profile-response": {
            "properties": {
                "xdm:emailResponse": {
                    "type": "object",
                    "title": "Email responses",
                    "properties": {
                        "xdm:isEmailBounced": {
                            "title": "Email Bounced Indicator",
                            "type": "boolean",
                            "description": "Email bounced Indicator.",
                            "meta:titleId": "profile-responses##xdm:isEmailBounced##title##92141",
                            "meta:descriptionId": "profile-responses##xdm:isEmailBounced##description##11371"
                        },
                        "xdm:emailBouncedDate": {
                            "title": "Email Bounced Date",
                            "type": "string",
                            "format": "date-time",
                            "description": "Email bounced date.",
                            "meta:titleId": "profile-responses##xdm:emailBouncedDate##title##68831",
                            "meta:descriptionId": "profile-responses##xdm:emailBouncedDate##description##39011"
                        },
                        "xdm:emailBouncedReason": {
                            "title": "Email Bounced Reason",
                            "type": "string",
                            "description": "Email bounced reason.",
                            "meta:titleId": "profile-responses##xdm:emailBouncedReason##title##24051",
                            "meta:descriptionId": "profile-responses##xdm:emailBouncedReason##description##52991"
                        }
                    },
                    "meta:titleId": "profile-responses##xdm:emailResponse##title##50741"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/profile-response"
        }
    ],
    "meta:status": "experimental",
    "meta:titleId": "profile-responses##title##10381",
    "meta:descriptionId": "profile-responses##description##1341",
    "examples": [
        {
            "xdm:emailResponse": {
                "xdm:emailBouncedDate": "2020-04-11T05:05:05Z",
                "xdm:emailBouncedReason": "Mail Does not exist"
            }
        }
    ]
}