Difference between revisions of "GetAllChannels"
Jump to navigation
Jump to search
| Line 6: | Line 6: | ||
|Parameters= | |Parameters= | ||
| + | |||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=token | ParamName=token | ||
| Line 24: | Line 25: | ||
|ParamDescription=The limit number of values for this request | |ParamDescription=The limit number of values for this request | ||
}} | }} | ||
| + | |||
|Returns= | |Returns= | ||
Returns a JSON object containing an array of [[Channel]]. | Returns a JSON object containing an array of [[Channel]]. | ||
Revision as of 20:12, 4 June 2014
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 |
