Returns a list of the television service offerings for an area. This request provides optional arguments to limit the response to a single service or to 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.
POST /v9/listingsservice.asmx HTTP/1.1
Host: api.rovicorp.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthHeader xmlns="http://api.rovicorp.com/v9/common/types">
<UserName>string</UserName>
<Password>string</Password>
</AuthHeader>
</soap12:Header>
<soap12:Body>
<GetServices xmlns="http://api.rovicorp.com/v9/listings">
<request>
<Locale>string</Locale>
<StartDate>dateTime</StartDate>
<Duration>int</Duration>
<ServiceId>int</ServiceId>
</request>
</GetServices>
</soap12:Body>
</soap12:Envelope>
Request the television service offerings for Beverly Hills 90210.
Request the television service offerings for Moose Jaw, Saskatchewan S6H 2X1.
Request the Time Warner Cable offerings for New York, New York 10020.
| Name | Required | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Locale | Yes | String | Language and country code of the television service. This is a case-insensitive combination of the ISO 639 language code, a hyphen character, and the ISO 3166 country code, as described in RFC 1766. Valid locales include:
[1] Includes Wales, Scotland, and Northern Ireland. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ServiceId | Conditional | Integer | Database ID of the television service. Supplying a service ID in this request returns information about that television service only.
If you don't already have the service ID, use ServiceSearch instead to return the list of television services available in an area. Condition: The request must contain one of these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ServiceSearch | Conditional | GetServicesSearch | Country or postal code and, optionally, ID of a cable or satellite operator.
Condition: The request must contain one of these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ClientBatchId | No | String | A trace code to be returned in the response header so you can track a batch of requests. The code can be up to 255 characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Duration | No | Nullable Integer | Number of minutes that returned UTC offset information should cover, from 1 to 527040 (1 year). Default is 20160 (14 days).
The UTC offset that applies to a television service changes, so the response shows the start and end points of the UTC offsets during the period covered by Duration and StartDate. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StartDate | No | Nullable DateTime | Starting point of the returned UTC offset information. Default is the time of the request.
The UTC offset that applies to a television service changes, so the response shows the start and end points of the UTC offsets during the period covered by Duration and StartDate. |
| Response | Type | Description |
|---|---|---|
| Build | String | Software build version of the API. |
| ClientBatchId | String | The batch ID you supplied in the request. |
| 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. |
| Name | Type | Description |
|---|---|---|
| Services | Service [ ] | Information about the television services you requested. |
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetServicesResponse xmlns="http://api.rovicorp.com/v9/listings">
<GetServicesResult>
<Services>
<Service>
<ServiceId>int</ServiceId>
<Name>string</Name>
<City>string</City>
<Type>string</Type>
<MSO>string</MSO>
<MSOID>string</MSOID>
<SystemName>string</SystemName>
<TimeZones xsi:nil="true" />
<ServiceClass>string</ServiceClass>
</Service>
<Service>
<ServiceId>int</ServiceId>
<Name>string</Name>
<City>string</City>
<Type>string</Type>
<MSO>string</MSO>
<MSOID>string</MSOID>
<SystemName>string</SystemName>
<TimeZones xsi:nil="true" />
<ServiceClass>string</ServiceClass>
</Service>
</Services>
</GetServicesResult>
</GetServicesResponse>
</soap12:Body>
</soap12:Envelope>
| Code | Name | Description |
|---|---|---|
| 1001 | Core_MandatoryFieldMissing | A mandatory parameter is not specified. |
| 10603 | LookupService_InvalidLocale | The locale specified in the request is invalid. |