GetAllChannels

From Gvp-public
Revision as of 19:58, 4 June 2014 by Rcalvo (talk | contribs)
Jump to navigation Jump to search

Description

Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration. This method can only be accessed with a valid logged token (not accessible by anonymous).

It automatically filters the results to return only enable channel in the logged Instance, including the adult channels.

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


Returns

Returns a JSON object containing an array of Channel.

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 6,
"List":
[ Array of Channel object ]

}


Exceptions

None


Caching

This method is cached.


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral


See also