Difference between revisions of "API Collections Retrieve"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→URI) |
Tommy.leung (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | <div style="color:red;font-weight:bold;font-size:20px">DRAFT</div><br\> | ||
| + | |||
== Summary == | == Summary == | ||
Retrieve one collection. | Retrieve one collection. | ||
Revision as of 14:17, 4 October 2012
DRAFT
<br\>
Summary
Retrieve one collection.
URI
https://api.unroole.com/collections/[collection-id]
HTTP Method
GET
Required Paramaters
| Paramater | Default | Maximum Length | Accepted Values | Description |
|---|---|---|---|---|
| token | API Persistence Token that identifies this user and its permissions. |
Optional Paramaters
| Paramater | Default | Maximum Length | Accepted Values | Description |
|---|---|---|---|---|
| fields | id, name, items | API Collection Fields | List of comma separated fields to be returned in the response. |
Response
| Field | Type | Description |
|---|---|---|
| http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
| error | Rails default | |
| collection | API Collection Fields |
