V1.MetaData.VideoService.Video:Keywords

Jump to: navigation, search

Video/Keywords

Returns keywords that apply to a movie, TV series, or TV program.

Syntax

video/keywords? video=video
cosmoid=cosmoid
iguideid=iguideid
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language]

Request Example 1

Request keywords that apply to the TV series The Simpsons.

Request Example 2

Request keywords that apply to the final episode of Big Love in an XML response.

Request Example 3

Request keywords that apply to the movie The Terminator.

Request Parameters

Sort none.gif  Click to re-sort

Parameter Required Description
apikey Yes Access code that authorizes your request for data from Rovi.
sig Yes A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
  • Your API key.
  • The secret key you received with your API key.
  • The Unix time. Unix time is a timestamp supported in most development environments, and is generally defined as the number of seconds since January 1, 1970 00:00:00 GMT.

Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation.

cosmoid Conditional Cosmo database ID for a movie or a television series, season, or program. Cosmo is a database of television information. You can grab Cosmo IDs from responses to the following requests:

Condition: The request must contain just one of these parameters:

  • video
  • cosmoid
  • iguideid
iguideid Conditional A 24-bit program ID for a television program used by the i‑Guide™ interactive digital cable TV program guide. You can get i‑Guide IDs from i‑Guide and from responses to the following requests:

Condition: The request must contain just one of these parameters:

  • video
  • cosmoid
  • iguideid
video Conditional Title of a movie, television program, or television series, or keywords from the title. This searches for the most popular title with that combination of words. Replace any spaces with plus (+) or percent20 (%20) symbols.

Note: This parameter currently returns only US-English results. Support for other countries and languages will be added in the future.

Condition: The request must contain just one of these parameters:

  • video
  • cosmoid
  • iguideid
country No Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code. Default is US (United States). Valid country codes are:
  • AR
Argentina
  • SV
El Salvador
  • NI
Nicaragua
  • AT
Austria
  • FI
Finland
  • NO
Norway
  • BE
Belgium
  • FR
France
  • PA
Panama
  • BM
Bermuda
  • DE
Germany
  • PE
Peru
  • BO
Bolivia
  • GT
Guatemala
  • PL
Poland
  • BR
Brazil    
  • PT
Portugal
  • CA
Canada
  • HN
Honduras
  • ES
Spain
  • CL
Chile
  • IE
Ireland
  • SE
Sweden
  • CO
Colombia
  • IT
Italy
  • CH
Switzerland
  • CR
Costa Rica
  • JM
Jamaica
  • TR
Turkey
  • DK
Denmark
  • LU
Luxembourg   
  • GB
United Kingdom*
  • DO
Dominican Republic   
  • MX
Mexico
  • US
United States
  • EC
Ecuador
  • NL
Netherlands
  • VE
Venezuela

* Includes Wales, Scotland, and Northern Ireland.

format No Format of the returned data: json or xml. The default is JSON.
language No Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code. Valid language codes are:
  • da
Danish
  • fr
French
  • pl
Polish
  • nl
Dutch
  • de
German
  • pt
Portuguese
  • en
English    
  • it
Italian
  • es
Spanish
  • fi
Finnish
  • no
Norwegian    
  • sv
Swedish
  • fl
Flemish
  • tr
Turkish

Default is en (English). If a program description is not available in the language requested, a description in another language is provided if available. The language chosen is determined by the rules shown in the Language Fallback Sequence table.

Response

Response Header

ResponseTypeDescription
buildStringThe software release level of the API.
codeIntegerHTTP status code. See the status field for the text part of the code.
durationIntegerServer processing time in milliseconds. The difference between startTime and endTime.
endTimeStringWhen the server sent the response (UTC time).
messagesMessage [ ]Elements of a multiple HTTP response status message.
parametersparametersList of the parameters included in the request.
serverNameStringName of the server that processed the request.
startTimeStringWhen the server received the request (UTC time).
statusStringText part of the HTTP status code that is shown in the code field.
viewviewSummary of items returned in a list of items.

Response for Video/Keywords

ResponseTypeDescription
characteristics Keyword [ ] Keywords from our DVDs database that apply to the movie or TV series specified in request and weightings that reflect the relative importance of each keyword.
keywords Keyword [ ] Keywords from our television database that apply to the movie, TV series, or TV program specified in request.

JSON Response Example

Here's the response to Request Example 1. It is formatted with extra spaces and carriage returns to make it easy to read.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.7.2.5",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"7903",
      "format":"json"
   },
   "view":{
      "count":5
   },
   "serverName":"tul1cssw4",
   "startTime":"2011-09-27T02:03:26.6239418Z",
   "endTime":"2011-09-27T02:03:26.9364398Z",
   "duration":312,
   "parentIds":{
      "cosmoId":"7903"
   },
   "keywords":{
      "keywords":[
         {
            "id":"32",
            "keyword":"cartoon",
            "weight":""
         },
         {
            "id":"65",
            "keyword":"animated comedy",
            "weight":""
         },
         {
            "id":"178",
            "keyword":"satire",
            "weight":""
         },
         {
            "id":"190",
            "keyword":"sitcom",
            "weight":""
         },
         {
            "id":"355",
            "keyword":"cult classic",
            "weight":""
         }
      ],
      "characteristics":[
         {
            "id":"K 1458",
            "keyword":"family",
            "weight":"8"
         },
         {
            "id":"K 28964",
            "keyword":"townspeople",
            "weight":"6"
         },
         {
            "id":"K 29472",
            "keyword":"mischief",
            "weight":"5"
         },
         {
            "id":"K 28174",
            "keyword":"nuclear-power-plant",
            "weight":"5"
         },
         {
            "id":"K 4744",
            "keyword":"working-class",
            "weight":"5"
         }
      ]
   }
}

XML Response Example

Here's the response to Request Example 2.
<VideoKeywords xmlns="com.rovicorp.metadataservice" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <messages i:nil="true"/>
  <build>1.7.2.5</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>19047032</id>
    <format>xml</format>
  </parameters>
  <view>
    <count>2</count>
  </view>
  <serverName>tul1cssw4</serverName>
  <startTime>2011-09-27T02:17:03.7404290Z</startTime>
  <endTime>2011-09-27T02:17:03.7560546Z</endTime>
  <duration>15</duration>
  <parentIds>
    <cosmoId>19047032</cosmoId>
  </parentIds>
  <keywords>
    <keywords>
      <Keyword>
        <id>16</id>
        <keyword>drama</keyword>
        <weight/>
      </Keyword>
      <Keyword>
        <id>186</id>
        <keyword>series finale</keyword>
        <weight/>
      </Keyword>
    </keywords>
    <characteristics i:nil="true"/>
  </keywords>
</VideoKeywords>


See Also

↑ Top

Personal tools