Person type

An entity that contains the data of a person.

Properties
id
Type string
Description The unique identifier of this entity
Max Length 36
Required false
Pattern
^[A-Fa-f0-9]{32}$|({|\()?[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}(}|\))?$|^({)?[0xA-Fa-f0-9]{3,10}(, {0,1}[0xA-Fa-f0-9]{3,6}){2}, {0,1}({)([0xA-Fa-f0-9]{3,4}, {0,1}){7}[0xA-Fa-f0-9]{3,4}(}})$
Example
561f8309de7b4570bd170c5506ca920f
storageId
Type string
Description The indentifier of the Storage to which this entity belongs.
Min Length 32
Max Length 36
Required false
Pattern
^[A-Fa-f0-9]{32}$|({|\()?[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}(}|\))?$|^({)?[0xA-Fa-f0-9]{3,10}(, {0,1}[0xA-Fa-f0-9]{3,6}){2}, {0,1}({)([0xA-Fa-f0-9]{3,4}, {0,1}){7}[0xA-Fa-f0-9]{3,4}(}})$
Example
85E1F792B3464CB681035A0D1554D85A
url
Type string
Description The location of the entity.
Max Length 150
Required false
Example
https://sub.personalia.webapiservices.com/{version}/persons/4B209253197E471788BE54F80E90992A
key
Type string
Description An external custom identifier for the person.
Max Length 150
Required false
Example
A-453
title
Type string
Description The title of the person.
Max Length 50
Required false
Example
prof.
initials
Type string
Description The initials of the person.
Max Length 16
Required false
Example
J.F.
firstName
Type string
Description The first name of the person.
Max Length 30
Required false
Example
John
middleNames
Type string
Description The middle names of the person.
Max Length 75
Required false
Example
Francis
prefix
Type string
Description The prefix of the person his last name.
Max Length 20
Required false
Example
da
lastName
Type string
Description The last name of the person.
Max Length 50
Required false
Example
Costa
maidenName
Type string
Description The person’s last name before marriage.
Max Length 50
Required false
Example
Gilvary
gender
Type integer
Permitted Values [0, 1, 2]
Default 0
Description The gender of the person. 0 = Unknown, 1 = Male, 2 = Female.
Required false
Example
1
dateOfBirth
Type date-only
Description The person’s date of birth in the YYYY-MM-DD format of the ISO 8601 specification.
Required false
Example
1997-09-23
nationality
Type integer
Description The numeric country code of the ISO 3166-1 specification that represents the country of the person its nationality.
Minimum 4
Maximum 894
Required false
Example
840

 

Examples

Spliced example:

{
  "id": "561f8309de7b4570bd170c5506ca920f",
  "storageId": "85E1F792B3464CB681035A0D1554D85A",
  "url": "https://85E1F792B3464CB681035A0D1554D85A.personalia.webapiservices.com/alpha/persons/4B209253197E471788BE54F80E90992A",
  "key": "A-453",
  "title": "prof.",
  "initials": "J.F.",
  "firstName": "John",
  "middleNames": "Francis",
  "prefix": "da",
  "lastName": "Costa",
  "gender": 1,
  "dateOfBirth": "1997-09-23",
  "nationality": 840
}

Concatenated example:

{
  "id": "561f8309de7b4570bd170c5506ca920f",
  "storageId": "85E1F792B3464CB681035A0D1554D85A",
  "url": "https://85E1F792B3464CB681035A0D1554D85A.personalia.webapiservices.com/alpha/persons/4B209253197E471788BE54F80E90992A",
  "firstName": "John Francis",
  "lastName": "da Costa",
  "gender": 1,
  "dateOfBirth": "1997-09-23",
  "nationality": 840
}