V9.RecommendationService:GetRecommendationListNames

Jump to: navigation, search

GetRecommendationListNames

Returns information about the recommendation list associated with a recommendation list ID.

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>
    <GetRecommendationListNames xmlns="http://api.rovicorp.com/v9/recommendationservice">
      <request>
        <Locale>string</Locale>
        <RecommendationListIds>
          <string>string</string>
          <string>string</string>
        </RecommendationListIds>
      </request>
    </GetRecommendationListNames>
  </soap12:Body>
</soap12:Envelope>

Request Example 1 »

Request information about two of the recommendation lists you are using.

Request Parameters

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

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

RecommendationListIds Yes String GUID [ ] The recommendation list IDs you want information about.
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.

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 GetRecommendationListNames

NameTypeDescription
RecommendationLists RecommendationList [ ] Information about the recommendation lists specified in the request.

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>
    <GetRecommendationListNamesResponse xmlns="http://api.rovicorp.com/v9/recommendationservice">
      <GetRecommendationListNamesResult>
        <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>
      </GetRecommendationListNamesResult>
    </GetRecommendationListNamesResponse>
  </soap12:Body>
</soap12:Envelope>

Error Codes

CodeNameDescription
10603 LookupService_InvalidLocale The locale specified in the request is invalid.
10900 Recommendation_InvalidListId A recommendation list ID in the request is invalid, but valid IDs are processed without error.
10906 Recommendation_InvalidListRange The request did not include a recommendation list ID.

See Also

↑ Top

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