|
|<source lang="javascript">"id": 5000001</source>
|-
|<code>isCompany</code>
|boolean
|yes
|<code>true</code> if the person represents a company, <code>false</code> if it's an individual person.
|<code>true</code> or <code>false</code>
|
|
|<source lang="javascript">"isCompany": true</source>
|-
|<code>true</code>
|<source lang="javascript">"isActive": true</source>
|-
|<code>personName</code>
|string
|yes
|The person's display name. Mostly the same as the <code>organizationName</code> or the <code>givenName</code> and <code>surname</code> out of the [[#billingAddress_object|billingAddress object]], but can also be the name of a brand.
|
|
|
|<source lang="javascript">"personName": "Super-duper Hosting"</source>
|-
|<code>countryCode</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"countryCode": ""</source>
|-
|<code>postalCode</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"postalCode": ""</source>
|-
|<code>localityName</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"localityName": ""</source>
|-
|[[#billingAddress_object|<code>billingAddress</code>]]
|object
|yes
|An object holding the billing address informations for the given person. Refer to the [[#billingAddress_object|billingAddress object table]] for more informations.
|
|
|
|<source lang="javascript">
"billingAddress":
{
"organizationName": "Person Ltd.",
"gender": 'm',
"givenName": "Name",
"surname": "Surname",
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "1234",
"localityName": "Locality",
"preferredLanguage": "en-GB",
"mail": "name.surname@example.com",
"telephoneNumber": "+41 00 000 00 00",
"mobileTelephoneNumber": "+41 00 000 00 00",
"websiteURL": "https://www.example.com/"
}
</source>
|-
|[[#shippingAddress_object|<code>shippingAddress</code>]]
|object
|no
|An object holding the shipping address informations for the given person. Refer to the [[#shippingAddress_object|shippingAddress object table]] for more informations.
|
|
|
|<source lang="javascript">
"shippingAddress":
{
"organizationName": "Person Ltd.",
"gender": 'm',
"givenName": "Name",
"surname": "Surname",
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "1234",
"localityName": "Locality",
"preferredLanguage": "en-GB",
"mail": "name.surname@example.com",
"telephoneNumber": "+41 00 000 00 00",
"mobileTelephoneNumber": "+41 00 000 00 00",
"websiteURL": "https://www.example.com/"
}
</source>
|-
|<code>people</code>
|string
|yes
|The location URI of the people belonging to this person resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"people": "https://api.example.com/v1/people/5000001/people"</source>
|-
|<code>employees</code>
|string
|yes
|The location URI of the employees belonging to this person resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"employees": "https://api.example.com/v1/people/5000001/employees"</source>
|-
|<code>users</code>
|string
|yes
|The location URI of the users belonging to this person resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"users": "https://api.example.com/v1/people/5000001/users"</source>
|-
