Difference between revisions of "stoney core: Resellers Resource - REST API"
From stoney cloud
| [unchecked revision] | [unchecked revision] |
(→Reseller creation request message) |
(→Reseller creation (POST)) |
||
| Line 2: | Line 2: | ||
= Reseller resource methods = | = Reseller resource methods = | ||
== Reseller creation (POST) == | == Reseller creation (POST) == | ||
| + | To create a new reseller 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. | ||
| + | |||
=== Reseller creation request message === | === Reseller creation request message === | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Revision as of 12:23, 11 December 2013
Contents
Overview
Reseller resource methods
Reseller creation (POST)
To create a new reseller the client needs to send a HTTP POST request on the reseller collection resource URI https://api.example.com/v1/resellers, including the associated reseller informations.
The service will generate a new reseller and responds with a HTTP status code 201 (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.
Reseller creation request message
| HTTP request part | Content | Example | |
|---|---|---|---|
| Request lines | POST <Request-URI> HTTP 1.1
|
POST /v1/resellers/ HTTP 1.1
|
|
| Request headers | Accept: application/json
|
||
| Request body | JSON object |
