Difference between revisions of "API Collections Retrieve"
From unroole CMS wiki
Tommy.leung (Talk | contribs) |
|||
(2 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
− | |||
− | |||
== Summary == | == Summary == | ||
Retrieve one collection. | Retrieve one collection. | ||
Line 33: | Line 31: | ||
|- | |- | ||
| fields | | fields | ||
− | | | + | | (all) |
| | | | ||
| [[API Collection Fields]] | | [[API Collection Fields]] | ||
Line 50: | Line 48: | ||
| collection | | collection | ||
| [[API Collection Fields]] | | [[API Collection Fields]] | ||
+ | | All the data in a collection. | ||
|} | |} |
Latest revision as of 11:52, 6 December 2013
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 | (all) | 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 | All the data in a collection. |