Difference between revisions of "API Channels List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (Created page with "== Summary == Allows querying for a list of channels belonging to the account. == URI == {{:API_Base_URI}}[account-id]/channels == HTTP Method == GET == Required Paramaters...") |
Tommy.leung (Talk | contribs) (→Optional Paramaters) |
||
Line 30: | Line 30: | ||
! Accepted Values | ! Accepted Values | ||
! Description | ! Description | ||
+ | |- | ||
+ | | search | ||
+ | | string | ||
+ | | | ||
+ | | | ||
+ | | The search terms to be used in the query. | ||
+ | |- | ||
+ | | limit | ||
+ | | TBD | ||
+ | | | ||
+ | | | ||
+ | | The maximum number of channels to return. | ||
|- | |- | ||
| url_time_limit | | url_time_limit |
Revision as of 13:07, 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. | ||
url_time_limit | 60 | The length of time (in seconds) that the logo 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 |