Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the channel map (ChannelMap object) for the user. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=requi..."
{{Api_Method_Spec|
Description=Returns the channel map ([[ChannelMap]] object) for the user.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
|Returns=
Returns a JSON object with the [[ChannelMap]].
'''Example:'''
{
: [[ChannelMap]] object
}
|Exceptions=
* [[StatusCode#InvalidRegionException|InvalidRegionException]]: if the user is not assigned a valid region
* [[StatusCode#InvalidTVTechnologyException|InvalidTVTechnologyException]]: if the user is not assigned a valid TV Technology
* [[StatusCode#InvalidChannelMapException|InvalidChannelMapException]]: if can't find a channel map for this user
|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=
* [[LiveChannel]] object type
* [[AdultFilterType]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
Description=Returns the channel map ([[ChannelMap]] object) for the user.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
|Returns=
Returns a JSON object with the [[ChannelMap]].
'''Example:'''
{
: [[ChannelMap]] object
}
|Exceptions=
* [[StatusCode#InvalidRegionException|InvalidRegionException]]: if the user is not assigned a valid region
* [[StatusCode#InvalidTVTechnologyException|InvalidTVTechnologyException]]: if the user is not assigned a valid TV Technology
* [[StatusCode#InvalidChannelMapException|InvalidChannelMapException]]: if can't find a channel map for this user
|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=
* [[LiveChannel]] object type
* [[AdultFilterType]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
