Difference between revisions of "GetAllChannels"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration. This method can only be acc...") |
|||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Returns a list of [[Channel]] registered under de root channel specified as channel Root in the Instance configuration | + | Description=Returns a list of [[Channel]] registered under de root channel specified as channel Root in the Instance configuration. |
It automatically filters the results to return only enable channel in the logged Instance, including the adult channels. | It automatically filters the results to return only enable channel in the logged Instance, including the adult channels. | ||
| 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]]. | ||
| Line 29: | Line 32: | ||
'''Example:''' | '''Example:''' | ||
| − | |||
{ | { | ||
| − | + | : <span style="color: #a11">"Offset"</span>: 0, | |
| − | + | : <span style="color: #a11">"Limit"</span>: 100, | |
| − | + | : <span style="color: #a11">"Count"</span>: 6, | |
| − | + | : <span style="color: #a11">"List"</span>: | |
| − | + | :: [ Array of [[Channel]] object ] | |
} | } | ||
| − | + | ||
|Exceptions= | |Exceptions= | ||
| Line 55: | Line 57: | ||
! Changes author | ! Changes author | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| + | |||
! 1.0 | ! 1.0 | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | |||
{{!}}} | {{!}}} | ||
Latest revision as of 12:56, 4 March 2016
Description
Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration.
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 |
