Changes

stoney core: Search Resource - REST API

1,250 bytes added, 13:42, 14 May 2014
/* Resellers Search (GET) */
The following special resources don't have additional search methods:
* [[stoney core: Authentication Resource - REST API]]
 
== Global Search (GET) ==
To form a fulltext search, append the url query parameter '''q''' with the desired search text: <code>https://api.example.com/v1/resellers?q=example</code>.
 
=== Global Search 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>
 
|}
 
=== Global Search Request 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
</pre>
 
|-
| [[#reseller_collection_retrieval_response_object|Response body]]
| JSON object
| <source lang="javascript">{ ... }</source>
 
|}
== Resellers Search (GET) ==
SLB, editor, reviewer
3,368
edits