Person Name object representation

The personname object representation and fields are described below.

personname was introduced in API version V1

personname has not been marked for deprecation

Usages

Person Name

Description

Name associated with a person (may be an alias)

Example create representation

{
  "person" : {
    "urn" : "249456c5-c884-4ef6-96b0-30e96a73897a",
    "url" : "/n/v1/person/249456c5-c884-4ef6-96b0-30e96a73897a"
  },
  "givenName" : "Daniel",
  "familyName" : "Prince",
  "honorificPrefix" : "Mr"
}

Example response representation

{
  "urn" : "92c75454-424b-4c2a-b5c5-ca7d64fa9940",
  "url" : "/n/v1/personname/92c75454-424b-4c2a-b5c5-ca7d64fa9940",
  "person" : {
    "urn" : "249456c5-c884-4ef6-96b0-30e96a73897a",
    "url" : "/n/v1/person/249456c5-c884-4ef6-96b0-30e96a73897a"
  },
  "givenName" : "Daniel",
  "familyName" : "Prince",
  "honorificPrefix" : "Mr"
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN for the person name
url	URL represented as a string	URL for addressing the person name
person	person	The person this name is associated with	Required on create.
givenName	String literal	The given, or firstname for the person name	Required on create.
familyName	String literal	The family, or surname for the person name
honorificPrefix	String literal	Honorific prefix for the person name	Optional.