Difference between revisions of "API Channels List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Summary) |
Tommy.leung (Talk | contribs) |
||
Line 2: | Line 2: | ||
Allows querying for a list of channels belonging to the account. The query is a wildcard search on: | Allows querying for a list of channels belonging to the account. The query is a wildcard search on: | ||
* name | * name | ||
+ | * type | ||
== URI == | == URI == | ||
− | {{:API_Base_URI}}[account-id]/channels | + | {{:API_Base_URI}}accounts/[account-id]/channels |
== HTTP Method == | == HTTP Method == |
Revision as of 12:05, 4 June 2012
Summary
Allows querying for a list of channels belonging to the account. The query is a wildcard search on:
- name
- type
URI
https://api.unroole.com/accounts/[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. |