V9.RecommendationService:GetRecommendationListsExamples

Jump to: navigation, search

GetRecommendationLists Request Examples

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

« GetRecommendationLists

Request Example 1

Get the recommendation lists in the US list group Recommendation List. For this request, ask for just the first three lists available.

  • Specify Recommendation List in the ListGroupName element.
  • Specify en-US in the Locale element.
  • Specify 3 in the PageSize element to return 3 lists.
  • Specify 0 in the StartIndex element to start with the first list available.
  • Specify a number in the TotalRows element to return the total number of lists available.

<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:GetRecommendationLists>
         <rec:request>
            <rec:ListGroupName>Recommendation List</rec:ListGroupName>
            <rec:Locale>en-US</rec:Locale>
            <rec:Page>
               <rec:PageSize>3</rec:PageSize>
               <rec:StartIndex>0</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
            </rec:Page>
         </rec:request>
      </rec:GetRecommendationLists>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request.

<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>
      <GetRecommendationListsResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
         <GetRecommendationListsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">8e588cb0-89de-438d-ad14-bed4c28a01b1</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-16T01:45:37.328Z</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-16T01:45:37.328Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <RecommendationLists>
               <RecommendationList>
                  <RecommendationListId>1e421dd2-c636-4a5d-af56-caab3978edff</RecommendationListId>
                  <Title>Teen Hot List</Title>
                  <Description>Viewing recommendations for the teen set, encompassing selections for both younger and older teenagers. A variety of programming categories is represented, including sitcoms, reality series, movies and educational programs.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>100</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
               <RecommendationList>
                  <RecommendationListId>38d514f4-fac9-4948-a759-eab6027ea5d6</RecommendationListId>
                  <Title>Music Hot List</Title>
                  <Description>Striking chords of interest for fans of all sounds, selected fare ranges from American Idol to Air Guitar Nation, with plenty in between. Included are concerts, musicals, specials, series, documentaries, biographies, reality shows and movies.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>100</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
               <RecommendationList>
                  <RecommendationListId>2512f7e7-5a70-47e7-8547-de0b7c2f575a</RecommendationListId>
                  <Title>Family Hot List</Title>
                  <Description>Noteworthy shows that families can watch together. Recommended programs are suitable for children of various ages, from toddlers to teens.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>100</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://www.actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
            </RecommendationLists>
            <Page>
               <PageSize>3</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>20</TotalRows>
            </Page>
         </GetRecommendationListsResult>
      </GetRecommendationListsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 2

Get the next page of recommendation lists in the US list group Recommendation List, the three lists that come after the lists returned in Request Example 1.
  • Specify Recommendation List in the ListGroupName element.
  • Specify en-US in the Locale element.
  • Specify 3 in the PageSize element to return 3 lists.
  • Specify 3 in the StartIndex element to start with the fourth list available.
  • Specify a number in the TotalRows element to return the total number of lists available.
<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:GetRecommendationLists>
         <rec:request>
            <rec:ListGroupName>Recommendation List</rec:ListGroupName>
            <rec:Locale>en-US</rec:Locale>
            <rec:Page>
               <rec:PageSize>3</rec:PageSize>
               <rec:StartIndex>3</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
            </rec:Page>
         </rec:request>
      </rec:GetRecommendationLists>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request.

<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>
      <GetRecommendationListsResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
         <GetRecommendationListsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">3f2392cc-b2de-456d-a911-e6833d328c58</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-16T02:14:44.413Z</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-16T02:14:44.413Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <RecommendationLists>
               <RecommendationList>
                  <RecommendationListId>e0beb177-c03f-4070-a9cc-621f0519e3ca</RecommendationListId>
                  <Title>Sports Hot List</Title>
                  <Description>Compelling sports events and programs. Selections are picked from a wide variety of sports and also include series, movies and documentaries with a sports angle.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>100</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
               <RecommendationList>
                  <RecommendationListId>68bd6410-8229-4666-ad68-211c966aef93</RecommendationListId>
                  <Title>Flick Pick Hot List</Title>
                  <Description>The Hot List for Flick Pick Hot List</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>100</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
               <RecommendationList>
                  <RecommendationListId>dc682923-d0ca-4d51-a6d8-680c405ad527</RecommendationListId>
                  <Title>Reality Hot List</Title>
                  <Description>A year-round selection of the most popular reality shows, highlighting season openers and finales, pivotal competitions and elimination-round episodes. Also spotlighted are debuting reality shows and fringe reality programming for big fans of the genre.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>100</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
            </RecommendationLists>
            <Page>
               <PageSize>3</PageSize>
               <StartIndex>3</StartIndex>
               <TotalRows>20</TotalRows>
            </Page>
         </GetRecommendationListsResult>
      </GetRecommendationListsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 3

Get the recommendation lists in the US list group Recommendation List, but return them in reverse order. For this request, ask for just the first three lists in the reverse order.
  • Specify Recommendation List in the ListGroupName element.
  • Specify en-US in the Locale element.
  • Specify 3 in the PageSize element to return 3 lists.
  • Specify 0 in the StartIndex element to start with the first list.
  • Specify a number in the TotalRows element to return the total number of lists available.
  • In the SortByColumn, specify -5 in an int element to sort the list by inverse value of the DisplayOrder element, which is the fifth element in the RecommendationList element.
<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:GetRecommendationLists>
         <rec:request>
            <rec:ListGroupName>Recommendation List</rec:ListGroupName>
            <rec:Locale>en-US</rec:Locale>
            <rec:Page>
               <rec:PageSize>3</rec:PageSize>
               <rec:StartIndex>0</rec:StartIndex>
               <rec:TotalRows>0</rec:TotalRows>
               <rec:SortByColumn>
                  <rec:int>-5</rec:int>
               </rec:SortByColumn>
            </rec:Page>
         </rec:request>
      </rec:GetRecommendationLists>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request.

<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>
      <GetRecommendationListsResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
         <GetRecommendationListsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">bcda715a-c888-4d37-aad9-e5e12ff3be6f</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-16T01:58:59.396Z</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-16T01:58:59.396Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <RecommendationLists>
               <RecommendationList>
                  <RecommendationListId>810455c4-3cbf-4aee-bc30-b053e17c2b4b</RecommendationListId>
                  <Title>Season Premieres And Finales</Title>
                  <Description>The first and final episodes of the season, along with debuts of new shows and series finales for programs including sitcoms, dramas and reality series.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>800</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
               <RecommendationList>
                  <RecommendationListId>52c457be-dd4e-4359-8c1e-1de9501fbc31</RecommendationListId>
                  <Title>Seasonal/Holiday</Title>
                  <Description>Specialty programming related to major cultural, government and religious holidays.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>800</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
               <RecommendationList>
                  <RecommendationListId>63005c47-55d1-4145-8079-0d39b2ec55b1</RecommendationListId>
                  <Title>Rated G</Title>
                  <Description>Family-friendly fare that is suitable for folks of all ages. Selections include animated films, along with lighthearted comedies and gentler dramas.</Description>
                  <Configuration>&lt;Configuration>&lt;Cobranding PartnerId="0" PartnerName="TV Guide" ImageURL="http://actual-url-concealed.gif"/>&lt;/Configuration></Configuration>
                  <DisplayOrder>600</DisplayOrder>
                  <Qualification/>
                  <ContentProviderName>Corporate</ContentProviderName>
                  <ListImageUri>http://actual-url-concealed.gif</ListImageUri>
               </RecommendationList>
            </RecommendationLists>
            <Page>
               <PageSize>3</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>20</TotalRows>
               <SortByColumn>
                  <int>-5</int>
               </SortByColumn>
            </Page>
         </GetRecommendationListsResult>
      </GetRecommendationListsResponse>
   </soap:Body>
</soap:Envelope>

See Also

↑ Top

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