Summary
Allows querying for a list of channels belonging to the account. The query is a wildcard search on:
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
Examples
All channels on the account accessible by the user
Parameters
|
Values
|
token
|
1f0qpLwoV5oIcfnU2yvO
|
JSON
|
http://api.unroole.com/accounts/2/channels.json?token=1f0qpLwoV5oIcfnU2yvO
|
{
"channels" : [
{ "id" : 5,
"logo_url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/channels/logos/5/original/opo9941a.jpg",
"name" : "another sample channel",
"type" : "Mobile Briefcase",
"url" : "http://anothersamplechannel-sample.unroole.com"
},
{ "id" : 4,
"logo_url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/channels/logos/4/original/heic0709b.jpg",
"name" : "samplechannel",
"type" : "Mobile Briefcase",
"url" : "http://samplechannel-sample.unroole.com"
}
],
"http_status" : 200,
"result_length" : 2
}
|
XML
|
http://api.unroole.com/accounts/2/channels.xml?token=1f0qpLwoV5oIcfnU2yvO
|
<hash>
<channels type="array">
<channel>
<id type="integer">5</id>
<name>another sample channel</name>
<type>Mobile Briefcase</type>
<url>http://anothersamplechannel-sample.unroole.com</url>
<logo-url>https://cdn-unroole-dev.s3.amazonaws.com/system/channels/logos/5/original/opo9941a.jpg</logo-url>
</channel>
<channel>
<id type="integer">4</id>
<name>samplechannel</name>
<type>Mobile Briefcase</type>
<url>http://samplechannel-sample.unroole.com</url>
<logo-url>https://cdn-unroole-dev.s3.amazonaws.com/system/channels/logos/4/original/heic0709b.jpg</logo-url>
</channel>
</channels>
<result-length type="integer">2</result-length>
<http-status type="integer">200</http-status>
</hash>
|