Changes

stoney core: REST API

1,267 bytes added, 16:14, 13 November 2013
/* Reseller resource */
==== Reseller retrieval (GET) ====
 
'''Collection''':
 
<pre>
GET /v1/resellers/ HTTP 1.1
HOST: api.example.com
</pre>
<pre>
Accept: application/json
Content-Type: application/json
</pre>
<source lang='javascript'>
[
{
"id": 4000001,
"location": "https://api.example.com/v1/resellers/4000001",
"belongsToReseller": "https://api.example.com/v1/resellers/4000000",
"isCompany": true,
"descriptiveName": "Company Name or Givenname Surname"
},
 
]
</source>
 
'''Element''':
 
<pre>
GET /v1/resellers/4000001 HTTP 1.1
HOST: api.example.com
</pre>
<pre>
Accept: application/json
Content-Type: application/json
</pre>
<source lang='javascript'>
{
"id": 4000001,
"belongsToReseller": "https://api.example.com/v1/resellers/4000000,
"isCompany": true,
"billingAddress":
{
"organizationName": "Reseller Ltd.",
"gender": 'm',
"givenName": "Name",
"surname": "Surname",
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "Postal Code",
"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/"
}
"shippingAddresses":
[
TBD,
]
}
</source>
 
==== Reseller update (PUT) ====
==== Reseller deletion (DELETE) ====
[[Category:Development]]
Bureaucrat, administrator
425
edits