GetLiveChannelsReducedLiveSchedules

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, and to sort the schedule lists by rating value (descending).

Parameters

• token (String, required)

A valid token for identifying the API session context and logged user.

• offset (int, optional)

Index of the initial result of the list, begins with 0

• limit (int, optional)

Quantity of results showed, with the maximum of 100

• liveChannelIds (array of int, required)

List of Channel IDs

• startDate (DateTime, required)

starting time period for the query (long int)

• endDate (DateTime, required)

ending time period for the query (long int)

• imageWidth (int, optional)

Channel Image width (default=0)

• imageHeight (int, optional)

Channel Image width (default=0)

• adultFilter (AdultFilterType, optional)

Adult filter to apply to the list (default = all)

• programTypeFilter (ProgramType, optional)

Filter results to only include the provided program type (default = all; no filtering)

• highlightsOnlyFilter (bool, optional)

If true, only "highlighted" contents (rating>0) are returned (default = false)

• highlightsSorting (HighlightsSorting, optional)

Sorting criteria (default = 0; contents/schedules are not sorted by rating)

Returns

Returns a JSON object with a list of ReducedLiveSchedule.

Example:

{

"Offset": 0,

"Limit": 10,

"Count": 48,

[ Array of ReducedLiveSchedule objects ]

}

Exceptions

• None.

Caching

This method is cached.

Known issues

None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral
3.1	Included parameters for program_type and highlights filtering, and highlights sorting	Jose A. Jiménez

See also

• EpgLiveProgram object type
• EpgLiveSchedule object type
• ReducedLiveSchedule object type
• Epg Service methods