V9.ListingsService:GetLinearSchedule

Jump to: navigation, search

GetLinearSchedule

Returns up to four hours of TV listings during the next two weeks with detailed program information. This request provides an optional argument to filter the list of channels returned.

This request returns compelling information not available with GetGridSchedule:

  • Program images
  • Program descriptions
  • Showing types, which note series and season premieres and finales

Unlike GetGridSchedule, this request does not return channel logos.

This request returns a large amount of data. To speed data transmission, request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

The following is a sample SOAP 1.2 request with placeholders. Your application development environment needs to replace the placeholders with actual values.
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>
    <GetLinearSchedule xmlns="http://api.rovicorp.com/v9/listings">
      <request>
        <Locale>string</Locale>
        <ServiceId>int</ServiceId>
        <StartDate>dateTime</StartDate>
        <Duration>int</Duration>
        <InProgress>boolean</InProgress>
        <OneAiringPerSourceId>boolean</OneAiringPerSourceId>
        <TitleType>int</TitleType>
        <SourceFilter>
          <Sources>
            <SourceId>int</SourceId>
            <SourceId>int</SourceId>
          </Sources>
          <Include>HD or PPV or Music</Include>
          <Excludes>
            <Exclude>HD or PPV or Music</Exclude>
            <Exclude>HD or PPV or Music</Exclude>
          </Excludes>
        </SourceFilter>
        <SourceIds>
          <SourceId>int</SourceId>
          <SourceId>int</SourceId>
        </SourceIds>
        <DvbTriplets>
          <DvbTriplet>
            <ServiceIds>string</ServiceIds>
            <TsId>string</TsId>
            <OnId>string</OnId>
          </DvbTriplet>
          <DvbTriplet>
            <ServiceIds>string</ServiceIds>
            <TsId>string</TsId>
            <OnId>string</OnId>
          </DvbTriplet>
        </DvbTriplets>
        <ProgramImageFormatIds>
          <int>36</int>
          <int>37</int>
        </ProgramImageFormatIds>
      </request>
    </GetLinearSchedule>
  </soap12:Body>
</soap12:Envelope>

Request Example 1 »

Request the schedule for Time Warner Cable in Beverly Hills, California, over the next 60 minutes and include a URL to an image for each program.

Request Example 2 »

Request a schedule starting at 8:00 PM for the sports stations on Time Warner in southern Manhattan, except for the Pay-Per-View stations.

Request Example 3 »

Request the programs being shown by three television sources.

Request Parameters

NameRequiredTypeDescription
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:
  • da-DK
Danish, Denmark
  • nl-BE
Dutch, Belgium
  • nl-NL
Dutch, Netherlands
  • en-BM
English (US), Bermuda
  • en-CA
English (US), Canada
  • en-IE
English (US), Ireland
  • en-JM
English (US), Jamaica
  • en-GB
English (UK), United Kingdom[1]
  • en-US
English (US), United States
  • fi-FI
Finnish, Finland
  • fl-BE
Flemish, Belgium
  • fr-BE
French, Belgium
  • fr-CA
French, Canada
  • fr-FR
French, France
  • fr-LU
French, Luxembourg
  • fr-CH
French, Switzerland
  • de-AT
German, Austria
  • de-DE
German, Germany
  • de-LU
German, Luxembourg
  • de-CH
German, Switzerland
  • it-IT
Italian, Italy
  • it-CH
Italian, Switzerland
  • no-NO
Norwegian, Norway
  • pl-PL
Polish, Poland
  • pt-BR
Portuguese, Brazil
  • pt-PT
Portuguese, Portugal
  • es-AR
Spanish, Argentina
  • es-BO
Spanish, Bolivia
  • es-CL
Spanish, Chile
  • es-CO
Spanish, Colombia
  • es-CR
Spanish, Costa Rica
  • es-DO
Spanish, Dominican Republic
  • es-EC
Spanish, Ecuador
  • es-SV
Spanish, El Salvador
  • es-GT
Spanish, Guatemala
  • es-HN
Spanish, Honduras
  • es-MX
Spanish, Mexico
  • es-NI
Spanish, Nicaragua
  • es-PA
Spanish, Panama
  • es-PE
Spanish, Peru
  • es-ES
Spanish, Spain
  • es-US
Spanish, United States
  • es-VE
Spanish, Venezuela
  • sv-SE
Swedish, Sweden

[1] 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.

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 of schedule information to be returned, from 1 to 240 (4 hours). Default is 1.

Note: The schedule is determined by Duration, InProgress, and StartDate. The start can be anytime from the time of the request up to two weeks in the future. A duration shorter than 5 minutes may miss shows starting just before or after a half-hour point.

DvbTriplets No DvbTriplet [ ] Digital Video Broadcasting (DVB) identifier, a commonly used identifier for European cable providers, satellite providers, and regional digital networks.

Note: this property is now deprecated and will be removed in a future release.

InProgress No Nullable Boolean Whether shows in progress at the time specified for StartDate are included in the results. Default is false.

Note: The schedule is determined by StartDate, Duration and InProgress.

OneAiringPerSourceId No Nullable Boolean Whether to return only one program for the Source IDs listed in the SourceIds element: true or false. Default is false.

Note: Setting this parameter to true overrides the InProgress parameter.

ProgramImageFormatIds No Integer [ ] First and second choice for the format ID of images to be returned with programs. A URL to an image of the first choice is returned if an image with that format ID is available, otherwise the URL will be to the second choice. Note: Specifying Format ID 0 returns no images.

To return the maximum number of images, specify one format ID in the Image category and the other format ID in the Logo category.

If not specified, URLs to program images are not returned.

ServiceId No Integer Database ID of the television service. To get the service ID for a television service, request the list of services in the area with GetServices.
SourceFilter No SourceFilter [ ] Filter for the channels in the ServiceID area that are returned in the response. You specify the channel source IDs to be returned in the response and any additional filters that select or exclude channels from that list.
SourceIds No Integer [ ] Channel sources to be returned in the response, specified by source ID. Returns programs for those channel sources, but does not report the channels or service IDs the programs appear on. Use of this parameter overrides any ServiceId or SourceFilter specified.

You can get the source IDs for channels from responses to the following requests:

StartDate No Nullable DateTime Start of the time period covered by the schedule, which can be anytime from the time of the request to two weeks in the future. Default is the time of the request.

Note: The schedule is determined by StartDate, Duration, and InProgress.

TitleType No Nullable TitleType Type of title to return for each program. Most programs do not carry all title types, so we recommend using the default unless another type is required. If a program does not have the type specified, the Title element is not returned.

Response

Response Header

ResponseTypeDescription
BuildStringSoftware build version of the API.
ClientBatchIdStringThe batch ID you supplied in the request.
EndTimestampDateTimeTime the server finished processing the request.
ErrorsError [ ]Processing errors or warnings.
RequestIdString GUIDA generated value that identifies the request and response.
StatusStatusProcessing status, indicating whether the request was successfully processed.
TimeStampDateTimeTime the server started processing the request.

Response for GetLinearSchedule

NameTypeDescription
Schedule LinearSchedule The schedule of programs on each channel.

Response Example

The following is a sample SOAP 1.2 response with placeholders that show the type of content returned in an actual response.
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>
    <GetLinearScheduleResponse xmlns="http://api.rovicorp.com/v9/listings">
      <GetLinearScheduleResult>
        <Schedule>
          <Locale>string</Locale>
          <ServiceId>int</ServiceId>
          <Name>string</Name>
          <ServiceType>string</ServiceType>
          <StartDate>dateTime</StartDate>
          <Duration>int</Duration>
          <TimeZones>
            <TimeZoneInfo xsi:nil="true" />
            <TimeZoneInfo xsi:nil="true" />
          </TimeZones>
          <Airings>
            <ListingsAiring xsi:nil="true" />
            <ListingsAiring xsi:nil="true" />
          </Airings>
        </Schedule>
      </GetLinearScheduleResult>
    </GetLinearScheduleResponse>
  </soap12:Body>
</soap12:Envelope>

Error Codes

CodeNameDescription
1001 Core_MandatoryFieldMissing A mandatory parameter is not specified.
10603 LookupService_InvalidLocale The locale specified in the request is invalid.

See Also

↑ Top

 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.ListingsService:GetLinearSchedule"
Personal tools