editor
278
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description= Get a list with all the Schedules (as an array of RecordingSchedule objects) for the current user with a given Recording Sta..."
{{Api_Method_Spec|
Description= Get a list with all the Schedules (as an array of [[RecordingSchedule|RecordingSchedule]] objects) for the current user with a given Recording State.
|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=GvpRecordingState
|ParamType=[[RecordingScheduleState|RecordingScheduleState]] enum
|ParamRequired=optional
|ParamDescription=Recording schedule state to filter results
}}
|Returns=
Returns a JSON object with a list of [[RecordingSchedule|RecordingSchedule]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|Exceptions=
* None.
|Cache=
This method is not 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"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}
|SeeAlso=
* [[RecordingScheduleState|RecordingScheduleState]] enum
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
Description= Get a list with all the Schedules (as an array of [[RecordingSchedule|RecordingSchedule]] objects) for the current user with a given Recording State.
|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=GvpRecordingState
|ParamType=[[RecordingScheduleState|RecordingScheduleState]] enum
|ParamRequired=optional
|ParamDescription=Recording schedule state to filter results
}}
|Returns=
Returns a JSON object with a list of [[RecordingSchedule|RecordingSchedule]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|Exceptions=
* None.
|Cache=
This method is not 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"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}
|SeeAlso=
* [[RecordingScheduleState|RecordingScheduleState]] enum
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
