Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the list of live channels (as an array of ChannelMapLiveChannel objects) of a channel map. |Parameters= {{Api_Parameter| ParamName=tok..."
{{Api_Method_Spec|
Description=Returns the list of live channels (as an array of [[ChannelMapLiveChannel]] objects) of a channel map.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=channelMapId
|ParamType=int
|ParamRequired=required
|ParamDescription=Channel Map ID
}}
|Returns=
Returns a JSON object with a list of [[ChannelMapLiveChannel]].
'''Example:'''
{
: [ Array of [[ChannelMapLiveChannel]] objects ]
}
|Exceptions=
* [[StatusCode#ArgumentNullException|ArgumentNullException]]: if the user context for the channel map can't be found
* [[StatusCode#InvalidChannelMapException|InvalidChannelMapException]]: can't find a channel map
|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=
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
Description=Returns the list of live channels (as an array of [[ChannelMapLiveChannel]] objects) of a channel map.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=channelMapId
|ParamType=int
|ParamRequired=required
|ParamDescription=Channel Map ID
}}
|Returns=
Returns a JSON object with a list of [[ChannelMapLiveChannel]].
'''Example:'''
{
: [ Array of [[ChannelMapLiveChannel]] objects ]
}
|Exceptions=
* [[StatusCode#ArgumentNullException|ArgumentNullException]]: if the user context for the channel map can't be found
* [[StatusCode#InvalidChannelMapException|InvalidChannelMapException]]: can't find a channel map
|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=
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
