Changes

Jump to: navigation, search

stoney core: People Resource - REST API

1,352 bytes removed, 09:36, 8 June 2014
/* People collection retrieval response message body */
|
|<source lang="javascript">"location": "https://api.example.com/v1/people/5000000"</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": "Person Ltd"</source>
 
|-
|<code>countryCode</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"countryCode": "CH"</source>
 
|-
|<code>postalCode</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"postalCode": "3012"</source>
 
|-
|<code>localityName</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"localityName": "Bern</source>
 
|-
|<code>belongsToResellerID</code>
|integer
|yes
|The reseller identification number the person resource must belong to.
|
|@TODO add regex
|
|<source lang="javascript">"id": 4000000</source>
 
|-
|<code>belongsToCustomerID</code>
|integer
|yes
|The customer identification number the person resource must belong to.
|
|@TODO add regex
|
|<source lang="javascript">"id": 4000000</source>
|}
SLB
385
edits