xdm/docs/reference/datatypes/address.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
{
    "meta:license": [
        "Copyright 2017 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/common/address",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Postal address",
    "type": "object",
    "meta:auditable": true,
    "meta:extends": [
        "http://schema.org/GeoCoordinates",
        "https://ns.adobe.com/xdm/common/geo"
    ],
    "description": "A postal address. Address could relate to a person's home, work, or preferred store location.",
    "definitions": {
        "address": {
            "properties": {
                "xdm:primary": {
                    "title": "Primary",
                    "type": "boolean",
                    "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time."
                },
                "xdm:label": {
                    "title": "Label",
                    "type": "string",
                    "description": "Free form name of the address."
                },
                "xdm:street1": {
                    "title": "Street 1",
                    "type": "string",
                    "description": "Primary street level information, apartment number, street number, and street name."
                },
                "xdm:street2": {
                    "title": "Street 2",
                    "type": "string",
                    "description": "Optional street information second line."
                },
                "xdm:street3": {
                    "title": "Street 3",
                    "type": "string",
                    "description": "Optional street information third line."
                },
                "xdm:street4": {
                    "title": "Street 4",
                    "type": "string",
                    "description": "Optional street information fourth line."
                },
                "xdm:region": {
                    "title": "Region",
                    "type": "string",
                    "description": "The region, county, or district portion of the address."
                },
                "xdm:postOfficeBox": {
                    "title": "Post office box",
                    "type": "string",
                    "description": "Post office box of the address.",
                    "maxLength": 20
                },
                "xdm:country": {
                    "title": "Country",
                    "type": "string",
                    "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language."
                },
                "xdm:state": {
                    "title": "State",
                    "type": "string",
                    "description": "The name of the State. This is a free-form field."
                },
                "xdm:status": {
                    "title": "Status",
                    "type": "string",
                    "description": "An indication as to the ability to use the address.",
                    "default": "active",
                    "meta:enum": {
                        "active": "Active",
                        "incomplete": "Incomplete",
                        "pending_verification": "Pending verification",
                        "blacklisted": "Blacklisted",
                        "blocked": "Blocked"
                    }
                },
                "xdm:statusReason": {
                    "title": "Status reason",
                    "type": "string",
                    "description": "A description of the current status."
                },
                "xdm:lastVerifiedDate": {
                    "title": "Last verified date",
                    "type": "string",
                    "format": "date",
                    "description": "The date that the address was last verified as still associated to the person."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "http://schema.org/GeoCoordinates"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/common/geo"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/common/auditable"
        },
        {
            "$ref": "#/definitions/address"
        }
    ],
    "meta:status": "stable",
    "examples": [
        {
            "@id": "https://data.adobe.io/entities/address/123",
            "xdm:primary": false,
            "xdm:street1": "345 Park Ave",
            "xdm:city": "San Jose",
            "xdm:stateProvince": "US-CA",
            "xdm:postalCode": "95110",
            "xdm:country": "United States",
            "xdm:countryCode": "US",
            "schema:latitude": 37.3382,
            "schema:longitude": 121.8863,
            "xdm:status": "active",
            "xdm:lastVerifiedDate": "2018-01-02"
        }
    ]
}