Changes

stoney core: Resellers Resource - REST API

2,087 bytes added, 10:41, 29 January 2014
/* Reseller partly update (PATCH) */
In contrast to the [[#Reseller_update_.28PUT.29|<code>PUT</code>]] method, only the changed fields are to be included in the request.
 
=== Reseller partly update request message ===
{| class="wikitable sortable" style="width: 100%;"
|-
! HTTP request part
! Content
! Example
 
|-
| Request lines
|<pre>
PUT <Request-URI> HTTP 1.1
HOST: <Host>
</pre>
|<pre>
POST /v1/resellers/4000001 HTTP 1.1
HOST: api.example.com
</pre>
 
|-
| Request headers
| <pre>
Accept: <Type>/<Subtype>
Accept-Charset: <Charset>
Content-Type: <Type>/<Subtype>; charset=<Charset>
</pre>
| <pre>
Accept: application/json
Accept-Charset: UTF-8
Content-Type: application/json; charset=UTF-8
</pre>
 
|-
| [[#Reseller_update_request_message_body|Request body]]
| JSON object
| <source lang="javascript">{ ... }</source>
 
|}
 
==== Reseller partly update request message body ====
See [[#reseller_object|Reseller object]].
 
=== Reseller update response message ===
{| class="wikitable sortable" style="width: 100%;"
|-
! HTTP response part
! Content
! Example
 
|-
| Status Line
| <pre>HTTP/1.1 <HTTP-Status-Code> <HTTP-Status-Message></pre>
| <pre>HTTP/1.1 200 OK</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_update_response_message_body|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
 
|}
 
==== Reseller partly update response message body ====
{| class="wikitable sortable" style="width: 100%;" id="reseller_update_response_object"
|-
|+ align="top" style="text-align:left;"|Reseller Update Response Object
! Parameter name
! Data type
! Mandatory
! Description
! Valid content
![http://www.pcre.org/ PCRE]
! Default value
! Example
 
|-
|[[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 deletion (DELETE) ==
SLB
385
edits