Difference between revisions of "GetAllChannels"
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged. | |ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged. | ||
}} | }} | ||
| − | + | {{Api_Parameter| | |
| + | ParamName=offset | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=The offset number of the returned values for this request | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=limit | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=The limit number of values for this request | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing | + | Returns a JSON object containing an array of [[Channel]]. |
'''Example:''' | '''Example:''' | ||
| Line 26: | Line 36: | ||
: <span style="color: #a11">"Limit"</span>: 100, | : <span style="color: #a11">"Limit"</span>: 100, | ||
: <span style="color: #a11">"Count"</span>: 6, | : <span style="color: #a11">"Count"</span>: 6, | ||
| − | : <span style="color: #a11">" | + | : <span style="color: #a11">"List"</span>: |
| − | :: | + | :: [ Array of [[Channel]] object ] |
} | } | ||
|Exceptions= | |Exceptions= | ||
| − | + | None | |
|Cache= | |Cache= | ||
| − | This method is | + | This method is cached. |
|KnownIssues= | |KnownIssues= | ||
| Line 48: | Line 58: | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | ! | + | ! 1.0 |
{{!}} Initial method design | {{!}} Initial method design | ||
| − | {{!}} | + | {{!}} Harley Cabral |
{{!}}- valign="top" | {{!}}- 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 |
