Changes

stoney core: Resellers Resource - REST API

1,747 bytes added, 10:28, 29 January 2014
/* Reseller update request message body */
==== Reseller update request message body ====
See [[#reseller_object|Reseller object]].
 
=== Reseller update response message ===
{| class="wikitable sortable" style="width: 100%;"
|-
! Status Line
! Content
! Example
 
|-
| Request lines
| <pre>HTTP/1.1 <HTTP-Status-Code> <HTTP-Status-Message></pre>
| <pre>HTTP/1.1 201 Created</pre>
 
|-
| Response headers
|<pre>
Content-Type: <Type>/<Subtype>; charset=<Charset>
Location: <Location-URI>
</pre>
|<pre>
Content-Type: Content-Type: application/json; charset=UTF-8
Location: https://api.example.com/v1/resellers/4000001
</pre>
 
|-
| [[#Reseller_creation_response_message_body|Response body]]
| JSON object
| <pre>{ ... }</pre>
 
|}
 
==== Reseller update response message body ====
{| class="wikitable sortable" style="width: 100%;" id="reseller_creation_response_object"
|-
|+ align="top" style="text-align:left;"|Reseller Creation Response Object
! Parameter name
! Data type
! Mandatory
! Description
! Valid content
![http://www.pcre.org/ PCRE]
! Default value
! Example
 
|-
|<code>id</code>
|integer
|yes
|The identification number of the newly created reseller resource.
|
|@TODO add regex
|
|<source lang="javascript">"id": 4000001</source>
 
|-
|<code>location</code>
|string
|yes
|The location URI of the newly created reseller resource, corresponds with the HTTP location header.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"location": "https://api.example.com/v1/resellers/4000001"</source>
 
|-
|[[stoney_core:_REST_API#Error_codes_and_responses|<code>error</code>]]
|object
|no
|In case of a failure, an error object with the appropriate error messages will be returned. Refer to the [[stoney_core:_REST_API#Error_codes_and_responses|Error codes and response chapter]] for more informations.
|
|
|
|<source lang="javascript">"error": { /* ... */ }</source>
 
|}
== Reseller partly update (PATCH) ==
SLB
385
edits