Difference between revisions of "API Collections List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Summary) |
Tommy.leung (Talk | contribs) (→URI) |
||
| Line 5: | Line 5: | ||
== URI == | == URI == | ||
| − | {{:API_Base_URI}}[channel-id]/collections | + | {{:API_Base_URI}}channels/[channel-id]/collections |
== HTTP Method == | == HTTP Method == | ||
Revision as of 10:37, 5 June 2012
Summary
Allows querying for a list of collections in the channel. The query is a wildcard search on:
- name
- description
URI
https://api.unroole.com/channels/[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. |
