editor
725
edits
Changes
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..."
{{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 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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|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
}}
{{Api_Parameter|
ParamName=parentChannelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of a channel that wants the result
}}
{{Api_Parameter|
ParamName=includeAllLevels
|ParamType=bool
|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.
}}
|Returns=
Returns a JSON object containing an array of [[Channel]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[Channel]] objects</span> ]
}
|Exceptions=
* None
|Cache=
This method is cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|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
}}
{{Api_Parameter|
ParamName=parentChannelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of a channel that wants the result
}}
{{Api_Parameter|
ParamName=includeAllLevels
|ParamType=bool
|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.
}}
|Returns=
Returns a JSON object containing an array of [[Channel]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[Channel]] objects</span> ]
}
|Exceptions=
* None
|Cache=
This method is cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
