V9.RecommendationService:GetRecommendationLists

Jump to: navigation, search

GetRecommendationLists

Returns the IDs of editorial recommendation lists. Start with this request when you want to present editorial recommendations for television.

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>
  </soap12:Header>
  <soap12:Body>
    <GetRecommendationLists xmlns="http://api.rovicorp.com/v9/recommendationservice">
      <request>
        <ListGroupName>string</ListGroupName>
        <Locale>string</Locale>
        <ContentProviderName>string</ContentProviderName>
        <Page>
          <PageSize>int</PageSize>
          <StartIndex>int</StartIndex>
          <TotalRows>int</TotalRows>
          <SortByColumn>
            <int>int</int>
            <int>int</int>
          </SortByColumn>
        </Page>
      </request>
    </GetRecommendationLists>
  </soap12:Body>
</soap12:Envelope>

Request Example 1 »

Get the recommendation lists in the US list group Recommendation List.

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.

Request Example 3 »

Get the recommendation lists in the US list group Recommendation List, but return them in reverse order.

Request Parameters

NameRequiredTypeDescription
ListGroupName Yes String Name of the Recommendation List Group you want. Select one of the following, based on language and country:
  • Liquid Recommendation List (Canada)   
English, Canada
  • GB Recommendation List
English, United Kingdom
  • Recommendation List
English, United States
  • Liquid Recommendation List
English, United States
  • FR Recommendation List
French, France
  • DE Recommendation List
German, Germany
  • IT Recommendation List
Italian, Italy
  • Liquid Recommendation List (Mexico)
Spanish, Mexico
  • ES Recommendation List
Spanish, Spain
Locale Yes String Language and country code of the television service. This is a case-insensitive combination of the ISO 639 language code, a hyphen character, and the ISO 3166 country code, as described in RFC 1766. Valid locales include:
  • da-DK
Danish, Denmark
  • nl-BE
Dutch, Belgium
  • nl-NL
Dutch, Netherlands
  • en-BM
English (US), Bermuda
  • en-CA
English (US), Canada
  • en-IE
English (US), Ireland
  • en-JM
English (US), Jamaica
  • en-GB
English (UK), United Kingdom[1]
  • en-US
English (US), United States
  • fi-FI
Finnish, Finland
  • fl-BE
Flemish, Belgium
  • fr-BE
French, Belgium
  • fr-CA
French, Canada
  • fr-FR
French, France
  • fr-LU
French, Luxembourg
  • fr-CH
French, Switzerland
  • de-AT
German, Austria
  • de-DE
German, Germany
  • de-LU
German, Luxembourg
  • de-CH
German, Switzerland
  • it-IT
Italian, Italy
  • it-CH
Italian, Switzerland
  • no-NO
Norwegian, Norway
  • pl-PL
Polish, Poland
  • pt-BR
Portuguese, Brazil
  • pt-PT
Portuguese, Portugal
  • es-AR
Spanish, Argentina
  • es-BO
Spanish, Bolivia
  • es-CL
Spanish, Chile
  • es-CO
Spanish, Colombia
  • es-CR
Spanish, Costa Rica
  • es-DO
Spanish, Dominican Republic
  • es-EC
Spanish, Ecuador
  • es-SV
Spanish, El Salvador
  • es-GT
Spanish, Guatemala
  • es-HN
Spanish, Honduras
  • es-MX
Spanish, Mexico
  • es-NI
Spanish, Nicaragua
  • es-PA
Spanish, Panama
  • es-PE
Spanish, Peru
  • es-ES
Spanish, Spain
  • es-US
Spanish, United States
  • es-VE
Spanish, Venezuela
  • sv-SE
Swedish, Sweden

[1] Includes Wales, Scotland, and Northern Ireland.

ClientBatchId No String A trace code to be returned in the response header so you can track a batch of requests. The code can be up to 255 characters.
ContentProviderName No String This parameter is restricted to custom Rovi applications.
Page No DataPage Settings that return the response one pageful at a time and determine the sequence of the response. The list of recommendation lists is ordered by the fifth column, the DisplayOrder response element.

Response

Response Header

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

Response for GetRecommendationLists

NameTypeDescription
RecommendationLists RecommendationList [ ] The recommendation lists requested.
Page DataPage The number of recommendation lists available in the group, plus echoes of the parameters specified in the Page parameter.

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>
    <GetRecommendationListsResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
      <GetRecommendationListsResult>
        <RecommendationLists>
          <RecommendationList>
            <RecommendationListId>string</RecommendationListId>
            <Title>string</Title>
            <Description>string</Description>
            <Configuration>string</Configuration>
            <DisplayOrder>int</DisplayOrder>
            <Qualification xsi:nil="true" />
            <ContentProviderName>string</ContentProviderName>
            <ListImageUri>string</ListImageUri>
          </RecommendationList>
          <RecommendationList>
            <RecommendationListId>string</RecommendationListId>
            <Title>string</Title>
            <Description>string</Description>
            <Configuration>string</Configuration>
            <DisplayOrder>int</DisplayOrder>
            <Qualification xsi:nil="true" />
            <ContentProviderName>string</ContentProviderName>
            <ListImageUri>string</ListImageUri>
          </RecommendationList>
        </RecommendationLists>
        <Page>
          <PageSize>int</PageSize>
          <StartIndex>int</StartIndex>
          <TotalRows>int</TotalRows>
          <SortByColumn>
            <int>int</int>
            <int>int</int>
          </SortByColumn>
        </Page>
      </GetRecommendationListsResult>
    </GetRecommendationListsResponse>
  </soap12:Body>
</soap12:Envelope>

Error Codes

CodeNameDescription
1001 Core_MandatoryFieldMissing A mandatory parameter is not specified.
5001 Core_InvalidPagingStartIndex The StartIndex specified for the Page parameter is negative, non-numeric, or results in a negative range.
5002 Core_InvalidPagingPageSize The PageSize specified for Page parameter is negative or non-numeric.
10603 LookupService_InvalidLocale The locale specified in the request is invalid.
601001 Core_InvalidSortingColumnIndex Warning: An invalid SortByColumn value was specified.

See Also

↑ Top

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