editor
278
edits
Changes
Jump to navigation
Jump to search
}}
{{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
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
no edit summary
{{Api_Method_Spec|
Description=Returns the list of live schedules (as array of [[EpgLiveSchedule]] objects) for the provided list of schedules (IDs) , adult filter and adult program type filter. It is also possible to restrict the list of results to only include "highlighted" (rating > 0) contents.
|Parameters=
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
|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 an array list of [[EpgLiveSchedule]].
'''Example:'''
{
: [ Array of [[EpgLiveSchedule]] objects ]
}
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}- valign="top"
! 3.2
{{!}} Included parameters for program_type and highlights filtering; No longer a paginated list, just an array
{{!}} Francisco Milargo
{{!}}}
