Difference between revisions of "GetAllChannels"
Jump to navigation
Jump to search
| Line 24: | Line 24: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=The limit number of values for this request | |ParamDescription=The limit number of values for this request | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=bottomUpOnly | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=<span style='color: green'>((NEW IN 2.4)</span> | ||
| + | true (default value): the method will return only BU/Both Subscriptions | ||
| + | false: the method will return BU/Both and TD Subscriptions | ||
}} | }} | ||
| Line 59: | Line 67: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}} | ||
| + | ! 2.4 | ||
| + | {{!}} New parameter '''bottomUpOnly''' | ||
| + | {{!}} Ricardo Calvo | ||
| + | {{!}}- valign="top" | ||
| + | |||
{{!}}} | {{!}}} | ||
Revision as of 20:07, 18 September 2014
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
- bottomUpOnly (bool, optional)
- ((NEW IN 2.4)
true (default value): the method will return only BU/Both Subscriptions
false: the method will return BU/Both and TD Subscriptions
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 | 2.4 | New parameter bottomUpOnly | Ricardo Calvo |
