Difference between revisions of "API Collections List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Optional Paramaters) |
Tommy.leung (Talk | contribs) (→Response) |
||
| Line 61: | Line 61: | ||
| array of [[API Collection Fields]] | | array of [[API Collection Fields]] | ||
| List of collections | | List of collections | ||
| + | |- | ||
| + | | result_length | ||
| + | | integer | ||
| + | | Total number of results that '''could''' be returned. This may not be the number of collections in the response, as it is truncated by ''limit'' parameter. | ||
|} | |} | ||
Revision as of 13:08, 31 May 2012
Summary
Allows querying for a list of collections in the channel.
URI
https://api.unroole.com/[channel-id]/collections
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 |
|---|---|---|---|---|
| search | string | The search terms to be used in the query. | ||
| limit | TBD | The maximum number of collections to return. | ||
| 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 | |
| collections | array of API Collection Fields | List of collections |
| result_length | integer | Total number of results that could be returned. This may not be the number of collections in the response, as it is truncated by limit parameter. |
