Changes
/* Person element retrieval response message body */
|
|<source lang="javascript">"id": 5000001</source>
|-
|<code>gender</code>
|string
|yes
|The gender of the address holder
|Either <code>f</code> for female, <code>m</code> for male or <code>n</code> for neutral.
|
|
|<source lang="javascript">"gender": "f"</source>
|-
|<code>title</code>
|string
|no
|The title of a person.
|UTF-8 {64}
|@TODO add regex
|
|<source lang="javascript">"title": "CEO"</source>
|-
|<code>true</code>
|<source lang="javascript">"isActive": true</source>
|-
|<code>givenName</code>
|string
|yes
|The given name (first name or forename) of the address holder.
|UTF-8 {64}
|@TODO: Add regex
|
|<source lang="javascript">"givenName": "Name"</source>
|-
|<code>surname</code>
|string
|yes
|The surname (last name or family name) of the address holder.
|UTF-8 {64}
|@TODO: Add regex
|
|<source lang="javascript">"surname": "Surname"</source>
|-
|<code>preferredLanguage</code>
|string
|yes
|Language tag
|<nowiki>[</nowiki>[http://www.loc.gov/standards/iso639-2/php/code_list.php ISO 639-1 Code]<nowiki>]</nowiki>-<nowiki>[</nowiki>[http://www.iso.org/iso/english_country_names_and_code_elements ISO 3166-1-alpha-2 code]<nowiki>]</nowiki>
|
|
|<source lang="javascript">"preferredLanguage": "de-CH"</source>
|-
|<code>password</code>
|string
|yes
|Password
|min 8 chars, max 255 chars
|
|
|<source lang="javascript">"password": "dontstealme!"</source>
|-
|<code>mail</code>
|string
|yes
|Email address
|
|@TODO: Add regex
|
|<source lang="javascript">"mail": "user@example.com"</source>
|-
|<code>telephoneNumber</code>
|string
|yes
|Telephone number
|Phone number according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, trunk code, area code, subscriber line)
|
|
|<source lang="javascript">"telephoneNumber": "+41 11 222 33 44"</source>
|-
|<code>mobileTelephoneNumber</code>
|string
|yes
|Mobile telephone
|Phone number according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, trunk code, area code, subscriber line).
|
|
|<source lang="javascript">"mobileTelephoneNumber": "+41 11 222 33 44"</source>
|-
|<code>timeZoneOffset</code>
|string
|yes
|Time zone as an [http://en.wikipedia.org/wiki/UTC_offset offset from UTC].
|Offset from UTC in the form <code>UTC±[hh]:[mm]</code>
|
|
|<source lang="javascript">"timeZoneOffset": "UTC+01:00"</source>
|-
|<code>belongsToResellerId</code>
|integer
|yes
|The [[stoney_core:_Resellers_Resource_-_REST_API|reseller's]] identification number the customer resource must belong to.
|
|@TODO add regex
|
|<source lang="javascript">"belongsToResellerId": 4000000</source>
|-
|<code>belongsToCustomerId</code>
|integer
|yes
|the [[stoney_core:_Customers_Resource_-_REST_API|customer]] UID the person belongs to
|
|@TODO add regex
|
|<source lang="javascript">"belongsToCustomerId": 4000002</source>
|-
|<code>employeeOfId</code>
|array
|no
|The ID(s) the person is an employee of. The UID(s) can belong to one or more [[stoney_core:_Resellers_Resource_-_REST_API|resellers]] or also to one or more [[stoney_core:_Customers_Resource_-_REST_API|customers]]
|one ore more UID as integer
|
|
|<source lang="javascript">
"employeeOfId": [
4000002,
4001003,
4002004
]
</source>
|-
|<code>externalId</code>
|integer
|no
|The ID of a reference in an external database.
|Min 0, max 1e+32
|
|
|<source lang="javascript">"externalId": 987654321</source>
|-
