Difference between revisions of "GetChannelChildren"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of Channel objects available in the instance under an specific Channel. It can include all sub channels (any levels) or jus...") |
|||
| Line 34: | Line 34: | ||
|ParamType=bool | |ParamType=bool | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=Flag to set if the result should be contain all sub channels from all levels or just the first level of sub channels. | + | |ParamDescription=Flag to set if the result should be contain all sub channels from all levels or just the first level of sub channels. The default value is false. |
}} | }} | ||
Latest revision as of 20:50, 25 June 2014
Description
Returns the list of Channel objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel.
The result is default ordered by the property ID in the object Channel. This method can be used by logged or anonymous login.
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
- parentChannelId (int, required)
- Id of a channel that wants the result
- includeAllLevels (bool, optional)
- Flag to set if the result should be contain all sub channels from all levels or just the first level of sub channels. The default value is false.
Returns
Returns a JSON object containing an array of Channel.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 14,
- "List":
- [ Array of Channel objects ]
}
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 |
