GetRecommendationItemsInList

Returns the list of recommended programs in a recommendation list and, optionally, a broadcast schedule.

This request returns a large amount of data. To speed data transmission, do the following:

• Request only data that you need to immediately display.
• Request one page of upcoming broadcast data at a time.
• Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

The response will include only the programs that occur on the dates and channel lineup you specify except that all programs in Hot Lists will be returned if you do not request a broadcast schedule. The following table shows which lists are Hot Lists and which are Filtered Lists.

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/recommendationservice.asmx HTTP/1.1
Host: services.macrovision.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>
    <GetRecommendationItemsInList xmlns="http://api.rovicorp.com/v9/recommendationservice">
      <request>
        <DeviceProfileId>string</DeviceProfileId>
        <Locale>string</Locale>
        <RecommendationListId>string</RecommendationListId>
        <SourceIds>
          <int>int</int>
          <int>int</int>
        </SourceIds>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <CopyType>int</CopyType>
        <IncludeDataType>AllWithProgramsSort or AllWithAiringsSort or ProgramsOnly or AiringsOnly or ProgramsMinimal</IncludeDataType>
        <Page>
          <PageSize>int</PageSize>
          <StartIndex>int</StartIndex>
          <TotalRows>int</TotalRows>
          <SortByColumn>
            <int>int</int>
            <int>int</int>
          </SortByColumn>
        </Page>
        <ProgramsFilters>
          <Filter>
            <ColumnNumber>int</ColumnNumber>
            <Operation>Equals or Starts or Ends or Contains or Match or GT or GEQ or LT or LEQ</Operation>
            <Expression>string</Expression>
          </Filter>
          <Filter>
            <ColumnNumber>int</ColumnNumber>
            <Operation>Equals or Starts or Ends or Contains or Match or GT or GEQ or LT or LEQ</Operation>
            <Expression>string</Expression>
          </Filter>
        </ProgramsFilters>
        <AiringsFilters>
          <Filter>
            <ColumnNumber>int</ColumnNumber>
            <Operation>Equals or Starts or Ends or Contains or Match or GT or GEQ or LT or LEQ</Operation>
            <Expression>string</Expression>
          </Filter>
          <Filter>
            <ColumnNumber>int</ColumnNumber>
            <Operation>Equals or Starts or Ends or Contains or Match or GT or GEQ or LT or LEQ</Operation>
            <Expression>string</Expression>
          </Filter>
        </AiringsFilters>
        <Image>
          <ImageUrl>string</ImageUrl>
          <ImageUseType>Logo or HeroImage or Thumbnail</ImageUseType>
          <ImageId>int</ImageId>
          <ImageTitle>string</ImageTitle>
          <ImageCaption>string</ImageCaption>
          <ObjectId>string</ObjectId>
          <ObjectType>Program or Credit or Source</ObjectType>
          <ObjectName>string</ObjectName>
          <Relevancy>boolean</Relevancy>
          <ImageCredit>string</ImageCredit>
          <ImageCreditDisplay>boolean</ImageCreditDisplay>
          <ImageCastWeight>float</ImageCastWeight>
          <ImageZoomLevel>1 or 2 or 3 or 4 or 5</ImageZoomLevel>
          <ImageHeadcount>int</ImageHeadcount>
          <ImageType>string</ImageType>
          <ImageFormat>jpg or png or gif or bmp</ImageFormat>
          <ImageHorizontalResolution>int</ImageHorizontalResolution>
          <ImageVerticalResolution>int</ImageVerticalResolution>
          <ImageMaintainAspectFlag>boolean</ImageMaintainAspectFlag>
          <ImageExpiryDateTime>dateTime</ImageExpiryDateTime>
          <LastUpdate>dateTime</LastUpdate>
          <ImageFormatId>int</ImageFormatId>
          <Orientation>string</Orientation>
          <AspectRatio>string</AspectRatio>
          <ImageOwner>string</ImageOwner>
          <ParentImageId>int</ParentImageId>
          <ProgramTitle>string</ProgramTitle>
          <MaxImageScale>float</MaxImageScale>
        </Image>
        <IncludePitchedRecommendations>string</IncludePitchedRecommendations>
        <OneAiringPerProgram>boolean</OneAiringPerProgram>
        <TitleType>int</TitleType>
        <ImageCount>int</ImageCount>
        <ImageFormatIds>
          <int>int</int>
          <int>int</int>
        </ImageFormatIds>
      </request>
    </GetRecommendationItemsInList>
  </soap12:Body>
</soap12:Envelope>

Request Example 1 »

Ask for for comedies in the Flick Pick Hot List that will be broadcast on Time Warner cable in Beverly Hills, California, over the next two weeks, and return the movies in alphabetical order with one program image each and a broadcast schedule.

Request Example 2 »

Ask for broadcasts of movies with closed captions in the Flick Pick Hot List on Time Warner cable in Beverly Hills, California, over the next two weeks, with the movies returned in alphabetical order and, for each movie, in order of broadcast time.

Request Example 3 »

Ask for detailed information about movies in the Flick Pick Hot List, including awards, video clips, and credits with images. Return the list in alphabetical order within each movie subcategory, with program images that fit in a bounding box of 500 x 500 pixels in one or both dimensions. Do not request a broadcast schedule.

Request Example 4 »

Ask for movies in the current Flick Pick Hot List in alphabetical order and for each movie include a program image that fits a 500 x 500 pixel bounding box in one or both dimensions. Include minimal program information and no broadcast schedule.

Request Parameters

Response

Response Header

Response for GetRecommendationItemsInList

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>
    <GetRecommendationItemsInListResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
      <GetRecommendationItemsInListResult>
        <Programs>
          <Program DataAvailabilityFlags="int">
            <ProgramHandle xsi:nil="true" />
            <SeriesId>string</SeriesId>
            <TvObjectId>int</TvObjectId>
            <MasterTitle>string</MasterTitle>
            <EpisodeTitle>string</EpisodeTitle>
            <CopyText>string</CopyText>
            <Runtime>int</Runtime>
            <ProgramType>string</ProgramType>
            <Category>string</Category>
            <Subcategory>string</Subcategory>
            <ReleaseYear>int</ReleaseYear>
            <Season>string</Season>
            <EpisodeNumber>string</EpisodeNumber>
            <PartNumber>int</PartNumber>
            <PartTotal>int</PartTotal>
            <StarRating>int</StarRating>
            <TVRating>string</TVRating>
            <MovieRating>string</MovieRating>
            <Subtitled>boolean</Subtitled>
            <Letterbox>boolean</Letterbox>
            <CC>boolean</CC>
            <Color>string</Color>
            <OriginalAirDate>dateTime</OriginalAirDate>
            <Syndicated>boolean</Syndicated>
            <Keywords xsi:nil="true" />
            <Credits xsi:nil="true" />
            <ProgramImages xsi:nil="true" />
            <IsVideoAvailable>boolean</IsVideoAvailable>
            <SeasonSequence>int</SeasonSequence>
            <SeriesSequence>int</SeriesSequence>
            <LastAirDate>dateTime</LastAirDate>
            <CuttingPositions xsi:nil="true" />
            <ParentalRatings xsi:nil="true" />
            <ProgramVariants xsi:nil="true" />
            <ProgramVideoClips xsi:nil="true" />
            <ProgramAwards xsi:nil="true" />
            <ProgramLanguage>string</ProgramLanguage>
            <CopyTextLanguage>string</CopyTextLanguage>
            <ShowSeasons xsi:nil="true" />
            <SubtitleLanguage>string</SubtitleLanguage>
            <SecondaryTitle>string</SecondaryTitle>
            <UnsequencedEpisodes xsi:nil="true" />
            <CopyTextSource xsi:nil="true" />
            <Streamable>int</Streamable>
          </Program>
          <Program DataAvailabilityFlags="int">
            <ProgramHandle xsi:nil="true" />
            <SeriesId>string</SeriesId>
            <TvObjectId>int</TvObjectId>
            <MasterTitle>string</MasterTitle>
            <EpisodeTitle>string</EpisodeTitle>
            <CopyText>string</CopyText>
            <Runtime>int</Runtime>
            <ProgramType>string</ProgramType>
            <Category>string</Category>
            <Subcategory>string</Subcategory>
            <ReleaseYear>int</ReleaseYear>
            <Season>string</Season>
            <EpisodeNumber>string</EpisodeNumber>
            <PartNumber>int</PartNumber>
            <PartTotal>int</PartTotal>
            <StarRating>int</StarRating>
            <TVRating>string</TVRating>
            <MovieRating>string</MovieRating>
            <Subtitled>boolean</Subtitled>
            <Letterbox>boolean</Letterbox>
            <CC>boolean</CC>
            <Color>string</Color>
            <OriginalAirDate>dateTime</OriginalAirDate>
            <Syndicated>boolean</Syndicated>
            <Keywords xsi:nil="true" />
            <Credits xsi:nil="true" />
            <ProgramImages xsi:nil="true" />
            <IsVideoAvailable>boolean</IsVideoAvailable>
            <SeasonSequence>int</SeasonSequence>
            <SeriesSequence>int</SeriesSequence>
            <LastAirDate>dateTime</LastAirDate>
            <CuttingPositions xsi:nil="true" />
            <ParentalRatings xsi:nil="true" />
            <ProgramVariants xsi:nil="true" />
            <ProgramVideoClips xsi:nil="true" />
            <ProgramAwards xsi:nil="true" />
            <ProgramLanguage>string</ProgramLanguage>
            <CopyTextLanguage>string</CopyTextLanguage>
            <ShowSeasons xsi:nil="true" />
            <SubtitleLanguage>string</SubtitleLanguage>
            <SecondaryTitle>string</SecondaryTitle>
            <UnsequencedEpisodes xsi:nil="true" />
            <CopyTextSource xsi:nil="true" />
            <Streamable>int</Streamable>
          </Program>
        </Programs>
        <Airings>
          <Airing>
            <ProgramId>int</ProgramId>
            <SeriesId>int</SeriesId>
            <InstanceId>int</InstanceId>
            <UnknownInstance>boolean</UnknownInstance>
            <TvObjectId>int</TvObjectId>
            <StartDateTime>dateTime</StartDateTime>
            <Duration>int</Duration>
            <EndDateTime>dateTime</EndDateTime>
            <AiringType>Unknown or Live or Taped or Repeat or New</AiringType>
            <ShowingType>Unknown or Premiere or Series Premiere or Season Premiere or Finale or Series Finale or Season Finale or Paid For</ShowingType>
            <ColorType>Unknown or Color or Black and White or Colorized or Color + BW Episodes or May be colorized</ColorType>
            <AiringRating>string</AiringRating>
            <CC>boolean</CC>
            <LetterBox>boolean</LetterBox>
            <Stereo>boolean</Stereo>
            <SAP>boolean</SAP>
            <Dolby>boolean</Dolby>
            <DSS>boolean</DSS>
            <HD>boolean</HD>
            <HighDefinitionLevel>HD Level Unknown or 480p or 720p or 1080i or 1080p</HighDefinitionLevel>
            <Sports>boolean</Sports>
            <DVS>boolean</DVS>
            <ServiceId>int</ServiceId>
            <SourceId>int</SourceId>
            <Channel>string</Channel>
            <ChannelType>24-Hours or Partial or Shared</ChannelType>
            <CallLetters>string</CallLetters>
            <SourceName>string</SourceName>
            <SourceLongName>string</SourceLongName>
            <TivoSupported>boolean</TivoSupported>
            <ParentNetworkId>int</ParentNetworkId>
            <IconAvailable>boolean</IconAvailable>
            <ChannelSchedules xsi:nil="true" />
            <Title>string</Title>
            <ProgramType>string</ProgramType>
          </Airing>
          <Airing>
            <ProgramId>int</ProgramId>
            <SeriesId>int</SeriesId>
            <InstanceId>int</InstanceId>
            <UnknownInstance>boolean</UnknownInstance>
            <TvObjectId>int</TvObjectId>
            <StartDateTime>dateTime</StartDateTime>
            <Duration>int</Duration>
            <EndDateTime>dateTime</EndDateTime>
            <AiringType>Unknown or Live or Taped or Repeat or New</AiringType>
            <ShowingType>Unknown or Premiere or Series Premiere or Season Premiere or Finale or Series Finale or Season Finale or Paid For</ShowingType>
            <ColorType>Unknown or Color or Black and White or Colorized or Color + BW Episodes or May be colorized</ColorType>
            <AiringRating>string</AiringRating>
            <CC>boolean</CC>
            <LetterBox>boolean</LetterBox>
            <Stereo>boolean</Stereo>
            <SAP>boolean</SAP>
            <Dolby>boolean</Dolby>
            <DSS>boolean</DSS>
            <HD>boolean</HD>
            <HighDefinitionLevel>HD Level Unknown or 480p or 720p or 1080i or 1080p</HighDefinitionLevel>
            <Sports>boolean</Sports>
            <DVS>boolean</DVS>
            <ServiceId>int</ServiceId>
            <SourceId>int</SourceId>
            <Channel>string</Channel>
            <ChannelType>24-Hours or Partial or Shared</ChannelType>
            <CallLetters>string</CallLetters>
            <SourceName>string</SourceName>
            <SourceLongName>string</SourceLongName>
            <TivoSupported>boolean</TivoSupported>
            <ParentNetworkId>int</ParentNetworkId>
            <IconAvailable>boolean</IconAvailable>
            <ChannelSchedules xsi:nil="true" />
            <Title>string</Title>
            <ProgramType>string</ProgramType>
          </Airing>
        </Airings>
        <PitchedPrograms>
          <Program DataAvailabilityFlags="int">
            <ProgramHandle xsi:nil="true" />
            <SeriesId>string</SeriesId>
            <TvObjectId>int</TvObjectId>
            <MasterTitle>string</MasterTitle>
            <EpisodeTitle>string</EpisodeTitle>
            <CopyText>string</CopyText>
            <Runtime>int</Runtime>
            <ProgramType>string</ProgramType>
            <Category>string</Category>
            <Subcategory>string</Subcategory>
            <ReleaseYear>int</ReleaseYear>
            <Season>string</Season>
            <EpisodeNumber>string</EpisodeNumber>
            <PartNumber>int</PartNumber>
            <PartTotal>int</PartTotal>
            <StarRating>int</StarRating>
            <TVRating>string</TVRating>
            <MovieRating>string</MovieRating>
            <Subtitled>boolean</Subtitled>
            <Letterbox>boolean</Letterbox>
            <CC>boolean</CC>
            <Color>string</Color>
            <OriginalAirDate>dateTime</OriginalAirDate>
            <Syndicated>boolean</Syndicated>
            <Keywords xsi:nil="true" />
            <Credits xsi:nil="true" />
            <ProgramImages xsi:nil="true" />
            <IsVideoAvailable>boolean</IsVideoAvailable>
            <SeasonSequence>int</SeasonSequence>
            <SeriesSequence>int</SeriesSequence>
            <LastAirDate>dateTime</LastAirDate>
            <CuttingPositions xsi:nil="true" />
            <ParentalRatings xsi:nil="true" />
            <ProgramVariants xsi:nil="true" />
            <ProgramVideoClips xsi:nil="true" />
            <ProgramAwards xsi:nil="true" />
            <ProgramLanguage>string</ProgramLanguage>
            <CopyTextLanguage>string</CopyTextLanguage>
            <ShowSeasons xsi:nil="true" />
            <SubtitleLanguage>string</SubtitleLanguage>
            <SecondaryTitle>string</SecondaryTitle>
            <UnsequencedEpisodes xsi:nil="true" />
            <CopyTextSource xsi:nil="true" />
            <Streamable>int</Streamable>
          </Program>
          <Program DataAvailabilityFlags="int">
            <ProgramHandle xsi:nil="true" />
            <SeriesId>string</SeriesId>
            <TvObjectId>int</TvObjectId>
            <MasterTitle>string</MasterTitle>
            <EpisodeTitle>string</EpisodeTitle>
            <CopyText>string</CopyText>
            <Runtime>int</Runtime>
            <ProgramType>string</ProgramType>
            <Category>string</Category>
            <Subcategory>string</Subcategory>
            <ReleaseYear>int</ReleaseYear>
            <Season>string</Season>
            <EpisodeNumber>string</EpisodeNumber>
            <PartNumber>int</PartNumber>
            <PartTotal>int</PartTotal>
            <StarRating>int</StarRating>
            <TVRating>string</TVRating>
            <MovieRating>string</MovieRating>
            <Subtitled>boolean</Subtitled>
            <Letterbox>boolean</Letterbox>
            <CC>boolean</CC>
            <Color>string</Color>
            <OriginalAirDate>dateTime</OriginalAirDate>
            <Syndicated>boolean</Syndicated>
            <Keywords xsi:nil="true" />
            <Credits xsi:nil="true" />
            <ProgramImages xsi:nil="true" />
            <IsVideoAvailable>boolean</IsVideoAvailable>
            <SeasonSequence>int</SeasonSequence>
            <SeriesSequence>int</SeriesSequence>
            <LastAirDate>dateTime</LastAirDate>
            <CuttingPositions xsi:nil="true" />
            <ParentalRatings xsi:nil="true" />
            <ProgramVariants xsi:nil="true" />
            <ProgramVideoClips xsi:nil="true" />
            <ProgramAwards xsi:nil="true" />
            <ProgramLanguage>string</ProgramLanguage>
            <CopyTextLanguage>string</CopyTextLanguage>
            <ShowSeasons xsi:nil="true" />
            <SubtitleLanguage>string</SubtitleLanguage>
            <SecondaryTitle>string</SecondaryTitle>
            <UnsequencedEpisodes xsi:nil="true" />
            <CopyTextSource xsi:nil="true" />
            <Streamable>int</Streamable>
          </Program>
        </PitchedPrograms>
        <Page>
          <PageSize>int</PageSize>
          <StartIndex>int</StartIndex>
          <TotalRows>int</TotalRows>
          <SortByColumn>
            <int>int</int>
            <int>int</int>
          </SortByColumn>
        </Page>
      </GetRecommendationItemsInListResult>
    </GetRecommendationItemsInListResponse>
  </soap12:Body>
</soap12:Envelope>

Error Codes

See Also

• Rovi Hot List Picks

• Common Framework
• Rovi TV Listings SOAP APIs

↑ Top