editor
278
edits
Changes
Jump to navigation
Jump to search
GetLiveChannelsReducedLiveSchedulesSortedByRating (view source)
Revision as of 14:10, 20 April 2015
, 14:10, 20 April 2015Created page with "{{Api_Method_Spec| Description=Returns the list of reduced live schedules (as array of ReducedLiveSchedule objects) for the provided channel IDs, time frame (DateTime valu..."
{{Api_Method_Spec|
Description=Returns the list of reduced live schedules (as array of [[ReducedLiveSchedule]] objects) for the provided channel IDs, time frame (DateTime value type represents dates and times measured in 100-nanosecond units called ticks, and a particular date is the number of ticks since 12:00 midnight, January 1, 0001 A.D. (C.E.) in the GregorianCalendar calendar), adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
'''Returned contents (schedules) are sorted by rating value (descending).'''
|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=liveChannelIds
|ParamType=array of int
|ParamRequired=required
|ParamDescription=List of Channel IDs
}}
{{Api_Parameter|
ParamName=startDate
|ParamType=DateTime
|ParamRequired=required
|ParamDescription=starting time period for the query (long int)
}}
{{Api_Parameter|
ParamName=endDate
|ParamType=DateTime
|ParamRequired=required
|ParamDescription=ending time period for the query (long int)
}}
{{Api_Parameter|
ParamName=imageWidth
|ParamType=int
|ParamRequired=optional
|ParamDescription=Channel Image width (default=0)
}}
{{Api_Parameter|
ParamName=imageHeight
|ParamType=int
|ParamRequired=optional
|ParamDescription=Channel Image width (default=0)
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=[[AdultFilterType]]
|ParamRequired=optional
|ParamDescription=Adult filter to apply to the list (default = all)
}}
{{Api_Parameter|
ParamName=programTypeFilter
|ParamType=[[ProgramType]]
|ParamRequired=optional
|ParamDescription=Filter results to only include the provided program type (default = all; no filtering)
}}
{{Api_Parameter|
ParamName=highlightsOnlyFilter
|ParamType=bool
|ParamRequired=optional
|ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false)
}}
|Returns=
Returns a JSON object with a list of [[ReducedLiveSchedule]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[ReducedLiveSchedule]] 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"
! 3.1
{{!}} New method design, based on GetLiveChannelsReducedLiveSchedules
{{!}} Jose A. Jiménez
{{!}}}
|SeeAlso=
* [[EpgLiveProgram]] object type
* [[EpgLiveSchedule]] object type
* [[ReducedLiveSchedule]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
Description=Returns the list of reduced live schedules (as array of [[ReducedLiveSchedule]] objects) for the provided channel IDs, time frame (DateTime value type represents dates and times measured in 100-nanosecond units called ticks, and a particular date is the number of ticks since 12:00 midnight, January 1, 0001 A.D. (C.E.) in the GregorianCalendar calendar), adult filter and program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
'''Returned contents (schedules) are sorted by rating value (descending).'''
|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=liveChannelIds
|ParamType=array of int
|ParamRequired=required
|ParamDescription=List of Channel IDs
}}
{{Api_Parameter|
ParamName=startDate
|ParamType=DateTime
|ParamRequired=required
|ParamDescription=starting time period for the query (long int)
}}
{{Api_Parameter|
ParamName=endDate
|ParamType=DateTime
|ParamRequired=required
|ParamDescription=ending time period for the query (long int)
}}
{{Api_Parameter|
ParamName=imageWidth
|ParamType=int
|ParamRequired=optional
|ParamDescription=Channel Image width (default=0)
}}
{{Api_Parameter|
ParamName=imageHeight
|ParamType=int
|ParamRequired=optional
|ParamDescription=Channel Image width (default=0)
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=[[AdultFilterType]]
|ParamRequired=optional
|ParamDescription=Adult filter to apply to the list (default = all)
}}
{{Api_Parameter|
ParamName=programTypeFilter
|ParamType=[[ProgramType]]
|ParamRequired=optional
|ParamDescription=Filter results to only include the provided program type (default = all; no filtering)
}}
{{Api_Parameter|
ParamName=highlightsOnlyFilter
|ParamType=bool
|ParamRequired=optional
|ParamDescription=If true, only "highlighted" contents (rating>0) are returned (default = false)
}}
|Returns=
Returns a JSON object with a list of [[ReducedLiveSchedule]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[ReducedLiveSchedule]] 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"
! 3.1
{{!}} New method design, based on GetLiveChannelsReducedLiveSchedules
{{!}} Jose A. Jiménez
{{!}}}
|SeeAlso=
* [[EpgLiveProgram]] object type
* [[EpgLiveSchedule]] object type
* [[ReducedLiveSchedule]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}
