Note: The information returned by this request is also returned by requests offered in our Video API Version 1.1. Because future API development around this information will be focused on the Video API, we now recommend using the Video API for future application development instead of this request.
Listings/ProgramDetails returns information about a series, movie, episode, or program, and can optionally include a schedule of upcoming broadcasts of the show.
To include a schedule of upcoming broadcasts, specify the serviceid of the television service. To limit and format the returned schedule, use the following optional parameters:
|
|
|
|
|
|
Notice: The include parameter, which is documented as optional with a default value, is temporarily required due to a bug. If you want the default value for this parameter, please specify include=Program while we correct this bug.
listings/programdetails/[serviceid/]programid/info?apikey=apikey&sig=sig&locale=locale [&include=include] [&duration=duration] [&inprogress=inprogress] [&sourceid=sourceid] [&startdate=startdate] [©type=copytype] [©textformat=copytextformat] [&imagecount=imagecount] [&imageformat=imageformat] [&imageformatid=imageformatid] [&imagehorizontalresolution=imagehorizontalresolution] [&imagetype=imagetype] [&imageverticalresolution=imageverticalresolution] [&pagesize=pagesize] [&startindex=startindex] [&format=format]
Click to re-sort
Parameter | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locale | Yes | Language and country code of the television service. This is a case-sensitive combination of the ISO 639 language code, a hyphen character, and the ISO 3166 country code, as described in RFC 1766. Valid locales include:
* Includes Wales, Scotland, and Northern Ireland. Note 1: Locale determines the language of program titles and descriptions. If content is not available in that language, a fallback language is chosen according to rules shown in the Language Fallback Sequence table. Note 2: If an invalid locale is specified, en-GB will be used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
programid | Yes | A series, episode, or program identifier. You can get program IDs from responses to the following requests:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sig | Yes | A calculated, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
Express the alpha hex digits as lower case. Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copytextformat | No | Format of the description of the program, movie, or TV series: PlainText or HTML. Default is PlainText. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copytype | No | Type of description you want returned for the program, movie, or TV series. If you specify a copy type that has no content, no description is returned.
If you do not specify a copy type, the description chosen is based on category, shown below, and the first copy type in the category that is available:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | No | If you specify a serviceid to include a schedule of broadcasts of the show, duration determines the number of minutes the schedule will cover. You can specify 1 to 20160; the default is 20160 (14 days).
Note: The schedule is determined by duration, inprogress, and startdate. A duration shorter than 5 minutes may miss shows starting just before or after a half-hour point. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | No | Format of the returned data: json or xml. Default is json. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imagecount | No | If you request Image in the include parameter, imagecount determines the number of program images returned in the ProgramImages element. The default is five.
Note: Images returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageformat | No | If you request Image in the include parameter, imageformat specifies the file format of program images returned in the ProgramImages element:
Note: Images returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageformatid | No | If you request Image in the include parameter, imageformatid determines the format ID of program images returned in the ProgramImages element. Format IDs specify image sizes and file types.
The image format IDs you can use are listed in the Format IDs table in the Image category. Images are not available in all format IDs, however, and images cannot be filtered by Image Format ID 0. Note: Images returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imagehorizontalresolution | No | If you request Image in the include parameter, imagehorizontalresolution determines the exact horizontal resolution (in pixels) of the images returned in the ProgramImages element. To return images within a particular bounding box, use the imageformatid parameter instead.
Note: Images returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imagetype | No | If you request Image in the include parameter, imagetype determines the type of program images returned in the ProgramImages element.
The image types you can specify are shown in the ImageType table. This parameter is case sensitive and spaces can be specified with a plus (+) or percent20 (%20) symbol, like this: imagetype=Gallery:+Key. Note: Images returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageverticalresolution | No | If you request Image in the include parameter, imageverticalresolution determines the exact vertical resolution (in pixels) of the program images returned in the ProgramImages element. To return images within a particular bounding box, use the imageformatid parameter instead.
Note: Images returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
include | No | Data to include in the response:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inprogress | No | If you specify a serviceid to include a schedule of broadcasts of the show, inprogress determines whether shows that are in progress at startdate are included in the schedule: true or false. Default is false.
Note: The schedule is determined by duration, inprogress, and startdate. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pagesize | No | If you specify a serviceid to include a schedule of broadcasts of the show, pagesize specifies the maximum number of rows to be returned in the broadcast schedule. If fewer rows are available, the available rows are returned without error. The default is 0, which returns all rows after the startindex.
Note: You can use pagesize and startindex to paginate the returned schedule. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serviceid | No | The television service the program airs on. This must be specified if you want to return a schedule of upcoming broadcasts of the show. You can return a list of television services offered to a community with a Listings/Services request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sourceid | No | If you specify a serviceid to include a schedule of broadcasts of the show, sourceid determines the channel or channels that will appear on the schedule. You can get the source IDs for channels from responses to Listings/ServiceDetails requests.
To specify multiple channels, specify a comma-separated list, like this: sourceid=696,873,5,994. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startdate | No | If you specify a serviceid to include a schedule of broadcasts of the show, startdate determines the starting time of the schedule. The date and time must be specified as a DateTime value. The default is the time of the request.
Note: The schedule is determined by duration, inprogress, and startdate. Broadcast information is available for 14 days after the time of the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startindex | No | If you specify a serviceid to include a schedule of broadcasts of the show, startindex specifies the number of the first row you want, counting from zero as the first row in the schedule. The default is zero.
Note: You can use startindex and pagesize to paginate the returned schedule. |
Response | Type | Description |
---|---|---|
Build | String | Software build version of the API. |
EndTimestamp | DateTime | Time the server finished processing the request. |
Errors | Error [ ] | Processing errors or warnings. |
RequestId | String GUID | A generated value that identifies the request and response. |
Status | Status | Processing status, indicating whether the request was successfully processed. |
TimeStamp | DateTime | Time the server started processing the request. |
Response | Type | Description |
---|---|---|
Page | DataPage | The number of upcoming broadcasts available, and echoes of the parameters specified for pagesize and startindex. |
Program | Program | Information about the program. |
Schedule | LinearSchedule | Upcoming broadcasts of the program. |
UnsequencedEpisodePage | DataPage | The number of unsequenced episodes available. |
The following shows the response for a request for information about an episode of Two and a Half Men along with a schedule of broadcasts on Time Warner Cable in Beverly Hills, California. The response has been formatted with extra spaces and carriage returns to make it easy to read.
The following shows the response for a request for information about an episode of Two and a Half Men along with a schedule of broadcasts on Time Warner Cable in Beverly Hills, California.
Code | Name | Description |
---|---|---|
1001 | Core_MandatoryFieldMissing | A mandatory parameter is not specified. |
5001 | Core_InvalidPagingStartIndex | The startindex parameter is negative, non-numeric, or results in a negative range. |
5002 | Core_InvalidPagingPageSize | The pagesize specified is negative or non-numeric. |
502001 | Listings_InvalidCopyType | The copytype specified in the request is invalid. |
502002 | NoPrimaryProgramVariantExists | Warning: No primary program variant exists. Normally the data from the primary program ID is returned, however this program has no primary program ID.
A program may have multiple IDs, each of which is categorized as primary or variant. Variants differ in some way from the primary, such as title, format, content, language, or cast (for animated shows). |