Difference between revisions of "stoney core: Resellers Resource - REST API"

From stoney cloud
Jump to: navigation, search
[unchecked revision][unchecked revision]
(Reseller creation (POST))
(Reseller creation request message)
Line 25: Line 25:
 
|-
 
|-
 
| Request headers
 
| Request headers
| <code>Accept: application/json
+
| <code>Accept: <Type>/<Subtype>
 +
Content-Type: <Type>/<Subtype>
 +
</code>
 +
| | <code>Accept: application/json
 
Content-Type: application/json
 
Content-Type: application/json
 
</code>
 
</code>
|
 
  
 
|-
 
|-
 
| Request body
 
| Request body
 
| JSON object
 
| JSON object
|  
+
| <code>{ ... }</code>
  
 
|}
 
|}

Revision as of 12:39, 11 December 2013

Overview

The reseller resource represents the bla, bla, bla...

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 (also see Base URI), 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

HOST: <Host>

POST /v1/resellers/ HTTP 1.1

HOST: api.example.com

Request headers Accept: <Type>/<Subtype>

Content-Type: <Type>/<Subtype>

Accept: application/json

Content-Type: application/json

Request body JSON object { ... }

Reseller creation response message

Reseller retrieval (GET)

Reseller update (PUT)

Reseller partly update (PATCH)

Reseller deletion (DELETE)

Links