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 from a list of Channel's ID. The result is default ordered by the property ID..."
{{Api_Method_Spec|
Description=Returns the list of [[Channel]] objects available in the instance from a list of Channel's ID.
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=channelIds
|ParamType=int
|ParamRequired=required
|ParamDescription=List of Channel ID's that want to be returned the information.
}}
|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;">4</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 from a list of Channel's ID.
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=channelIds
|ParamType=int
|ParamRequired=required
|ParamDescription=List of Channel ID's that want to be returned the information.
}}
|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;">4</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=
}}
