V9.RecommendationService:GetRecommendationItemsInListExamples

Jump to: navigation, search

GetRecommendationItemsInList Request Examples

Here are some examples that show how you can use GetRecommendationItemsInList.

« GetRecommendationItemsInList

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.

  • Specify en-US in the Locale element.
  • Specify the ID of the recommendation list in the RecommendationListId element.
  • Specify the service ID of the television service provider in the ServiceId element. You can get service IDs with a GetServices request.
  • Specify the beginning of the broadcast schedule in the StartDate element.
  • Specify the end of the broadcast schedule in the EndDate element.
  • Specify 0 in the CopyType element to use the default movie descriptions.
  • Specify AllWithProgramsSort in the IncludeDataType element to return program and schedule information and sort the returned Program elements.
  • Specify a PageSize of 2 for this example to return only the first page of the 6 results.
  • Specify 4 as the first sort in the SortByColumn element to sort by the returned MasterTitle element, the fourth element in returned Program objects.
  • In the ProgramFilters object, specify 10 in the ColumnNumber element to apply a filter to Subcategory, the tenth element in returned Program objects, to return only movies in the comedy subcategory. Specify Contains in the Operation element and comedy in the Expression element.
  • Specify true in the IncludePitchedRecommendations element to add movies that have been considered for recommendation.
  • Specify 1 in the ImageCount element to return the first image associated with each movie, if available. The default is five different sizes of the same image.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:rec="http://api.rovicorp.com/v9/recommendationservice">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <rec:GetRecommendationItemsInList>
         <rec:request>
            <rec:Locale>en-US</rec:Locale>
            <rec:RecommendationListId>68bd6410-8229-4666-ad68-211c966aef93</rec:RecommendationListId>
            <rec:ServiceId>360861</rec:ServiceId>
            <rec:StartDate>2012-03-27T00:00:00.000-07:00</rec:StartDate>
            <rec:EndDate>2012-04-10T00:00:00.000-07:00</rec:EndDate>
            <rec:CopyType>0</rec:CopyType>
            <rec:IncludeDataType>AllWithProgramsSort</rec:IncludeDataType>
            <rec:Page>
               <rec:PageSize>2</rec:PageSize>
               <rec:StartIndex>0</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
               <rec:SortByColumn>
                  <rec:int>4</rec:int>
               </rec:SortByColumn>
            </rec:Page>
            <rec:ProgramsFilters>
               <rec:Filter>
                  <rec:ColumnNumber>10</rec:ColumnNumber>
                  <rec:Operation>Contains</rec:Operation>
                  <rec:Expression>comedy</rec:Expression>
               </rec:Filter>
            </rec:ProgramsFilters>
            <rec:IncludePitchedRecommendations>true</rec:IncludePitchedRecommendations>
            <rec:ImageCount>1</rec:ImageCount>
         </rec:request>
      </rec:GetRecommendationItemsInList>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but six Airing elements have been deleted to reduce the length.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetRecommendationItemsInListResponse xmlns="http://services.macrovision.com/v9/recommendationservice">
         <GetRecommendationItemsInListResult>
            <RequestId xmlns="http://services.macrovision.com/v9/common/types">5f487bb9-fee3-4686-8f8a-45a914e2feb4</RequestId>
            <TimeStamp xmlns="http://services.macrovision.com/v9/common/types">2012-03-28T03:16:30.154Z</TimeStamp>
            <Status xmlns="http://services.macrovision.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://services.macrovision.com/v9/common/types"/>
            <EndTimestamp xmlns="http://services.macrovision.com/v9/common/types">2012-03-28T03:16:30.295Z</EndTimestamp>
            <Build xmlns="http://services.macrovision.com/v9/common/types">CPS Phase v9 Build 9.9.3.1</Build>
            <Programs>
               <Program DataAvailabilityFlags="95">
                  <ProgramHandle>
                     <Id>18734135</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>Bridesmaids</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText>A devoted maid of honor (Kristen Wiig) attempts to plan a dream wedding for her best friend, despite her own romantic and financial problems.</CopyText>
                  <Runtime>0</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>comedy</Subcategory>
                  <ReleaseYear>2011</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>0</StarRating>
                  <TVRating>None</TVRating>
                  <MovieRating>R</MovieRating>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>false</CC>
                  <Color/>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords/>
                  <Credits/>
                  <ProgramImages/>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <ParentalRatings/>
                  <ProgramVariants/>
                  <ProgramVideoClips/>
                  <ProgramAwards/>
                  <ShowSeasons/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
               <Program DataAvailabilityFlags="83">
                  <ProgramHandle>
                     <Id>1960607</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>Celebrity</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText>Woody Allen's caustic media satire about an entertainment journalist (Kenneth Branagh). Judy Davis, Joe Mantegna, Leonardo DiCaprio.</CopyText>
                  <Runtime>0</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>comedy</Subcategory>
                  <ReleaseYear>1998</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>2</StarRating>
                  <TVRating>None</TVRating>
                  <MovieRating>R</MovieRating>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>false</CC>
                  <Color/>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords/>
                  <Credits/>
                  <ProgramImages/>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <ParentalRatings/>
                  <ProgramVariants/>
                  <ProgramVideoClips/>
                  <ProgramAwards/>
                  <ShowSeasons/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
               <Program DataAvailabilityFlags="127">
                  <ProgramHandle>
                     <Id>3047198</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>Miss Congeniality</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText>An FBI agent (Sandra Bullock) infiltrates a beauty pageant. Appealing but implausible. Michael Caine, Benjamin Bratt.</CopyText>
                  <Runtime>0</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>comedy</Subcategory>
                  <ReleaseYear>2000</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>2</StarRating>
                  <TVRating>None</TVRating>
                  <MovieRating>PG-13</MovieRating>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>false</CC>
                  <Color/>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords/>
                  <Credits/>
                  <ProgramImages>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>7531092</ImageId>
                        <ImageTitle>Miss Congeniality</ImageTitle>
                        <ImageCaption>Poster Art</ImageCaption>
                        <ObjectId>3047198</ObjectId>
                        <ObjectType>Program</ObjectType>
                        <ObjectName>Miss Congeniality</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight xsi:nil="true"/>
                        <ImageZoomLevel>3</ImageZoomLevel>
                        <ImageHeadcount xsi:nil="true"/>
                        <ImageType>Poster Art</ImageType>
                        <ImageFormat xsi:nil="true"/>
                        <ImageHorizontalResolution>1536</ImageHorizontalResolution>
                        <ImageVerticalResolution>2048</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2012-01-13T16:53:40.13Z</LastUpdate>
                        <ImageFormatId>0</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>3:4</AspectRatio>
                        <ParentImageId>16959366</ParentImageId>
                        <MaxImageScale>100</MaxImageScale>
                     </Image>
                  </ProgramImages>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <ParentalRatings/>
                  <ProgramVariants/>
                  <ProgramVideoClips/>
                  <ProgramAwards/>
                  <ShowSeasons/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
            </Programs>
            <Airings>
               <Airing>
                  <ProgramId>1960607</ProgramId>
                  <SeriesId>0</SeriesId>
                  <InstanceId>0</InstanceId>
                  <UnknownInstance>false</UnknownInstance>
                  <TvObjectId>0</TvObjectId>
                  <StartDateTime>2012-04-08T22:45:00Z</StartDateTime>
                  <Duration>113</Duration>
                  <EndDateTime>2012-04-09T00:38:00Z</EndDateTime>
                  <AiringType>Unknown</AiringType>
                  <ShowingType>Unknown</ShowingType>
                  <ColorType>Black and White</ColorType>
                  <AiringRating>None</AiringRating>
                  <CC>true</CC>
                  <LetterBox>false</LetterBox>
                  <Stereo>true</Stereo>
                  <SAP>false</SAP>
                  <Dolby>false</Dolby>
                  <DSS>false</DSS>
                  <HD>false</HD>
                  <HighDefinitionLevel>HD Level Unknown</HighDefinitionLevel>
                  <Sports>false</Sports>
                  <DVS>false</DVS>
                  <ServiceId>360861</ServiceId>
                  <SourceId>2525</SourceId>
                  <Channel>22</Channel>
                  <ChannelType>24-Hours</ChannelType>
                  <CallLetters>TMC</CallLetters>
                  <SourceName>TMC</SourceName>
                  <SourceLongName>The Movie Channel (West)</SourceLongName>
                  <TivoSupported>true</TivoSupported>
                  <ParentNetworkId>0</ParentNetworkId>
                  <IconAvailable>true</IconAvailable>
                  <ChannelSchedules/>
                  <Title>Celebrity</Title>
                  <ProgramType>Movie</ProgramType>
               </Airing>
               <Airing>
                  <ProgramId>3047198</ProgramId>
                  <SeriesId>0</SeriesId>
                  <InstanceId>0</InstanceId>
                  <UnknownInstance>false</UnknownInstance>
                  <TvObjectId>0</TvObjectId>
                  <StartDateTime>2012-03-30T01:00:00Z</StartDateTime>
                  <Duration>150</Duration>
                  <EndDateTime>2012-03-30T03:30:00Z</EndDateTime>
                  <AiringType>Unknown</AiringType>
                  <ShowingType>Unknown</ShowingType>
                  <ColorType>Color</ColorType>
                  <AiringRating>TV-14@DLV</AiringRating>
                  <CC>true</CC>
                  <LetterBox>false</LetterBox>
                  <Stereo>true</Stereo>
                  <SAP>false</SAP>
                  <Dolby>false</Dolby>
                  <DSS>false</DSS>
                  <HD>false</HD>
                  <HighDefinitionLevel>HD Level Unknown</HighDefinitionLevel>
                  <Sports>false</Sports>
                  <DVS>false</DVS>
                  <ServiceId>360861</ServiceId>
                  <SourceId>2519</SourceId>
                  <Channel>60</Channel>
                  <ChannelType>24-Hours</ChannelType>
                  <CallLetters>ABCFAM</CallLetters>
                  <SourceName>ABCFAM</SourceName>
                  <SourceLongName>ABC Family Channel (West)</SourceLongName>
                  <TivoSupported>true</TivoSupported>
                  <ParentNetworkId>0</ParentNetworkId>
                  <IconAvailable>true</IconAvailable>
                  <ChannelSchedules/>
                  <Title>Miss Congeniality</Title>
                  <ProgramType>Movie</ProgramType>
               </Airing>
               <Airing>
                  <ProgramId>3047198</ProgramId>
                  <SeriesId>0</SeriesId>
                  <InstanceId>0</InstanceId>
                  <UnknownInstance>false</UnknownInstance>
                  <TvObjectId>0</TvObjectId>
                  <StartDateTime>2012-03-30T22:00:00Z</StartDateTime>
                  <Duration>150</Duration>
                  <EndDateTime>2012-03-31T00:30:00Z</EndDateTime>
                  <AiringType>Unknown</AiringType>
                  <ShowingType>Unknown</ShowingType>
                  <ColorType>Color</ColorType>
                  <AiringRating>TV-14@DLV</AiringRating>
                  <CC>true</CC>
                  <LetterBox>false</LetterBox>
                  <Stereo>true</Stereo>
                  <SAP>false</SAP>
                  <Dolby>false</Dolby>
                  <DSS>false</DSS>
                  <HD>false</HD>
                  <HighDefinitionLevel>HD Level Unknown</HighDefinitionLevel>
                  <Sports>false</Sports>
                  <DVS>false</DVS>
                  <ServiceId>360861</ServiceId>
                  <SourceId>2519</SourceId>
                  <Channel>60</Channel>
                  <ChannelType>24-Hours</ChannelType>
                  <CallLetters>ABCFAM</CallLetters>
                  <SourceName>ABCFAM</SourceName>
                  <SourceLongName>ABC Family Channel (West)</SourceLongName>
                  <TivoSupported>true</TivoSupported>
                  <ParentNetworkId>0</ParentNetworkId>
                  <IconAvailable>true</IconAvailable>
                  <ChannelSchedules/>
                  <Title>Miss Congeniality</Title>
                  <ProgramType>Movie</ProgramType>
               </Airing>
            </Airings>
            <PitchedPrograms>
               <Program DataAvailabilityFlags="127">
                  <ProgramHandle>
                     <Id>3047198</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>Miss Congeniality</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText>An FBI agent (Sandra Bullock) infiltrates a beauty pageant. Appealing but implausible. Michael Caine, Benjamin Bratt.</CopyText>
                  <Runtime>0</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>comedy</Subcategory>
                  <ReleaseYear>2000</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>2</StarRating>
                  <TVRating>None</TVRating>
                  <MovieRating>PG-13</MovieRating>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>false</CC>
                  <Color/>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords/>
                  <Credits/>
                  <ProgramImages>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>7531092</ImageId>
                        <ImageTitle>Miss Congeniality</ImageTitle>
                        <ImageCaption>Poster Art</ImageCaption>
                        <ObjectId>3047198</ObjectId>
                        <ObjectType>Program</ObjectType>
                        <ObjectName>Miss Congeniality</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight xsi:nil="true"/>
                        <ImageZoomLevel>3</ImageZoomLevel>
                        <ImageHeadcount xsi:nil="true"/>
                        <ImageType>Poster Art</ImageType>
                        <ImageFormat xsi:nil="true"/>
                        <ImageHorizontalResolution>1536</ImageHorizontalResolution>
                        <ImageVerticalResolution>2048</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2012-01-13T16:53:40.13Z</LastUpdate>
                        <ImageFormatId>0</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>3:4</AspectRatio>
                        <ParentImageId>16959366</ParentImageId>
                        <MaxImageScale>100</MaxImageScale>
                     </Image>
                  </ProgramImages>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <ParentalRatings/>
                  <ProgramVariants/>
                  <ProgramVideoClips/>
                  <ProgramAwards/>
                  <ShowSeasons/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
            </PitchedPrograms>
            <Page>
               <PageSize>2</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>6</TotalRows>
               <SortByColumn>
                  <int>4</int>
               </SortByColumn>
            </Page>
         </GetRecommendationItemsInListResult>
      </GetRecommendationItemsInListResponse>
   </soap:Body>
</soap:Envelope>

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.
  • Specify en-US in the Locale element.
  • Specify the ID of the recommendation list in the RecommendationListId element.
  • Specify 360861 in the ServiceId element. You can get the service ID for a television provider with a GetServices request.
  • Specify the beginning of the broadcast schedule in the StartDate element.
  • Specify the end of the broadcast schedule in the EndDate element.
  • Specify 0 in the CopyType element to use the default copy type.
  • Specify AiringsOnly in the IncludeDataType element to return only the broadcast schedule, not program information.
  • Specify a PageSize of 2 and a StartIndex of 0 to return only the first two results for this example.
  • To sort by the returned Title and StartDateTime elements, specify 34 in the SortByColumn object as the first sort and 6 as the second, their positions in the returned Airing objects.
  • To include only movies with closed captions, add the AiringsFilters object. Specify 13 in the ColumnNumber element to apply a filter to CC, the 13th element in the returned Airing objects. Specify Equals in the Operation element and true in the Expression element.
  • Specify true in the IncludePitchedRecommendations element to include movies that are being considered for recommendation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:rec="http://api.rovicorp.com/v9/recommendationservice">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <rec:GetRecommendationItemsInList>
         <rec:request>
            <rec:Locale>en-US</rec:Locale>
            <rec:RecommendationListId>68bd6410-8229-4666-ad68-211c966aef93</rec:RecommendationListId>
            <rec:ServiceId>360861</rec:ServiceId>
            <rec:StartDate>2011-06-18T18:00:00.000-07:00</rec:StartDate>
            <rec:EndDate>2011-07-02T18:00:00.000-07:00</rec:EndDate>
            <rec:CopyType>0</rec:CopyType>
            <rec:IncludeDataType>AiringsOnly</rec:IncludeDataType>
            <rec:Page>
               <rec:PageSize>2</rec:PageSize>
               <rec:StartIndex>0</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
               <rec:SortByColumn>
                  <rec:int>34</rec:int>
                  <rec:int>6</rec:int>
               </rec:SortByColumn>
            </rec:Page>
            <rec:ProgramsFilters>
               <rec:Filter>
                  <rec:ColumnNumber>13</rec:ColumnNumber>
                  <rec:Operation>Equals</rec:Operation>
                  <rec:Expression>true</rec:Expression>
               </rec:Filter>
            </rec:ProgramsFilters>
            <rec:IncludePitchedRecommendations>true</rec:IncludePitchedRecommendations>
         </rec:request>
      </rec:GetRecommendationItemsInList>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, returning 2 movies on the first page of 78 results.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetRecommendationItemsInListResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
         <GetRecommendationItemsInListResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">0cfdf636-09ec-45f5-be66-f63a199f8c1e</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-17T20:57:06.52Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-17T20:57:06.598Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Programs/>
            <Airings>
               <Airing>
                  <ProgramId>208664</ProgramId>
                  <SeriesId>0</SeriesId>
                  <InstanceId>0</InstanceId>
                  <UnknownInstance>false</UnknownInstance>
                  <TvObjectId>0</TvObjectId>
                  <StartDateTime>2011-06-24T00:00:00Z</StartDateTime>
                  <Duration>180</Duration>
                  <EndDateTime>2011-06-24T03:00:00Z</EndDateTime>
                  <AiringType>Unknown</AiringType>
                  <ShowingType>Unknown</ShowingType>
                  <ColorType>Color</ColorType>
                  <AiringRating>TV-PG@DLV</AiringRating>
                  <CC>true</CC>
                  <LetterBox>false</LetterBox>
                  <Stereo>true</Stereo>
                  <SAP>false</SAP>
                  <Dolby>false</Dolby>
                  <DSS>false</DSS>
                  <HD>false</HD>
                  <HighDefinitionLevel>HD Level Unknown</HighDefinitionLevel>
                  <Sports>false</Sports>
                  <DVS>false</DVS>
                  <ServiceId>360861</ServiceId>
                  <SourceId>433</SourceId>
                  <Channel>38</Channel>
                  <ChannelType>24-Hours</ChannelType>
                  <CallLetters>AMC</CallLetters>
                  <SourceName>AMC</SourceName>
                  <SourceLongName>American Movie Classics (East)</SourceLongName>
                  <TivoSupported>true</TivoSupported>
                  <ParentNetworkId>0</ParentNetworkId>
                  <IconAvailable>true</IconAvailable>
                  <ChannelSchedules/>
                  <Title>A League Of Their Own</Title>
                  <ProgramType>Movie</ProgramType>
               </Airing>
               <Airing>
                  <ProgramId>208664</ProgramId>
                  <SeriesId>0</SeriesId>
                  <InstanceId>0</InstanceId>
                  <UnknownInstance>false</UnknownInstance>
                  <TvObjectId>0</TvObjectId>
                  <StartDateTime>2011-06-24T04:02:00Z</StartDateTime>
                  <Duration>178</Duration>
                  <EndDateTime>2011-06-24T07:00:00Z</EndDateTime>
                  <AiringType>Unknown</AiringType>
                  <ShowingType>Unknown</ShowingType>
                  <ColorType>Color</ColorType>
                  <AiringRating>TV-PG@DLV</AiringRating>
                  <CC>true</CC>
                  <LetterBox>false</LetterBox>
                  <Stereo>true</Stereo>
                  <SAP>false</SAP>
                  <Dolby>false</Dolby>
                  <DSS>false</DSS>
                  <HD>false</HD>
                  <HighDefinitionLevel>HD Level Unknown</HighDefinitionLevel>
                  <Sports>false</Sports>
                  <DVS>false</DVS>
                  <ServiceId>360861</ServiceId>
                  <SourceId>433</SourceId>
                  <Channel>38</Channel>
                  <ChannelType>24-Hours</ChannelType>
                  <CallLetters>AMC</CallLetters>
                  <SourceName>AMC</SourceName>
                  <SourceLongName>American Movie Classics (East)</SourceLongName>
                  <TivoSupported>true</TivoSupported>
                  <ParentNetworkId>0</ParentNetworkId>
                  <IconAvailable>true</IconAvailable>
                  <ChannelSchedules/>
                  <Title>A League Of Their Own</Title>
                  <ProgramType>Movie</ProgramType>
               </Airing>
            </Airings>
            <Page>
               <PageSize>2</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>78</TotalRows>
               <SortByColumn>
                  <int>34</int>
                  <int>6</int>
               </SortByColumn>
            </Page>
         </GetRecommendationItemsInListResult>
      </GetRecommendationItemsInListResponse>
   </soap:Body>
</soap:Envelope>

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.
  • Specify en-US in the Locale element.
  • Specify the ID of the recommendation list in the RecommendationListId element.
  • Specify the current time in the StartDate element.
  • Specify the current time in the EndDate element.
  • Specify 0 in the CopyType element to use the default copy type.
  • Specify ProgramsOnly in the IncludeDataType element to return only program information.
  • Specify a PageSize of 1 and a StartIndex of 1 to return only the second result for this example.
  • To sort by the movie Subcategory and MasterTitle elements, specify 10 in the SortByColumn object as the first sort and 4 as the second, their positions in the returned Airing objects.
  • In the Image object, specify 16 in the ImageFormatId element to return program images that fit in a bounding box of 500 by 500 pixel in one or both dimensions.
  • Specify 1 in the ImageCount element to include just one program image.
  • Specify true in the IncludePitchedRecommendations element to include movies that are being considered for recommendation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:rec="http://api.rovicorp.com/v9/recommendationservice">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <rec:GetRecommendationItemsInList>
         <rec:request>
            <rec:Locale>en-US</rec:Locale>
            <rec:RecommendationListId>68bd6410-8229-4666-ad68-211c966aef93</rec:RecommendationListId>
            <rec:MSGridId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <rec:StartDate>2011-06-17T18:00:00.000-07:00</rec:StartDate>
            <rec:EndDate>2011-06-17T18:00:00.000-07:00</rec:EndDate>
            <rec:CopyType>0</rec:CopyType>
            <rec:IncludeDataType>ProgramsOnly</rec:IncludeDataType>
            <rec:Page>
               <rec:PageSize>1</rec:PageSize>
               <rec:StartIndex>1</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
               <rec:SortByColumn>
                  <rec:int>10</rec:int>
                  <rec:int>4</rec:int>
               </rec:SortByColumn>
            </rec:Page>
            <rec:Image>
               <rec:ImageFormatId>16</rec:ImageFormatId>
            </rec:Image>
            <rec:IncludePitchedRecommendations>true</rec:IncludePitchedRecommendations>
            <rec:ImageCount>1</rec:ImageCount>
         </rec:request>
      </rec:GetRecommendationItemsInList>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but 188 elements have been deleted to reduce the length:

  • 110 ProgramCredit elements
  • 36 ProgramVariant elements
  • 20 VideoClip elements
  • 22 Award elements

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetRecommendationItemsInListResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
         <GetRecommendationItemsInListResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">5f7fcd91-e470-4eec-b579-00eebc6c86ec</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-17T02:55:59.249Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-17T02:55:59.359Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Programs>
               <Program DataAvailabilityFlags="127">
                  <ProgramHandle>
                     <Id>10409708</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>Inception</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText>Dom Cobb (Leonardo DiCaprio) steals ideas from people while they sleep, but he is hired for a job in which he must plant an idea into someone's dream, rather than take one away. Directed by Christopher Nolan.</CopyText>
                  <Runtime>148</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>action/adventure</Subcategory>
                  <ReleaseYear>2010</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>0</StarRating>
                  <TVRating>None</TVRating>
                  <MovieRating>PG-13</MovieRating>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>true</CC>
                  <Color>Color</Color>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords>
                     <string>acción/aventura</string>
                     <string>Actie/ Avontuur</string>
                     <string>action / aventure</string>
                     <string>action/adventure</string>
                  </Keywords>
                  <Credits>
                     <ProgramCredit DataAvailabilityFlags="12">
                        <ProgramHandle>
                           <Id>10409708</Id>
                           <ProviderId>2</ProviderId>
                        </ProgramHandle>
                        <CreditHandle>
                           <Id>100973</Id>
                           <ProviderId>2</ProviderId>
                        </CreditHandle>
                        <CreditName>Leonardo DiCaprio</CreditName>
                        <PartName>Cobb</PartName>
                        <CreditType>Actor</CreditType>
                        <Sequence>1</Sequence>
                        <Image>
                           <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                           <ImageUseType xsi:nil="true"/>
                           <ImageId>914314</ImageId>
                           <ImageTitle>Leonardo DiCaprio</ImageTitle>
                           <ImageCaption>Actor Leonardo DiCaprio attends the premiere of the movie 'No Country For Old Men' at the Palais des Festivals during the 60th International Cannes Film Festival on May 19, 2007, in Cannes, France.</ImageCaption>
                           <ObjectId>100973</ObjectId>
                           <ObjectType>Credit</ObjectType>
                           <ObjectName>Leonardo DiCaprio;Actor; Executive Producer</ObjectName>
                           <Relevancy>true</Relevancy>
                           <ImageCredit>Pascal Le Segretain/Getty Images Entertainment/Getty Images</ImageCredit>
                           <ImageCreditDisplay xsi:nil="true"/>
                           <ImageCastWeight>0</ImageCastWeight>
                           <ImageZoomLevel>1</ImageZoomLevel>
                           <ImageHeadcount>1</ImageHeadcount>
                           <ImageType>Celebrity</ImageType>
                           <ImageFormat>jpg</ImageFormat>
                           <ImageHorizontalResolution>42</ImageHorizontalResolution>
                           <ImageVerticalResolution>60</ImageVerticalResolution>
                           <ImageMaintainAspectFlag xsi:nil="true"/>
                           <ImageExpiryDateTime xsi:nil="true"/>
                           <LastUpdate>2009-12-10T13:52:14.813Z</LastUpdate>
                           <ImageFormatId>38</ImageFormatId>
                           <Orientation>Portrait</Orientation>
                           <AspectRatio>7:10</AspectRatio>
                           <ParentImageId>16845036</ParentImageId>
                           <MaxImageScale>1.98</MaxImageScale>
                        </Image>
                        <IsCelebrity>false</IsCelebrity>
                        <IsOrganization>false</IsOrganization>
                     </ProgramCredit>
                  </Credits>
                  <ProgramImages>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>2483662</ImageId>
                        <ImageTitle>Inception</ImageTitle>
                        <ImageCaption>Poster Art</ImageCaption>
                        <ObjectId>10409708</ObjectId>
                        <ObjectType>Program</ObjectType>
                        <ObjectName>Inception</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCredit>Warner Brothers Pictures</ImageCredit>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight xsi:nil="true"/>
                        <ImageZoomLevel>5</ImageZoomLevel>
                        <ImageHeadcount>6</ImageHeadcount>
                        <ImageType>Poster Art</ImageType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageHorizontalResolution>351</ImageHorizontalResolution>
                        <ImageVerticalResolution>500</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2011-12-21T14:59:35.017Z</LastUpdate>
                        <ImageFormatId>16</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>7:10</AspectRatio>
                        <ImageOwner>Warner Brothers Pictures</ImageOwner>
                        <ParentImageId>16888451</ParentImageId>
                        <MaxImageScale>13.86</MaxImageScale>
                     </Image>
                  </ProgramImages>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <CuttingPositions>
                     <int>70</int>
                     <int>149</int>
                     <int>177</int>
                  </CuttingPositions>
                  <ParentalRatings>
                     <ParentalRating>
                        <RatingType>FCTV</RatingType>
                        <Rating>None</Rating>
                        <Reasons/>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>Germany TV</RatingType>
                        <Rating>FSK: 12</Rating>
                        <Reasons/>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>Italy TV</RatingType>
                        <Rating>None</Rating>
                        <Reasons/>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>MPAA</RatingType>
                        <Rating>PG-13</Rating>
                        <Reasons>
                           <string>V</string>
                        </Reasons>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>RCQ</RatingType>
                        <Rating>G</Rating>
                        <Reasons/>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>Spain TV</RatingType>
                        <Rating>12</Rating>
                        <Reasons/>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>US TV</RatingType>
                        <Rating>None</Rating>
                        <Reasons/>
                     </ParentalRating>
                  </ParentalRatings>
                  <ProgramVariants>
                     <ProgramVariant ProviderTitle="Inception" OriginalProgramId="397379">
                        <ProgramHandle>
                           <Id>397379</Id>
                           <ProviderId>1</ProviderId>
                        </ProgramHandle>
                        <Streamable>1</Streamable>
                        <ProgramLanguage>English</ProgramLanguage>
                        <PriceOptions>
                           <PriceOption Type="Rental" CurrencyType="US Dollar" CurrencySymbol="$" Country="United States">
                              <Amount>4.9900</Amount>
                              <ProviderUpdateDateTime xsi:nil="true"/>
                              <IsDefault>true</IsDefault>
                              <EffectiveDateTime xsi:nil="true"/>
                              <EndDateTime xsi:nil="true"/>
                           </PriceOption>
                           <PriceOption Type="Rental" CurrencyType="US Dollar" CurrencySymbol="$" Country="United States">
                              <Amount>3.9900</Amount>
                              <ProviderUpdateDateTime xsi:nil="true"/>
                              <IsDefault>true</IsDefault>
                              <EffectiveDateTime xsi:nil="true"/>
                              <EndDateTime xsi:nil="true"/>
                           </PriceOption>
                           <PriceOption Type="Purchase" CurrencyType="US Dollar" CurrencySymbol="$" Country="United States">
                              <Amount>19.9500</Amount>
                              <ProviderUpdateDateTime xsi:nil="true"/>
                              <IsDefault>true</IsDefault>
                              <EffectiveDateTime xsi:nil="true"/>
                              <EndDateTime xsi:nil="true"/>
                           </PriceOption>
                        </PriceOptions>
                        <StreamableLastUpdateDate xsi:nil="true"/>
                        <ContentUri/>
                        <ContentType/>
                     </ProgramVariant>
                  </ProgramVariants>
                  <ProgramVideoClips>
                     <VideoClip VideoTitle="INCEPTION" VideoURL="http://actual-url-concealed.com" VideoType="Trailer" MaximumBitRate="750 kbps">
                        <VideoHandle>
                           <Id>159436</Id>
                           <ProviderId>6</ProviderId>
                        </VideoHandle>
                        <BitRateStartTime xsi:nil="true"/>
                        <BitRateEndTime xsi:nil="true"/>
                     </VideoClip>
                  </ProgramVideoClips>
                  <ProgramAwards>
                     <Award Title="Inception" Type="BAFTA Awards" Medium="None" Category="Best Film" Year="2010" IsWinner="false" DataAvailabilityFlags="0">
                        <Recipients>
                           <Recipient FullName="Christopher Nolan" DataAvailabilityFlags="12">
                              <CreditHandle>
                                 <Id>102015</Id>
                                 <ProviderId>2</ProviderId>
                              </CreditHandle>
                              <IsCelebrity>true</IsCelebrity>
                              <IsOrganization>false</IsOrganization>
                           </Recipient>
                           <Recipient FullName="Emma Thomas" DataAvailabilityFlags="8">
                              <CreditHandle>
                                 <Id>125630</Id>
                                 <ProviderId>2</ProviderId>
                              </CreditHandle>
                              <IsCelebrity>false</IsCelebrity>
                              <IsOrganization>false</IsOrganization>
                           </Recipient>
                        </Recipients>
                        <IsCelebrity>false</IsCelebrity>
                     </Award>
                  </ProgramAwards>
                  <ProgramLanguage>English</ProgramLanguage>
                  <CopyTextLanguage>English</CopyTextLanguage>
                  <ShowSeasons/>
                  <SubtitleLanguage/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
            </Programs>
            <Airings/>
            <PitchedPrograms>
               <Program DataAvailabilityFlags="63">
                  <ProgramHandle>
                     <Id>8145196</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>The Wackness</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText>A teen pot dealer (Josh Peck) bonds with a psychiatrist, who agrees to give him therapy in exchange for weed as the two begin to find out about themselves and each other. Ben Kingsley.</CopyText>
                  <Runtime>95</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>comedy</Subcategory>
                  <ReleaseYear>2008</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>0</StarRating>
                  <TVRating>None</TVRating>
                  <MovieRating>R</MovieRating>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>true</CC>
                  <Color>Color</Color>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords>
                     <string>comedia</string>
                     <string>comédie</string>
                     <string>comedy</string>
                     <string>Comedy</string>
                     <string>Comedy</string>
                     <string>Commedia</string>
                     <string>Komedi</string>
                     <string>Komedia</string>
                     <string>Komedie</string>
                     <string>Komedie</string>
                     <string>Komedie</string>
                     <string>Liebesfilme</string>
                     <string>romance</string>
                     <string>romance</string>
                     <string>romance</string>
                     <string>Romance</string>
                     <string>Romanssi</string>
                     <string>Romantiek</string>
                     <string>Romantik</string>
                     <string>Romantik</string>
                     <string>Romantikk</string>
                     <string>Sentimentale</string>
                  </Keywords>
                  <Credits>
                     <ProgramCredit DataAvailabilityFlags="12">
                        <ProgramHandle>
                           <Id>8145196</Id>
                           <ProviderId>2</ProviderId>
                        </ProgramHandle>
                        <CreditHandle>
                           <Id>102111</Id>
                           <ProviderId>2</ProviderId>
                        </CreditHandle>
                        <CreditName>Ben Kingsley</CreditName>
                        <PartName>Dr. Squires</PartName>
                        <CreditType>Actor</CreditType>
                        <Sequence>1</Sequence>
                        <Image>
                           <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                           <ImageUseType xsi:nil="true"/>
                           <ImageId>911576</ImageId>
                           <ImageTitle>Ben Kingsley</ImageTitle>
                           <ImageCaption>DOHA, QATAR - OCTOBER 29: Actor Sir Ben Kingsley attends a welcome lunch at the Al Mourjan during the 2009 Doha Tribeca Film Festival on October 29, 2009 in Doha, Qatar.</ImageCaption>
                           <ObjectId>102111</ObjectId>
                           <ObjectType>Credit</ObjectType>
                           <ObjectName>Ben Kingsley;Actor; Voice-overs</ObjectName>
                           <Relevancy>true</Relevancy>
                           <ImageCredit>Michael Buckner/Getty Images Entertainment/Getty Images</ImageCredit>
                           <ImageCreditDisplay xsi:nil="true"/>
                           <ImageCastWeight>0</ImageCastWeight>
                           <ImageZoomLevel>1</ImageZoomLevel>
                           <ImageHeadcount>1</ImageHeadcount>
                           <ImageType>Celebrity</ImageType>
                           <ImageFormat>jpg</ImageFormat>
                           <ImageHorizontalResolution>39</ImageHorizontalResolution>
                           <ImageVerticalResolution>60</ImageVerticalResolution>
                           <ImageMaintainAspectFlag xsi:nil="true"/>
                           <ImageExpiryDateTime xsi:nil="true"/>
                           <LastUpdate>2009-12-15T14:53:01.457Z</LastUpdate>
                           <ImageFormatId>38</ImageFormatId>
                           <Orientation>Portrait</Orientation>
                           <AspectRatio>2:3</AspectRatio>
                           <ParentImageId>16845409</ParentImageId>
                           <MaxImageScale>2.31</MaxImageScale>
                        </Image>
                        <IsCelebrity>true</IsCelebrity>
                        <IsOrganization>false</IsOrganization>
                     </ProgramCredit>
                  </Credits>
                  <ProgramImages>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>68389</ImageId>
                        <ImageTitle>The Wackness</ImageTitle>
                        <ImageCaption>Box art</ImageCaption>
                        <ObjectId>8145196</ObjectId>
                        <ObjectType>Program</ObjectType>
                        <ObjectName>The Wackness</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight>1</ImageCastWeight>
                        <ImageZoomLevel>5</ImageZoomLevel>
                        <ImageHeadcount>2</ImageHeadcount>
                        <ImageType>Poster Art</ImageType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageHorizontalResolution>333</ImageHorizontalResolution>
                        <ImageVerticalResolution>500</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime>2108-07-05T09:15:35.867Z</ImageExpiryDateTime>
                        <LastUpdate>2008-10-28T12:03:07.657Z</LastUpdate>
                        <ImageFormatId>16</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>2:3</AspectRatio>
                        <ParentImageId>16793233</ParentImageId>
                        <MaxImageScale>24.67</MaxImageScale>
                     </Image>
                  </ProgramImages>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <CuttingPositions>
                     <int>55</int>
                     <int>108</int>
                     <int>154</int>
                     <int>170</int>
                  </CuttingPositions>
                  <ParentalRatings>
                     <ParentalRating>
                        <RatingType>France TV</RatingType>
                        <Rating>12</Rating>
                        <Reasons/>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>MPAA</RatingType>
                        <Rating>R</Rating>
                        <Reasons>
                           <string>SS</string>
                           <string>SL</string>
                        </Reasons>
                     </ParentalRating>
                     <ParentalRating>
                        <RatingType>US TV</RatingType>
                        <Rating>None</Rating>
                        <Reasons/>
                     </ParentalRating>
                  </ParentalRatings>
                  <ProgramVariants>
                     <ProgramVariant ProviderTitle="The Wackness" OriginalProgramId="336246">
                        <ProgramHandle>
                           <Id>336246</Id>
                           <ProviderId>1</ProviderId>
                        </ProgramHandle>
                        <Streamable>1</Streamable>
                        <ProgramLanguage>English</ProgramLanguage>
                        <PriceOptions>
                           <PriceOption Type="Purchase" CurrencyType="US Dollar" CurrencySymbol="$" Country="United States">
                              <Amount>14.9500</Amount>
                              <ProviderUpdateDateTime xsi:nil="true"/>
                              <IsDefault>true</IsDefault>
                              <EffectiveDateTime xsi:nil="true"/>
                              <EndDateTime xsi:nil="true"/>
                           </PriceOption>
                        </PriceOptions>
                        <StreamableLastUpdateDate xsi:nil="true"/>
                        <ContentUri/>
                        <ContentType/>
                     </ProgramVariant>
                  </ProgramVariants>
                  <ProgramVideoClips>
                     <VideoClip VideoTitle="THE WACKNESS" VideoURL="http://www.actual-url-concealed.com" VideoType="Trailer" MaximumBitRate="750 kbps">
                        <VideoHandle>
                           <Id>48088</Id>
                           <ProviderId>6</ProviderId>
                        </VideoHandle>
                        <BitRateStartTime xsi:nil="true"/>
                        <BitRateEndTime xsi:nil="true"/>
                     </VideoClip>
                     <VideoClip VideoTitle="THE WACKNESS" VideoURL="http://actual-url-concealed.com" VideoType="Trailer" MaximumBitRate="1500 kbps">
                        <VideoHandle>
                           <Id>48089</Id>
                           <ProviderId>6</ProviderId>
                        </VideoHandle>
                        <BitRateStartTime xsi:nil="true"/>
                        <BitRateEndTime xsi:nil="true"/>
                     </VideoClip>
                  </ProgramVideoClips>
                  <ProgramAwards>
                     <Award Title="The Wackness" Type="Sundance Film Festival" Medium="None" Category="Audience Award: Dramatic" Year="2008" IsWinner="true" DataAvailabilityFlags="0">
                        <Recipients>
                           <Recipient FullName="Jonathan Levine" DataAvailabilityFlags="8">
                              <CreditHandle>
                                 <Id>314209</Id>
                                 <ProviderId>2</ProviderId>
                              </CreditHandle>
                              <IsCelebrity>false</IsCelebrity>
                              <IsOrganization>false</IsOrganization>
                           </Recipient>
                        </Recipients>
                        <IsCelebrity>false</IsCelebrity>
                     </Award>
                  </ProgramAwards>
                  <ProgramLanguage>English</ProgramLanguage>
                  <CopyTextLanguage>English</CopyTextLanguage>
                  <ShowSeasons/>
                  <SubtitleLanguage/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
            </PitchedPrograms>
            <Page>
               <PageSize>1</PageSize>
               <StartIndex>1</StartIndex>
               <TotalRows>39</TotalRows>
               <SortByColumn>
                  <int>10</int>
                  <int>4</int>
               </SortByColumn>
            </Page>
         </GetRecommendationItemsInListResult>
      </GetRecommendationItemsInListResponse>
   </soap:Body>
</soap:Envelope>

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.
  • Specify en-US in the Locale element.
  • Specify the ID of the recommendation list in the RecommendationListId element.
  • Specify the current time in the StartDate element.
  • Specify the current time in the EndDate element.
  • Specify 0 in the CopyType element to use the default copy type.
  • Specify ProgramsMinimal in the IncludeDataType element to return minimal program information and no broadcast schedule.
  • Specify a PageSize of 2 and a StartIndex of 0 to return only the first two results for this example.
  • To sort by the returned MasterTitle element, specify 4 in the SortByColumn object.
  • In the Image object, specify 16 in the ImageFormatId element to determine the image size. If that image size is not available for a movie, an image will not be returned for the movie.
  • Specify 1 in the ImageCount element to return just one image.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:rec="http://api.rovicorp.com/v9/recommendationservice">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <rec:GetRecommendationItemsInList>
         <rec:request>
            <rec:Locale>en-US</rec:Locale>
            <rec:RecommendationListId>68bd6410-8229-4666-ad68-211c966aef93</rec:RecommendationListId>
            <rec:StartDate>2011-06-18T18:00:00.000-07:00</rec:StartDate>
            <rec:EndDate>2011-07-02T18:00:00.000-07:00</rec:EndDate>
            <rec:CopyType>0</rec:CopyType>
            <rec:IncludeDataType>ProgramsMinimal</rec:IncludeDataType>
            <rec:Page>
               <rec:PageSize>2</rec:PageSize>
               <rec:StartIndex>0</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
               <rec:SortByColumn>
                  <rec:int>4</rec:int>
               </rec:SortByColumn>
            </rec:Page>
            <rec:Image>
               <rec:ImageFormatId>16</rec:ImageFormatId>
            </rec:Image>
            <rec:ImageCount>1</rec:ImageCount>
         </rec:request>
      </rec:GetRecommendationItemsInList>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, returning 2 movies in the first page of 34 results.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetRecommendationItemsInListResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
         <GetRecommendationItemsInListResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">e48bbff8-a6f2-4c79-87a9-cc05e0422cd3</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-17T21:17:15.406Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-17T21:17:15.453Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Programs>
               <Program DataAvailabilityFlags="119">
                  <ProgramHandle>
                     <Id>512849</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>8 Seconds</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText/>
                  <Runtime>0</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>drama</Subcategory>
                  <ReleaseYear>0</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>0</StarRating>
                  <TVRating/>
                  <MovieRating/>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>false</CC>
                  <Color/>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords/>
                  <Credits/>
                  <ProgramImages>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>461677</ImageId>
                        <ImageTitle>8 Seconds</ImageTitle>
                        <ImageCaption>Luke Perry</ImageCaption>
                        <ObjectId>512849</ObjectId>
                        <ObjectType>Program</ObjectType>
                        <ObjectName>8 Seconds</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight>1</ImageCastWeight>
                        <ImageZoomLevel>2</ImageZoomLevel>
                        <ImageHeadcount>1</ImageHeadcount>
                        <ImageType>Program: Key</ImageType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageHorizontalResolution>345</ImageHorizontalResolution>
                        <ImageVerticalResolution>500</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2009-05-20T13:51:37.45Z</LastUpdate>
                        <ImageFormatId>16</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>2:3</AspectRatio>
                        <ParentImageId>16822567</ParentImageId>
                        <MaxImageScale>16.66</MaxImageScale>
                     </Image>
                  </ProgramImages>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <ParentalRatings/>
                  <ProgramVariants/>
                  <ProgramVideoClips/>
                  <ProgramAwards/>
                  <ShowSeasons/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>0</Streamable>
               </Program>
               <Program DataAvailabilityFlags="127">
                  <ProgramHandle>
                     <Id>208664</Id>
                     <ProviderId>2</ProviderId>
                  </ProgramHandle>
                  <TvObjectId>0</TvObjectId>
                  <MasterTitle>A League Of Their Own</MasterTitle>
                  <EpisodeTitle/>
                  <CopyText/>
                  <Runtime>0</Runtime>
                  <ProgramType>Movie</ProgramType>
                  <Category>Movie</Category>
                  <Subcategory>comedy</Subcategory>
                  <ReleaseYear>0</ReleaseYear>
                  <Season/>
                  <EpisodeNumber/>
                  <PartNumber>0</PartNumber>
                  <PartTotal>0</PartTotal>
                  <StarRating>0</StarRating>
                  <TVRating/>
                  <MovieRating/>
                  <Subtitled>false</Subtitled>
                  <Letterbox>false</Letterbox>
                  <CC>false</CC>
                  <Color/>
                  <OriginalAirDate xsi:nil="true"/>
                  <Syndicated>false</Syndicated>
                  <Keywords/>
                  <Credits/>
                  <ProgramImages>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>545030</ImageId>
                        <ImageTitle>A League of Their Own</ImageTitle>
                        <ImageCaption>Box Art</ImageCaption>
                        <ObjectId>208664</ObjectId>
                        <ObjectType>Program</ObjectType>
                        <ObjectName>A League of Their Own</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight>1.17</ImageCastWeight>
                        <ImageZoomLevel>3</ImageZoomLevel>
                        <ImageHeadcount>3</ImageHeadcount>
                        <ImageType>Poster Art</ImageType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageHorizontalResolution>357</ImageHorizontalResolution>
                        <ImageVerticalResolution>500</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2009-08-27T10:51:35.9Z</LastUpdate>
                        <ImageFormatId>16</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>7:10</AspectRatio>
                        <ParentImageId>16833012</ParentImageId>
                        <MaxImageScale>23.06</MaxImageScale>
                     </Image>
                  </ProgramImages>
                  <IsVideoAvailable xsi:nil="true"/>
                  <SeasonSequence xsi:nil="true"/>
                  <SeriesSequence xsi:nil="true"/>
                  <LastAirDate xsi:nil="true"/>
                  <ParentalRatings/>
                  <ProgramVariants/>
                  <ProgramVideoClips/>
                  <ProgramAwards/>
                  <ShowSeasons/>
                  <SecondaryTitle/>
                  <UnsequencedEpisodes/>
                  <Streamable>1</Streamable>
               </Program>
            </Programs>
            <Airings/>
            <Page>
               <PageSize>2</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>34</TotalRows>
               <SortByColumn>
                  <int>4</int>
               </SortByColumn>
            </Page>
         </GetRecommendationItemsInListResult>
      </GetRecommendationItemsInListResponse>
   </soap:Body>
</soap:Envelope>

See Also

↑ Top

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