Difference between revisions of "GetSubscriptionLiveChannels"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description= | Description= | ||
| − | |||
| − | |||
Returns the list of [[LiveChannel]] objects available in the instance under a Subscription. The SubscriptionId should be sent in a request. | Returns the list of [[LiveChannel]] objects available in the instance under a Subscription. The SubscriptionId should be sent in a request. | ||
Latest revision as of 16:29, 2 June 2014
Description
Returns the list of LiveChannel objects available in the instance under a Subscription. The SubscriptionId should be sent in a request.
The result is default ordered by the property channel name in the object LiveChannel.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
- subscriptionId (int, required)
- The subscriptionId that wants request the data.
Returns
Returns a JSON object containing an array of LiveChannel.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of LiveChannel objects ]
}
Exceptions
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
