Difference between revisions of "API Collections Retrieve"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (Created page with "== Summary == Retrieve one collection. == URI == {{:API_Base_URI}}[channel-id]/collections/[collection-id] == HTTP Method == GET == Required Paramaters == {| class="wikita...") |
|||
(4 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
== URI == | == URI == | ||
− | {{:API_Base_URI}} | + | {{:API_Base_URI}}collections/[collection-id] |
== HTTP Method == | == HTTP Method == | ||
Line 31: | Line 31: | ||
|- | |- | ||
| fields | | fields | ||
− | | | + | | (all) |
| | | | ||
| [[API Collection Fields]] | | [[API Collection Fields]] | ||
Line 48: | 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. |