Difference between revisions of "API Channels List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Response) |
Tommy.leung (Talk | contribs) (→Optional Paramaters) |
||
Line 42: | Line 42: | ||
| | | | ||
| The maximum number of channels to return. | | The maximum number of channels to return. | ||
+ | |- | ||
+ | | fields | ||
+ | | id, name, type, url, logo_url | ||
+ | | | ||
+ | | [[API Channel Fields]] | ||
+ | | List of comma separated fields to be returned in the response. | ||
|- | |- | ||
| url_time_limit | | url_time_limit | ||
Line 47: | Line 53: | ||
| | | | ||
| | | | ||
− | | The length of time (in seconds) that the | + | | The length of time (in seconds) that the asset url will be accessible for. This only applies to the response. |
|} | |} | ||
Revision as of 13:13, 31 May 2012
Summary
Allows querying for a list of channels belonging to the account.
URI
https://api.unroole.com/[account-id]/channels
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 channels to return. | ||
fields | id, name, type, url, logo_url | API Channel Fields | List of comma separated fields to be returned in the response. | |
url_time_limit | 60 | The length of time (in seconds) that the asset url will be accessible for. This only applies to the response. |
Response
Field | Type | Description |
---|---|---|
http_status | integer | API Status Code http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
error | Rails default | |
accounts | array of API Channel Fields | List of channels |
result_length | integer | Total number of results that could be returned. This may not be the number of channels in the response, as it is truncated by limit parameter. |