Difference between revisions of "GetSubscriptionLiveChannels"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=<span style="color:#7DC04E">Returns the list of [[LiveChannel]] objects available in the instance under a Subscription. The SubscriptionId should be sent in a request.</span>
+
Description=<span style="color:#7DC04E">
 +
==== THIS METHOD IS DRAFT ====
 +
</span>
 +
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]].
 
The result is default ordered by the property channel name in the object [[LiveChannel]].

Revision as of 16:24, 2 June 2014

Description

THIS METHOD IS DRAFT

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


See also