GetLiveProgramSchedules - Revision history

Id01213 at 13:15, 14 October 2015

2015-10-14T13:15:56Z

Id01213 at 15:02, 20 April 2015

2015-04-20T15:02:18Z

Id01213 at 14:06, 20 April 2015

2015-04-20T14:06:17Z

Id01213 at 06:53, 1 April 2015

2015-04-01T06:53:44Z

Id02256: Created page with "{{Api_Method_Spec| Description=Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided program ID and adult filter. |Parameters= {{Api_Par..."

2014-06-02T15:19:12Z

Created page with "{{Api_Method_Spec| Description=Returns the list of live schedules (as array of EpgLiveSchedule objects) for the provided program ID and adult filter. |Parameters= {{Api_Par..."

New page

{{Api_Method_Spec|
Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID and adult filter.

|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=liveProgramId
|ParamType=int
|ParamRequired=required
|ParamDescription=Program ID
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=[[AdultFilterType]]
|ParamRequired=optional
|ParamDescription=Adult filter to apply to the list (default = all)
}}

|Returns=
Returns a JSON object with a list of [[EpgLiveSchedule]].

'''Example:'''

{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[EpgLiveSchedule]] objects ]
}

|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=
* [[EpgLiveProgram]] object type
* [[EpgLiveSchedule]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}

@@ Line 73: / Line 73: @@
 {{!}} Harley Cabral
 {{!}}- valign="top"
-! 3.1
+! 3.2
 {{!}} Included parameters for highlights filtering
 {{!}} Jose A. Jiménez

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID, adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
+Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID, and adult filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
 |Parameters=
@@ Line 32: / Line 32: @@
 |ParamRequired=optional
 |ParamDescription=Adult filter to apply to the list (default = all)
 }}
 {{Api_Parameter|
@@ Line 80: / Line 74: @@
 {{!}}- valign="top"
 ! 3.1
-{{!}} Included parameters for program_type and highlights filtering
+{{!}} Included parameters for highlights filtering
 {{!}} Jose A. Jiménez
 {{!}}}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID, adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents, and to sort the schedule lists by rating value (descending).
+Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided program ID, adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
 |Parameters=
@@ Line 44: / Line 44: @@
 |ParamRequired=optional
 |ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false)
 }}
@@ Line 86: / Line 80: @@
 {{!}}- valign="top"
 ! 3.1
-{{!}} Included parameters for program_type and highlights filtering, and highlights sorting
+{{!}} Included parameters for program_type and highlights filtering
 {{!}} Jose A. Jiménez
 {{!}}}