Changes

stoney core: Search Resource - REST API

99 bytes removed, 14:00, 14 May 2014
== Global Search Response Object (Resellers) ==
{| class="wikitable sortable" style="width: 100%;" id="reseller_collection_array_element_object"
|-
|+ align="top" style="text-align:left;"|Reseller Collection Array Element Object
!Parameter name
!Data type
!Mandatory
!Description
!Valid content
![http://www.pcre.org/ PCRE]
!Default value
!Example
|-|<codesource lang='javascript'>{ "resellers": { "resources": [ { "id<": 4000000, "location": "https:/code>/api.example.com/v1/resellers/4000000",|integer "isCompany": true,|yes "isActive": true,|The identification number of the reseller. "resellerName": "Example Reseller Ltd"| },|@TODO add regex { "id": 4000001,| "location": "https://api.example.com/v1/resellers/4000001",|<source lang= "javascriptisCompany">: true, "idisActive": 4000000true, "resellerName": "Example Reseller No 2 Ltd" } ], "location": "https://api.example.com/v1/resellers/?q=example" },</source>
|-== Global Search Response Object (Customers) ==|<code>location</codesource lang='javascript'>|string "customers":|yes {|The location URI of the reseller resource. "resources":|@TODO add link to URI RFC [|||<source lang= { "javascriptid">: 5000000, "location": "https://api.example.com/v1/resellerscustomers/40000005000000"</source>, |-|<code> "isCompany</code>|boolean|yes|<code>": true</code> if the reseller represents a company, <code>false</code> if it's an individual person.|<code> "isActive": true</code> or <code>false</code>,|||<source lang= "javascriptcustomerName">: "isCompanyExample Customer Ltd": true</source> },|- { "id": 5000001, ... }|<code>isActive</code> ],|boolean|yes||<code>true</code> or <code>false</code>||<code>true</code>|<source lang= "javascriptlocation">"isActive: "https: true</source> |-|<code>resellerName</code>|string|yes|The reseller's display nameapi. Mostly the same as the <code>organizationName<example.com/code> or the <code>givenName<v1/code> and <code>surname<customers/code> out of the [[#billingAddress_object|billingAddress object]]?q=example" }, but can also be the name of a brand.||||<source lang="javascript">"resellerName": "Super-duper Hosting"</source> |} == Resellers Search (GET) == == Customers Search (GET) == == People Search (GET) ==
== Global Search Response Object (People) ==
<source lang='javascript'>
"people":
{
"resources":
[
{ "id": 5000000,
"location": "https://api.example.com/v1/customers/5000000",
TBD
TBD
TBD
},
{ "id": 6000001, ... }
],
"location": "https://api.example.com/v1/people/?q=example"
},
</source>
[[Category: REST API]][[Category:stoney core]]
SLB, editor, reviewer
3,368
edits