Bureaucrats, editor
48
edits
Changes
Jump to navigation
Jump to search
no edit summary
<p>'''OpenPlatform comments''':</p>
* <span style="color:red">To Be Reviewed: The objects that will come in the response in the singleProgram and full season cases</span>
<p>'''MiViewTV comments''':</p>
* In the case of "series recording schedules", the method will only create a kind of "container recording schedule" where the actual recordings will be added. After creating the "container" (parent recording for the series), the STB will later (automatically and periodically, after detecting the parent recording schedule) add the recording for each episode linked to the series.
<p>* '''Mediaroom comments''':</p>
* Mediaroom service allows two types of recordings: Dynamic ("event-based") and "manual" (or "time-based" specifying channel ID, program, and time frame). GVP nPVR API only uses the Dynamic (event-based) mode, as the devices (such as Go) schedule recordings based on info from the EPG
* In principle, Mediaroom allows creation or recordings even when they are in conflict with other recording(s). In this case, it will be reflected it in the [[RecordingSchedule|RecordingSchedule]] struct of the response (using the boolean member "Conflicted"). Tt is also possible that some "conflicting" recordings are automatically detected and not registered by Mediaroom, so the process could result in an error (exception).
ParamName=channelId
|ParamType=int
|ParamRequired=requiredon mediaroom|ParamDescription=Live Channel ID (EPGLiveChannelReferenceIdGVP_EPG_LIVE_CHANNELS.REFERENCE_ID; as appearing in EPG file) available in contentApi (LSC.EpgChannelId) info not available in IPI, sent blank in that case}}{{Api_Parameter|ParamName=LiveChannelId|ParamType=int|ParamRequired=required on openPlatform|ParamDescription= GVP Live Channel ID (GVP_EPG_SCHEDULE. EPG_LIVE_CHANNEL_ID) the ChannelId sent through contentApi (LSC.ChannelId) and IPI (Channel_id: ServiceName)
}}
{{Api_Parameter|
|ParamType=int
|ParamRequired=optional
|ParamDescription=Allows identifying the ChannelNumber of the Channel inside the MEdiaroom Mediaroom channel Map). (LCH channelNumber in the user channel Map)
}}
{{Api_Parameter|
ParamName=SeasonNumberseasonNumber
|ParamType=int
|ParamRequired=optional
|ParamDescription=This parameter is mandatory in OpenPlatform implementation, is the SeasonNumber of the LSC object in contentApi (BBDD GVP_EPG_PROGRAMS.EPG_SEASON_NUMBER)
}}
{{Api_Parameter|ParamName=trackId|ParamType=string|ParamRequired=optional|ParamDescription=trackId of the schedule if it has been recommended to the user}}{{Api_Parameter|ParamName=UXReference|ParamType=string|ParamRequired=optional|ParamDescription=UXReference of the request that returned the recommendation}}
|Returns=
Returns a JSON object with a list of [[RecordingSchedule|RecordingSchedule]].
: "Limit": 10,
: "Count": 48,
: "List":[ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|Exceptions=
Possible error results (included in the GVP general error list) are:
*210 UnexpectedRecordingResponse ''OpenPlatf''
*211 RecordingSubscriberNotFound ''OpenPlatf, MiViewTV, Mirada, Mediaroom''
*212 RecordingSubscriberNotSubscribed ''OpenPlatf, MiViewTV, Mirada''
