editor
278
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Allows scheduling a personal recording for a single event or for a complete series. Returns an array of RecordingSchedule ob..."
{{Api_Method_Spec|
Description=Allows scheduling a personal recording for a single event or for a complete series.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled according to these conditions:
If the recording of the schedule causes a conflict, it won't be scheduled and the state of the returned object will be "Conflicted". StatusCode will be “Recording Service Error Due To Conflicted Record”. This error code is one of the possible error codes returned returned by the method.
* If recordEntireSeries is false, returns the only recording schedule
* If recordEntireSeries is true and there is only one occurrence (episode) of the series, return this recording schedule
* If recordEntireSeries is true and there are multiple episodes, return the recording schedules of all episodes
|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=scheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Schedule ID
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=EPGLiveChannelReferenceId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID (as appearing in EPG file)
}}
{{Api_Parameter|
ParamName=serieId
|ParamType=int
|ParamRequired=optional
|ParamDescription=ID of the series associated to the schedule. Value will be set to 0 if the program is not a series episode.
}}
{{Api_Parameter|
ParamName=entireSeries
|ParamType=bool
|ParamRequired=optional (default=false)
|ParamDescription=If the Schedule Id is a series episode, all the next episodes should also be scheduled for recording when set to true. If set to false, only the single episode will be scheduled.
}}
|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=
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
Description=Allows scheduling a personal recording for a single event or for a complete series.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled according to these conditions:
If the recording of the schedule causes a conflict, it won't be scheduled and the state of the returned object will be "Conflicted". StatusCode will be “Recording Service Error Due To Conflicted Record”. This error code is one of the possible error codes returned returned by the method.
* If recordEntireSeries is false, returns the only recording schedule
* If recordEntireSeries is true and there is only one occurrence (episode) of the series, return this recording schedule
* If recordEntireSeries is true and there are multiple episodes, return the recording schedules of all episodes
|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=scheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Schedule ID
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=EPGLiveChannelReferenceId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID (as appearing in EPG file)
}}
{{Api_Parameter|
ParamName=serieId
|ParamType=int
|ParamRequired=optional
|ParamDescription=ID of the series associated to the schedule. Value will be set to 0 if the program is not a series episode.
}}
{{Api_Parameter|
ParamName=entireSeries
|ParamType=bool
|ParamRequired=optional (default=false)
|ParamDescription=If the Schedule Id is a series episode, all the next episodes should also be scheduled for recording when set to true. If set to false, only the single episode will be scheduled.
}}
|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=
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
