-
Notifications
You must be signed in to change notification settings - Fork 1
/
profile-person-details-v2.schema.json
328 lines (328 loc) · 15.4 KB
/
profile-person-details-v2.schema.json
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
{
"meta:license": [
"Copyright 2020 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-person-details-v2",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Demographic Details v2",
"type": "object",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [
"https://ns.adobe.com/xdm/context/profile"
],
"description": "Demographic information such as name, gender, and birth date of an individual.",
"definitions": {
"person": {
"properties": {
"xdm:person": {
"title": "Person",
"$ref": "https://ns.adobe.com/xdm/context/person",
"description": "An individual actor, contact, or owner.",
"meta:titleId": "profile-person-details-v2##xdm:person##title##8961",
"meta:descriptionId": "profile-person-details-v2##xdm:person##description##88961"
}
}
},
"person-name-firstName": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:name": {
"type": "object",
"properties": {
"xdm:firstName": {
"title": "First name",
"type": "string",
"description": "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable.",
"meta:titleId": "profile-person-details-v2##xdm:firstName##title##19951",
"meta:descriptionId": "profile-person-details-v2##xdm:firstName##description##1301"
}
}
}
}
}
}
},
"person-name-lastName": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:name": {
"type": "object",
"properties": {
"xdm:lastName": {
"title": "Last name",
"type": "string",
"description": "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable.",
"meta:titleId": "profile-person-details-v2##xdm:lastName##title##89531",
"meta:descriptionId": "profile-person-details-v2##xdm:lastName##description##8141"
}
}
}
}
}
}
},
"person-name-middleName": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:name": {
"type": "object",
"properties": {
"xdm:middleName": {
"title": "Middle name",
"type": "string",
"description": "Middle, alternative, or additional names supplied between the first name and last name.",
"meta:titleId": "profile-person-details-v2##xdm:middleName##title##52751",
"meta:descriptionId": "profile-person-details-v2##xdm:middleName##description##64241"
}
}
}
}
}
}
},
"person-name-courtesyTitle": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:name": {
"type": "object",
"properties": {
"xdm:courtesyTitle": {
"title": "Courtesy title",
"type": "string",
"description": "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr.",
"meta:titleId": "profile-person-details-v2##xdm:courtesyTitle##title##64641",
"meta:descriptionId": "profile-person-details-v2##xdm:courtesyTitle##description##12211"
}
}
}
}
}
}
},
"person-name-suffix": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:name": {
"type": "object",
"properties": {
"xdm:suffix": {
"title": "Suffix",
"type": "string",
"description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc.",
"meta:titleId": "profile-person-details-v2##xdm:suffix##title##64001",
"meta:descriptionId": "profile-person-details-v2##xdm:suffix##description##82531"
}
}
}
}
}
}
},
"person-name-fullName": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:name": {
"type": "object",
"properties": {
"xdm:fullName": {
"title": "Full name",
"type": "string",
"description": "The full name of the person, in writing order most commonly accepted in the language of the name.",
"meta:titleId": "profile-person-details-v2##xdm:fullName##title##3091",
"meta:descriptionId": "profile-person-details-v2##xdm:fullName##description##91921"
}
}
}
}
}
}
},
"person-birthDate": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:birthDate": {
"title": "Birth date",
"type": "string",
"format": "date",
"description": "The full date a person was born.",
"meta:titleId": "profile-person-details-v2##xdm:birthDate##title##59221",
"meta:descriptionId": "profile-person-details-v2##xdm:birthDate##description##81911"
}
}
}
}
},
"person-birthDayAndMonth": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:birthDayAndMonth": {
"title": "Birth date",
"type": "string",
"pattern": "[0-1][0-9]-[0-9][0-9]",
"description": "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year.",
"meta:titleId": "profile-person-details-v2##xdm:birthDayAndMonth##title##58691",
"meta:descriptionId": "profile-person-details-v2##xdm:birthDayAndMonth##description##49481"
}
}
}
}
},
"person-birthYear": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:birthYear": {
"title": "Birth year",
"type": "integer",
"description": "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.",
"minimum": 1,
"maximum": 32767,
"meta:titleId": "profile-person-details-v2##xdm:birthYear##title##30221",
"meta:descriptionId": "profile-person-details-v2##xdm:birthYear##description##86781"
}
}
}
}
},
"person-gender": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:gender": {
"title": "Gender",
"type": "string",
"enum": [
"male",
"female",
"not_specified",
"non_specific"
],
"meta:enum": {
"male": "Male",
"female": "Female",
"not_specified": "Not Specified",
"non_specific": "Non-specific"
},
"description": "Gender identity of the person.\n",
"default": "not_specified",
"meta:titleId": "profile-person-details-v2##xdm:gender##title##37361",
"meta:descriptionId": "profile-person-details-v2##xdm:gender##description##85251"
}
}
}
}
},
"person-maritalStatus": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:maritalStatus": {
"title": "Marital Status",
"type": "string",
"enum": [
"married",
"single",
"divorced",
"widowed",
"not_specified"
],
"meta:enum": {
"married": "Married",
"single": "Single",
"divorced": "Divorced",
"widowed": "Widowed",
"not_specified": "Not Specified"
},
"description": "Describes a person's relationship with a significant other.",
"default": "not_specified",
"meta:titleId": "profile-person-details-v2##xdm:maritalStatus##title##84911",
"meta:descriptionId": "profile-person-details-v2##xdm:maritalStatus##description##43681"
}
}
}
}
},
"person-nationality": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:nationality": {
"title": "Nationality",
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code.",
"meta:titleId": "profile-person-details-v2##xdm:nationality##title##42021",
"meta:descriptionId": "profile-person-details-v2##xdm:nationality##description##78421"
}
}
}
}
},
"person-taxId": {
"properties": {
"xdm:person": {
"type": "object",
"properties": {
"xdm:taxId": {
"title": "Tax ID",
"type": "string",
"description": "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain.",
"meta:titleId": "profile-person-details-v2##xdm:taxId##title##11071",
"meta:descriptionId": "profile-person-details-v2##xdm:taxId##description##47341"
}
}
}
}
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/person"
}
],
"meta:status": "deprecated",
"meta:createdDate": "2020-11-10",
"meta:titleId": "profile-person-details-v2##title##37611",
"meta:descriptionId": "profile-person-details-v2##description##57471",
"examples": [
{
"xdm:person": {
"xdm:name": {
"xdm:firstName": "Jane",
"xdm:middleName": "F",
"xdm:lastName": "Doe",
"xdm:fullName": "Jane F. Doe"
},
"xdm:birthDayAndMonth": "01-03",
"xdm:gender": "female"
}
}
]
}