Changes

Jump to: navigation, search

stoney core: People Resource - REST API

1,495 bytes added, 09:40, 8 June 2014
/* People collection retrieval response message body */
|<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>mail</code>
|string
|yes
|Email address
|
|@TODO: Add regex
|
|<source lang="javascript">"mail": "user@example.com"</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>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>
|}
SLB
385
edits