Returns a list of the television service offerings for an area. This request provides an optional argument to limit the response to just the services of a single cable or satellite operator.
Your application should start with this request to get the service ID of the television service you want.
listings/services/postalcode/postalcode/info?apikey=apikey&sig=sig&locale=locale&countrycode=countrycode [&msoid=msoid] [&format=format]
Click to re-sort
Parameter | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
countrycode | Yes | Country served by the television service, stated as the case-sensitive, two-letter country code:
* Includes Wales, Scotland, and Northern Ireland. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
postalcode | Yes | For the U.S. and Canada, the postal code of the coverage area. For other country codes, specify zero. Replace a space in a postal code with a plus (+) or percent20 (%20) symbol. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msoid | No | ID of a cable or satellite operator. Specify an MSO ID to return just the services offered by that operator. Not useful for national or broadcast services.
If you don't know the MSO ID for an operator, first request the list of services in an area and then look through the response for that operator. |
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 |
---|---|---|
Services | Service [ ] | The list of television service offerings. |
Here's the response to Request Example 1, which asks for the television service offerings for Beverly Hills 90210. 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 the response to Request Example 2, which adds the MSO ID parameter to see just the services offered by Dish Network.
Code | Name | Description |
---|---|---|
1001 | Core_MandatoryFieldMissing | A mandatory parameter is not specified. |
10603 | LookupService_InvalidLocale | The locale specified in the request is invalid. |