Skip to content

Latest commit

 

History

History
169 lines (104 loc) · 3.82 KB

person.schema.md

File metadata and controls

169 lines (104 loc) · 3.82 KB

Person Schema

https://ns.adobe.com/xdm/context/person

An individual person. May represent a person acting in various roles, such as a customer, contact, or owner.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted context/person.schema.json

Schema Hierarchy

Person Examples

{
  "xdm:name": {
    "xdm:firstName": "Jane",
    "xdm:middleName": "F",
    "xdm:lastName": "Doe",
    "xdm:fullName": "Jane F. Doe"
  },
  "xdm:birthDate": "1996-01-03"
}
{
  "xdm:name": {
    "xdm:firstName": "Jane",
    "xdm:middleName": "F",
    "xdm:lastName": "Doe",
    "xdm:fullName": "Jane F. Doe"
  },
  "xdm:birthDayAndMonth": "01-03"
}

Person Properties

Property Type Required Default Defined by
xdm:birthDate string Optional Person (this schema)
xdm:birthDayAndMonth string Optional Person (this schema)
xdm:birthYear integer Optional Person (this schema)
xdm:gender enum Optional "not_specified" Person (this schema)
xdm:name Person Name Optional Person (this schema)
* any Additional this schema allows additional properties

xdm:birthDate

Birth Date

The full date a person was born.

xdm:birthDate

  • is optional
  • type: string
  • defined in this schema

xdm:birthDate Type

string

xdm:birthDayAndMonth

Birth Date

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.

xdm:birthDayAndMonth

  • is optional
  • type: string
  • defined in this schema

xdm:birthDayAndMonth Type

string

All instances must conform to this regular expression (test examples here):

[0-1][0-9]-[0-9][0-9]

xdm:birthYear

Birth Year

The year a person was born including the century (yyyy, e.g 1983). This field should be used when only the person's age is known, not the full birth date.

xdm:birthYear

  • is optional
  • type: integer
  • defined in this schema

xdm:birthYear Type

integer

  • minimum value: 1
  • maximum value: 32767

xdm:gender

Gender

Gender identity of the person.

xdm:gender

  • is optional
  • type: enum
  • default: "not_specified"
  • defined in this schema

The value of this property must be equal to one of the known values below.

xdm:gender Known Values

Value Description
male Male
female Female
not_specified Not Specified
non_specific Nonspecific

xdm:name

Full Name

The person's full name

xdm:name

  • is optional
  • type: Person Name
  • defined in this schema

xdm:name Type

  • Person Name – https://ns.adobe.com/xdm/context/person-name