editor
278
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description= Cancel each of the given RecordingSchedule and delete them from the platform. Returns an rray of RecordingSchedule objects..."
{{Api_Method_Spec|
Description= Cancel each of the given RecordingSchedule and delete them from the platform.
Returns an rray of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters:
* If the recording schedule was successfully cancelled and deleted by the platform, its state will be "Canceled"
* If a given recording schedule could not be canceled, its state will remain "Scheduled".
* If a given recording schedule was not found, its state will be "Not Found".
|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=recordingScheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of the Recording Schedule to be canceled
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID
}}
{{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= Cancel each of the given RecordingSchedule and delete them from the platform.
Returns an rray of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters:
* If the recording schedule was successfully cancelled and deleted by the platform, its state will be "Canceled"
* If a given recording schedule could not be canceled, its state will remain "Scheduled".
* If a given recording schedule was not found, its state will be "Not Found".
|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=recordingScheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of the Recording Schedule to be canceled
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID
}}
{{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
}}
