Returns the channel lineup offered by a television service, plus information about the source of programming on a channel.
This request requires the service ID of the television service. You can get service IDs from responses to a Listings/Services request.
listings/servicedetails/serviceid/serviceid/info?apikey=apikey&sig=sig&locale=locale [&includechannelimages=includechannelimages] [&imageformatid=imageformatid] [&imagehorizontalresolution=imagehorizontalresolution] [&imageverticalresolution=imageverticalresolution] [&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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serviceid | Yes | Service ID of the television service. To get the service ID for the television service, request the list of services in the area with Listings/Services. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | No | Format of the returned data: json or xml. Default is json. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageformatid | No | If you set includechannelimages to true, imageformatid determines the size and file format of channel logos returned in the response. Choose the ID from the Format ID table.
Note: Logos may not be available in all format IDs, and logos returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imagehorizontalresolution | No | If you set includechannelimages to true, imagehorizontalresolution determines the exact horizontal resolution of the images returned in the response (in pixels). To return images within a particular bounding box, use the imageformatid parameter instead.
Note: Logos may not be available in all resolutions, and logos returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageverticalresolution | No | If you set includechannelimages to true, imageverticalresolution determines the exact vertical resolution of the images returned in the response (in pixels). To return images within a particular bounding box, use the imageformatid parameter instead.
Note: Logos may not be available in all resolutions, and logos returned meet all of the image filters specified in the request:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
includechannelimages | No | Whether to include channel logos in the response: true or false. Default is false.
Note: Some channels do not have logos. For those channels, display call letters instead. |
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 |
---|---|---|
ChannelLineup | ChannelLineup | Information about the television service and the channels provided by the service. |
Here's the response to Request Example 1, which asks for the channel lineup for Los Angeles Area broadcast channels. The response has been edited to reduce the length and formatted with extra spaces and carriage returns to make it easy to read.
Here's an XML response to Request Example 1, which asks for the channel lineup for Los Angeles Area broadcast channels. The response has been edited to reduce the length.
Code | Name | Description |
---|---|---|
1001 | Core_MandatoryFieldMissing | A mandatory parameter is not specified. |
10603 | LookupService_InvalidLocale | The locale specified in the request is invalid. |