Also visit [[stoney core: Resellers Resource Mapping (REST - LDAP)]].
= Overview =
The REST API describes the ('''Re'''presentational '''S'''tate '''T'''ransfer '''A'''pplication '''P'''rogramming '''I'''nterface) of the resellers resource represents the blato be used by [[:Category:stoney core|stoney core]], bla[[:Category:stoney conductor|stoney conductor]] and other [[:Category:Self-Service Modules|Self-Service Modules]] or third party applications. Basically, blawe want to be able to do the following things:* Create a new reseller ([[#Reseller_creation_.28POST.29|POST]]).* Retrieve multiple resellers in the form of a list ([[#Reseller_collection_retrieval_.28GET.29|GET]]).* Retrieve a single reseller ([[#Reseller_element_retrieval_.28GET.29|GET]]).* Update an existing reseller ([[#Reseller_update_.28PUT.29|PUT]]).* Update one or more values of an existing reseller ([[#Reseller_partly_update_.28PATCH.29|PATCH]]).* Delete a single reseller ([[#Reseller_deletion_.28DELETE.29|DELETE]]). To get an idea what happens behind the screens, have a look at the [[stoney core: Resellers Resource Mapping (REST - LDAP)]] documentation located in the [[:Category:Mapping (REST - LDAP)|Mapping (REST - LDAP)]] category.
= Reseller Resellers resource methods =
== 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> (also see [[Application_Programming_Interface_(API)#Base_URI|Base URI]]), including the associated reseller informationsinformation.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 information about the new reseller.
=== Reseller creation request message ===
| <pre>
Accept: <Type>/<Subtype>
Accept-Charset: <Charset>Content-Type: <Type>/<Subtype>; charset=<Charset>
</pre>
| <pre>
Accept: application/json
Accept-Charset: UTF-8Content-Type: application/json; charset=UTF-8
</pre>
| [[#Reseller_creation_request_message_body|Request body]]
| JSON object
| <presource lang="javascript">{ ... }</presource>
|}
! Mandatory
! Description
! Allowed Valid content![http://www.pcre.org/ PCRE]
! Default value
! Example
|<code>true</code> or <code>false</code>
|
||<presource lang="javascript">"isCompany": true</presource> |-|<code>isActive</code>|boolean|yes||<code>true</code> or <code>false</code>||<code>true</code>|<source lang="javascript">"isActive": true</source> |-|<code>resellerName</code>|string|yes|The reseller's display name. Mostly the same as the <code>organizationName</code> or the <code>givenName</code> and <code>surname</code> out of the [[#billingAddress_object|billingAddress object]].|UTF-8 {64}|||<source lang="javascript">"resellerName": "Reseller Ltd."</source>
|-
|object
|yes
|An object holding the billing address informations information for the given reseller. Refere Refer to the [[#billingAddress_object|billingAddress object table]] for more informationsinformation.
|
|
||<presource lang="javascript">
"billingAddress":
{
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "Postal Code1234",
"localityName": "Locality",
"preferredLanguage": "en-GB",
"websiteURL": "https://www.example.com/"
}
</presource> |-|[[#shippingAddress_object|<code>shippingAddress</code>]]|object|no|An object holding the shipping address information for the given reseller. Refer to the [[#shippingAddress_object|shippingAddress object table]] for more information.||||<source lang="javascript">"shippingAddress":{ "organizationName": "Reseller Ltd.", "gender": 'm', "givenName": "Name", "surname": "Surname", "postalAddress": "Street Number", "countryCode": "CH", "postalCode": "1234", "localityName": "Locality", "preferredLanguage": "en-GB", "mail": "name.surname@example.com", "telephoneNumber": "+41 00 000 00 00", "mobileTelephoneNumber": "+41 00 000 00 00", "websiteURL": "https://www.example.com/"}</source>
|}
!Mandatory
!Description
!Allowed Valid content![http://www.pcre.org/ PCRE]
!Default value
!Example
|no
|The name of the organization.
|
|@TODO: Add regex
|
|<presource lang="javascript">"organizationName": "Reseller Ltd."</presource>
|-
|Either <code>f</code> for female, <code>m</code> for male or <code>n</code> for neutral.
|
||<presource lang="javascript">"gender": "f"</presource>
|-
|yes
|The given name (first name or forename) of the address holder.
|UTF-8 {64}
|@TODO: Add regex
|
|<presource lang="javascript">"givenName": "Name"</presource>
|-
|yes
|The surname (last name or family name) of the address holder.
|UTF-8 {64}
|@TODO: Add regex
|
|<presource lang="javascript">"surname": "Surname"</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"postalAddress": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"countryCode": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"postalCode": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"localityName": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"preferredLanguage": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"mail": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"telephoneNumber": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"mobileTelephoneNumber": ""</presource>
|-
|string
|yes
|
|
|@TODO: Add regex
|
|<presource lang="javascript">"websiteURL": ""</source> |} {| class="wikitable sortable" style="width: 100%;" id="shippingAddress_object"|-|+ align="top" style="text-align:left;"|shippingAddress Object!Parameter name!Data type!Mandatory!Description!Valid content![http://www.pcre.org/ PCRE]!Default value!Example |-|<code>organizationName</code>|string|no|The name of the organization.||@TODO: Add regex||<source lang="javascript">"organizationName": "Reseller Ltd."</source> |-|<code>gender</code>|string|yes|The gender of the address holder|Either <code>f</code> for female, <code>m</code> for male or <code>n</code> for neutral.|||<source lang="javascript">"gender": "f"</source> |-|<code>givenName</code>|string|yes|The given name (first name or forename) of the address holder.||@TODO: Add regex||<source lang="javascript">"givenName": "Name"</source> |-|<code>surname</code>|string|yes|The surname (last name or family name) of the address holder.||@TODO: Add regex||<source lang="javascript">"surname": "Surname"</source> |-|<code>postalAddress</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"postalAddress": ""</source> |-|<code>countryCode</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"countryCode": ""</source> |-|<code>postalCode</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"postalCode": ""</source> |-|<code>localityName</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"localityName": ""</source> |-|<code>preferredLanguage</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"preferredLanguage": ""</source> |-|<code>mail</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"mail": ""</source> |-|<code>telephoneNumber</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"telephoneNumber": ""</source> |-|<code>mobileTelephoneNumber</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"mobileTelephoneNumber": ""</source> |-|<code>websiteURL</code>|string|yes|||@TODO: Add regex||<source lang="javascript">"websiteURL": ""</presource>
|}
{| class="wikitable sortable" style="width: 100%;"
|-
! Status LineHTTP response part
! Content
! Example
|-
| Request linesStatus Line
| <pre>HTTP/1.1 <HTTP-Status-Code> <HTTP-Status-Message></pre>
| <pre>HTTP/1.1 201 Created</pre>
</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
| <presource lang="javascript">{ ... }</presource>
|}
! Mandatory
! Description
! Allowed Valid content![http://www.pcre.org/ PCRE]
! Default value
! Example
|yes
|The identification number of the newly created reseller resource.
|
|@TODO add regex
|
|<presource lang="javascript">"id": 4000001</presource>
|-
|yes
|The location URI of the newly created reseller resource, corresponds with the HTTP location header.
|@TODO add link to URI RFC |
|
|<presource lang="javascript">"location": "https://api.example.com/v1/resellers/4000001"</presource>
|-
|[[Application_Programming_Interface_(API)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 [[Application_Programming_Interface_(API)stoney_core:_REST_API#Error_codes_and_responseError_codes_and_responses|Error codes and response chapter]] for more informationsinformation.
|
|
||<presource lang="javascript">"error ": { /* ... */ }</presource>
|}
== Reseller retrieval (GET) ==
=== Reseller collection retrieval (GET) ===
To retrieve existing resellers, the client needs to send a HTTP <code>GET</code> request on the reseller's collection resource URI <code>https://api.example.com/v1/resellers</code>.
The service responds with a HTTP status code 200 (OK) on success and returns the various resellers.
Note that the service will only return a limited amount of objects at once and provides links for retrieving further objects. Refer to the [[stoney_core:_REST_API#Pagination|Pagination chapter]] for more information.
==== Sort ====
If you don't add a sort attribute, the collection will be sorted by '''id''' (ascending). If you would like a sorted collection answer, the query parameter sort must be added with the object's sort attribute(s) as the value: <code>https://api.example.com/v1/resellers?sort=resellerName,isActive</code>. For further information on filtering, sorting and searching, visit [[stoney_core:_REST_API#Filtering.2C_sorting_and_searching | stoney core: REST API]].
==== Search (fulltext) ====
To form a fulltext search (resellers only), append the url query parameter '''q''' with the desired search text: <code>https://api.example.com/v1/resellers?q=example</code>. The document [[stoney_core:_Search_Resource_-_REST_API#Resellers_Search_.28GET.29 | stoney core: Search Resource - REST API]] describes the search in detail.
==== Search (with filter) ====
To form a specific search, append the url query attribute(s) name (for example '''resellerName''') with the desired search text: <code>https://api.example.com/v1/resellers?resellerName=example</code>. You're allowed to search for all attributes that are returned in the [[#Reseller_element_retrieval_response_message_body | Reseller element retrieval response message body]].
==== Reseller collection retrieval request message ====
{| class="wikitable sortable" style="width: 100%;"
|-
! HTTP request part
! Content
! Example
|-
| Request lines
|<pre>
GET <Request-URI> HTTP 1.1
HOST: <Host>
</pre>
|<pre>
GET /v1/resellers/ HTTP 1.1
HOST: api.example.com
</pre>
|-
| Request headers
| <pre>
Accept: <Type>/<Subtype>
Accept-Charset: <Charset>
</pre>
| <pre>
Accept: application/json
Accept-Charset: UTF-8
</pre>
|-
| Request body
| <Empty>
| <pre></pre>
|}
==== Reseller collection retrieval 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>
Link:
X-Total-Count:
</pre>
|<pre>
Content-Type: Content-Type: application/json; charset=UTF-8
Link: <https://api.example.com/v1/resellers?page=1&per_page=30>; rel="first",
<https://api.example.com/v1/resellers?page=2&per_page=30>; rel="prev",
<https://api.example.com/v1/resellers?page=4&per_page=30>; rel="next",
<https://api.example.com/v1/resellers?page=10&per_page=30>; rel="last"
X-Total-Count: 295
</pre>
|-
| [[#reseller_collection_retrieval_response_object|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
|}
====== Reseller collection retrieval response message body ======
{| class="wikitable sortable" style="width: 100%;" id="reseller_collection_retrieval_response_object"
|-
|+ align="top" style="text-align:left;"|Reseller Collection Retrieval Response Object
! Parameter name
! Data type
! Mandatory
! Description
! Valid content
! [http://www.pcre.org/ PCRE]
! Default value
! Example
|-
|
|array
|no
|An array with one or more [[#reseller_collection_array_element_object|reseller collection objects]]
|
|
|
|<source lang="javascript">
[
{
"id": 4000000,
"location": "https://api.example.com/v1/resellers/4000000",
"isCompany": true,
"isActive": true,
"resellerName": "Reseller Ltd."
"countryCode": "CH",
"postalCode": "3012",
"localityName": "Bern"
},
{
/* ... */
}
]
</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 information.
|
|
|
|<source lang="javascript">error { /* ... */ }</source>
|}
{| class="wikitable sortable" style="width: 100%;" id="reseller_collection_array_element_object"
|-
|+ align="top" style="text-align:left;"|Reseller Collection Array Element 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 reseller.
|
|@TODO add regex
|
|<source lang="javascript">"id": 4000000</source>
|-
|<code>location</code>
|string
|yes
|The location URI of the reseller resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"location": "https://api.example.com/v1/resellers/4000000"</source>
|-
|<code>isCompany</code>
|boolean
|yes
|<code>true</code> if the reseller represents a company, <code>false</code> if it's an individual person.
|<code>true</code> or <code>false</code>
|
|
|<source lang="javascript">"isCompany": true</source>
|-
|<code>isActive</code>
|boolean
|yes
|
|<code>true</code> or <code>false</code>
|
|<code>true</code>
|<source lang="javascript">"isActive": true</source>
|-
|<code>resellerName</code>
|string
|yes
|The reseller's display name. Mostly the same as the <code>organizationName</code> or the <code>givenName</code> and <code>surname</code> out of the [[#billingAddress_object|billingAddress object]].
|
|
|
|<source lang="javascript">"resellerName": "Reseller Ltd."</source>
|-
|<code>countryCode</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"countryCode": "CH"</source>
|-
|<code>postalCode</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"postalCode": "3012"</source>
|-
|<code>localityName</code>
|string
|yes
|
|
|@TODO: Add regex
|
|<source lang="javascript">"localityName": "Bern</source>
|}
=== Reseller element retrieval (GET) ===
To retrieve an existing reseller and fetch the information associated with it, the client needs to send a HTTP <code>GET</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 200 (OK) on success and returns the associated reseller information.
==== Reseller element retrieval request message ====
{| class="wikitable sortable" style="width: 100%;"
|-
! HTTP request part
! Content
! Example
|-
| Request lines
|<pre>
GET <Request-URI> HTTP 1.1
HOST: <Host>
</pre>
|<pre>
GET /v1/resellers/4000001 HTTP 1.1
HOST: api.example.com
</pre>
|-
| Request headers
| <pre>
Accept: <Type>/<Subtype>
Accept-Charset: <Charset>
</pre>
| <pre>
Accept: application/json
Accept-Charset: UTF-8
</pre>
|-
| Request body
| <Empty>
| <pre></pre>
|}
==== Reseller element retrieval 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_element_retrieval_response_message_body|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
|}
====== Reseller element retrieval response message body ======
{| class="wikitable sortable" style="width: 100%;" id="reseller_element_retrival_response_object"
|-
|+ align="top" style="text-align:left;"|Reseller Element Retrieval 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 reseller.
|
|@TODO add regex
|
|<source lang="javascript">"id": 4000001</source>
|-
|<code>isCompany</code>
|boolean
|yes
|<code>true</code> if the reseller represents a company, <code>false</code> if it's an individual person.
|<code>true</code> or <code>false</code>
|
|
|<source lang="javascript">"isCompany": true</source>
|-
|<code>isActive</code>
|boolean
|yes
|
|<code>true</code> or <code>false</code>
|
|<code>true</code>
|<source lang="javascript">"isActive": true</source>
|-
|<code>resellerName</code>
|string
|yes
|The reseller's display name. Mostly the same as the <code>organizationName</code> or the <code>givenName</code> and <code>surname</code> out of the [[#billingAddress_object|billingAddress object]].
|
|
|
|<source lang="javascript">"resellerName": "Reseller Ltd."</source>
|-
|[[#billingAddress_object|<code>billingAddress</code>]]
|object
|yes
|An object holding the billing address information for the given reseller. Refer to the [[#billingAddress_object|billingAddress object table]] for more information.
|
|
|
|<source lang="javascript">
"billingAddress":
{
"organizationName": "Reseller Ltd.",
"gender": 'm',
"givenName": "Name",
"surname": "Surname",
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "1234",
"localityName": "Locality",
"preferredLanguage": "en-GB",
"mail": "name.surname@example.com",
"telephoneNumber": "+41 00 000 00 00",
"mobileTelephoneNumber": "+41 00 000 00 00",
"websiteURL": "https://www.example.com/"
}
</source>
|-
|[[#shippingAddress_object|<code>shippingAddress</code>]]
|object
|no
|An object holding the shipping address information for the given reseller. Refer to the [[#shippingAddress_object|shippingAddress object table]] for more information.
|
|
|
|<source lang="javascript">
"shippingAddress":
{
"organizationName": "Reseller Ltd.",
"gender": 'm',
"givenName": "Name",
"surname": "Surname",
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "1234",
"localityName": "Locality",
"preferredLanguage": "en-GB",
"mail": "name.surname@example.com",
"telephoneNumber": "+41 00 000 00 00",
"mobileTelephoneNumber": "+41 00 000 00 00",
"websiteURL": "https://www.example.com/"
}
</source>
|-
|<code>customers</code>
|string
|yes
|The location URI of the customers belonging to this reseller resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"customers": "https://api.example.com/v1/resellers/4000001/customers"</source>
|-
|<code>employees</code>
|string
|yes
|The location URI of the employees belonging to this reseller resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"employees": "https://api.example.com/v1/resellers/4000001/employees"</source>
|-
|<code>users</code>
|string
|yes
|The location URI of the users belonging to this reseller resource.
|@TODO add link to URI RFC
|
|
|<source lang="javascript">"users": "https://api.example.com/v1/resellers/4000001/users"</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 information.
|
|
|
|<source lang="javascript">"error": { /* ... */ }</source>
|}
== Reseller update (PUT) ==
The <code>PUT</code> method requires one to sent the complete record, thus the work-flow is normally as follows:
# A [[#Reseller_retrieval_Reseller_element_retrieval_.28GET.29|GET]] request on the Reseller element URI will be made to fetch the whole document.
# Update the fields which content has changed
# Send a <code>PUT</code> request with all the reseller data
=== Reseller 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>
PUT /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 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>
</pre>
|<pre>
Content-Type: Content-Type: application/json; charset=UTF-8
</pre>
|-
| [[#Reseller_update_response_message_body|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
|}
==== Reseller update 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 information about the failure.
== 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>
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 partly update request message body ====
The JSON message body consists out of one or more fields from the [[#reseller_object|Reseller object]].
@TODO: Add example.
=== Reseller partly 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>
</pre>
|<pre>
Content-Type: Content-Type: application/json; charset=UTF-8
</pre>
|-
| [[#Reseller_partly_update_response_message_body|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
|}
==== Reseller partly update 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 information about the failure.
== Reseller deletion (DELETE) ==
To delete an existing reseller, the client needs to send a HTTP <code>DELETE</code> request, with an empty request body 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>
DELETE <Request-URI> HTTP 1.1
HOST: <Host>
</pre>
|<pre>
DELETE /v1/resellers/4000001 HTTP 1.1
HOST: api.example.com
</pre>
|-
| Request headers
| <pre>
Accept: <Type>/<Subtype>
Accept-Charset: <Charset>
</pre>
| <pre>
Accept: application/json
Accept-Charset: UTF-8
</pre>
|-
| Request body
| <Empty>
| <pre></pre>
|}
=== 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>
</pre>
|<pre>
Content-Type: Content-Type: application/json; charset=UTF-8
</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 information about the failure.
== Reseller search ==
The reseller search is a sub section of the [[stoney core: Search Resource - REST API]] and is described there in more detail.
= Links =
* [[stoney core: REST API]]
[[Category:REST API]][[Category:stoney core]]