Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the list of live programs (as array of EpgLiveProgram objects) for the provided program IDs. |Parameters= {{Api_Parameter| ParamName=t..."
{{Api_Method_Spec|
Description=Returns the list of live programs (as array of [[EpgLiveProgram]] objects) for the provided program IDs.
|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=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=Index of the initial result of the list, begins with 0
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=Quantity of results showed, with the maximum of 100
}}
{{Api_Parameter|
ParamName=liveProgramIds
|ParamType=array of int
|ParamRequired=required
|ParamDescription=List of live program IDs
}}
|Returns=
Returns a JSON object with a list of [[EpgLiveProgram]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[EpgLiveProgram]] objects ]
}
|Exceptions=
* [[StatusCode#InvalidLiveProgramException|InvalidLiveProgramException]]: if program ID does not exist.
|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=
* [[EpgLiveProgram]] object type
* [[EpgLiveSchedule]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
Description=Returns the list of live programs (as array of [[EpgLiveProgram]] objects) for the provided program IDs.
|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=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=Index of the initial result of the list, begins with 0
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=Quantity of results showed, with the maximum of 100
}}
{{Api_Parameter|
ParamName=liveProgramIds
|ParamType=array of int
|ParamRequired=required
|ParamDescription=List of live program IDs
}}
|Returns=
Returns a JSON object with a list of [[EpgLiveProgram]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[EpgLiveProgram]] objects ]
}
|Exceptions=
* [[StatusCode#InvalidLiveProgramException|InvalidLiveProgramException]]: if program ID does not exist.
|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=
* [[EpgLiveProgram]] object type
* [[EpgLiveSchedule]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
