editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Retrieves extended EPG data for one or more programs, specified by their program IDs. This method enables the client to retrieve EPG data for pr..."
{{Api_Method_Spec|
Description=Retrieves extended EPG data for one or more programs, specified by their program IDs. This method enables the client to retrieve EPG data for programs for which EPG data is not otherwise available. For example, the client can use this function to get EPG data for a completed recording that is stored on a set-top box (with its EPG data) but no longer appears in the current program guide.
The expected result is: IRemotePvrProgramInfosResult containing information about all the specified programs. If any of the transactions fails, the failures are noted in the returned object's FailedTransactions field, which contains one DVRTransactionReport (p. 329) for each failed operation. Each DVRTransactionReport contains the program ID whose information could not be retrieved (in the ItemId field) and a brief text description of the failure (in the ErrMsg field). Possible error messages include: • "Invalid id type": A member of programIds is not of type ProviderExternalId. • "Id not found ": The web service is unable to find program information for the specified program.
|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=programIds
|ParamType=RemotePvrProviderExternalId
|ParamRequired=required
|ParamDescription=
}}
|Returns=
Returns a JSON object containing an ???.
'''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;">Array of [[???]] objects</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=Retrieves extended EPG data for one or more programs, specified by their program IDs. This method enables the client to retrieve EPG data for programs for which EPG data is not otherwise available. For example, the client can use this function to get EPG data for a completed recording that is stored on a set-top box (with its EPG data) but no longer appears in the current program guide.
The expected result is: IRemotePvrProgramInfosResult containing information about all the specified programs. If any of the transactions fails, the failures are noted in the returned object's FailedTransactions field, which contains one DVRTransactionReport (p. 329) for each failed operation. Each DVRTransactionReport contains the program ID whose information could not be retrieved (in the ItemId field) and a brief text description of the failure (in the ErrMsg field). Possible error messages include: • "Invalid id type": A member of programIds is not of type ProviderExternalId. • "Id not found ": The web service is unable to find program information for the specified program.
|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=programIds
|ParamType=RemotePvrProviderExternalId
|ParamRequired=required
|ParamDescription=
}}
|Returns=
Returns a JSON object containing an ???.
'''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;">Array of [[???]] objects</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=
}}
