Changes

stoney core: REST API

756 bytes added, 10:52, 14 November 2013
/* REST API documentation */
== REST API documentation ==
=== Reseller resource ===
 
Ressource representing a reseller.
==== Reseller creation (POST) ====
 Create To create a new reseller. Base the client needs to send a HTTP <code>POST</code> request on the reseller collection resource URI: <code>https://api.example.com/v1/resellers</code>, including the associated reseller informations.The service will generate a new reseller and responds with a HTTP status code <code>201</code> (Created) on success. The newly created reseller URI is returned within the HTTP location header, which can be used by the client to gather informations about the new reseller.
TBD: Table of all attributes (including optional ones)
===== Reseller collection retrieval (GET) example =====
 
'''Request''':
<pre>
===== Reseller element retrieval (GET) example =====
To retrieve an existing reseller and fetch the informations associated with it, the client needs to send a HTTP <code>GET</code> request on the reseller's element resource URI (such as <code>/v1/resellers/4000001</code>.
The service responds with a HTTP status code 200 (OK) on success and returns the associated reseller informations.
'''Request''':
SLB
385
edits