editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Schedules a series, a single program or a manual recording. A manual recording is one specified by channel, start time, and duration, instead o..."
{{Api_Method_Spec|
Description=Schedules a series, a single program or a manual recording.
A manual recording is one specified by channel, start time, and duration, instead of by the program's EPG identifier. For manual recording, use the Channel field to specify the channel to record (not needed to dynamic recording).
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=recordingDefinition
|ParamType=RemotePvrRecordingDefinition
|ParamRequired=
|ParamDescription=Object specifying what should be recorded. This will be either of type a Dynamic (for series recordings or single-program recordings) or Manual (for single or recurring manual recordings).
}}
{{Api_Parameter|
ParamName= epgOptional
|ParamType=bool
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= epgScheduleId
|ParamType=int
|ParamRequired=optional
|ParamDescription=The subscriptionId that wants request the data.
}}
{{Api_Parameter|
ParamName= version
|ParamType=int
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing object of [[RemotePvrSchedulingResult]]
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>:
:: { <span style="color: #219;">Object of [[RemotePvrSchedulingResult]]</span> }
}
|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"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Schedules a series, a single program or a manual recording.
A manual recording is one specified by channel, start time, and duration, instead of by the program's EPG identifier. For manual recording, use the Channel field to specify the channel to record (not needed to dynamic recording).
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=recordingDefinition
|ParamType=RemotePvrRecordingDefinition
|ParamRequired=
|ParamDescription=Object specifying what should be recorded. This will be either of type a Dynamic (for series recordings or single-program recordings) or Manual (for single or recurring manual recordings).
}}
{{Api_Parameter|
ParamName= epgOptional
|ParamType=bool
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= epgScheduleId
|ParamType=int
|ParamRequired=optional
|ParamDescription=The subscriptionId that wants request the data.
}}
{{Api_Parameter|
ParamName= version
|ParamType=int
|ParamRequired=optional
|ParamDescription=
}}
|Returns=
Returns a JSON object containing object of [[RemotePvrSchedulingResult]]
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>:
:: { <span style="color: #219;">Object of [[RemotePvrSchedulingResult]]</span> }
}
|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"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
