Changes

stoney core: Resellers Resource - REST API

1,695 bytes added, 11:02, 29 January 2014
/* Reseller deletion (DELETE) */
== Reseller deletion (DELETE) ==
To delete an existing reseller, the client needs to send a HTTP <code>DELETE</code> request on the reseller's element resource URI (such as, <code>https://api.example.com/v1/resellers/4000001</code>). The service responds with a HTTP status code <code>200</code> (OK) on success and returns an empty body.
 
=== Reseller deletion request message ===
{| class="wikitable sortable" style="width: 100%;"
|-
! HTTP request part
! Content
! Example
 
|-
| Request lines
|<pre>
PATCH <Request-URI> HTTP 1.1
HOST: <Host>
</pre>
|<pre>
PATCH /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 deletion request message body ====
The JSON message body consists out of one or more fields from the [[#reseller_object|Reseller object]].
 
=== Reseller deletion 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_partly_update_response_message_body|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
 
|}
 
==== Reseller deletion response message body ====
On success (<code>200</code>) an empty response message body will be returned, otherwise an [[stoney_core:_REST_API#Error_codes_and_responses|error object]] will provide further informations about the failure.
= Links =
[[Category:REST API]]
SLB
385
edits