Data/descriptor-api/v1.1/descriptor/movie-categories

Jump to: navigation, search

Descriptor/MovieCategories

Returns local movie categories and subcategories that are recognized by Rovi Video and Rovi TV Listings.

Syntax

descriptor/moviecategories?apikey=apikey&sig=sig [&categoryids=categoryids] [&include=include] [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request all US movie categories.
http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig

Request Example 2

Request the US avant-garde and mystery categories and subcategories.
http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig&
include=subcategories&categoryids=1391952,1391970

Request Example 3

Request the US avant-garde and mystery categories and subcategories in an XML response.
http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig&
include=subcategories&categoryids=1391952,1391970&format=xml

Request Example 4

Request the first two movie categories in an XML and French language response.
http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig&count=2&
language=fr&format=xml

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, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three ASCII 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.

Express the alpha hex digits as lower case.

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.

categoryids No Category IDs to include in the response. To specify multiple IDs, use a comma-separated list like this: categoryids=1391952,1391979,1391970.

If not specified, all movie categories are returned.

count No Number of items to be returned. The default is zero, which returns all items after the offset.
country No Country the language parameter applies to, stated as a two-character ISO 3166 country code. Default is the default country of the language you specify (US if language is not specified). If an invalid combination of country and language is specified, US English will be returned.

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
  • HN
Honduras
  • PT
Portugal
  • CA
Canada
  • IE
Ireland
  • ES
Spain
  • CL
Chile
  • IT
Italy
  • SE
Sweden
  • CO
Colombia
  • JM
Jamaica
  • CH
Switzerland
  • CR
Costa Rica
  • LU
Luxembourg 
  • GB
United Kingdom*
  • DK
Denmark
  • MX
Mexico
  • US
United States
  • DO
Dominican Republic 
  • NL
Netherlands
  • VE
Venezuela
  • EC
Ecuador

* Includes Wales, Scotland, and Northern Ireland.

format No Format of the returned data: json or xml. The default is JSON.
include No The subcategories request. To include subcategories in the response, add include=subcategories.
language No Language of the response data, stated as a two-character ISO 639 language code:
  • da
Danish
  • fr
French
  • pt
Portuguese
  • nl
Dutch
  • de
German
  • es
Spanish
  • en
English
  • it
Italian
  • sv
Swedish
  • fi
Finnish
  • no
Norwegian    
  • fl
Flemish    
  • pl
Polish

Default is en (English). If content is not available in the language requested, another language is chosen as determined by the Language Fallback Sequence table.

offset No Number of items at the start of the available data to skip. The default is zero.

Use count and offset to paginate the data that is available to be returned.

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.
parametersparametersThe parameters that were 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, which is shown in the code field.
viewviewSummary of items returned in a list of items.

Response for Descriptor/MovieCategories

ResponseTypeDescription
moviecategories Category [ ] Movie categories and, if requested, subcategories in each category.

JSON Response Example

Here's the response to Request Example 2, which asks for the US avant-garde and mystery categories and subcategories. The response has been formatted with extra spaces and carriage returns to make it easy to read.
Requested with http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig&
include=subcategories&categoryids=1391952,1391970.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"apikey",
      "id":"1391952,1391970",
      "include":"subcategories"
   },
   "view":{
      "total":2
   },
   "serverName":"tul1cstrcs1.corporate.local",
   "startTime":"2013-02-20T01:12:44Z",
   "endTime":"2013-02-20T01:12:44Z",
   "duration":5,
   "categories":[
      {
         "id":"1391952",
         "name":"Avant-Garde / Experimental",
         "subcategories":[
            {
               "id":"1391985",
               "name":"Abstract Film"
            },
            {
               "id":"1392041",
               "name":"Essay Film"
            },
            {
               "id":"1392164",
               "name":"Surrealist Film"
            },
            {
               "id":"1392174",
               "name":"Trash Film"
            },
            {
               "id":"1392178",
               "name":"Video Art [Nf]"
            }
         ]
      },
      {
         "id":"1391970",
         "name":"Mystery",
         "subcategories":[
            {
               "id":"1392021",
               "name":"Comedy Thriller"
            },
            {
               "id":"1392032",
               "name":"Detective Film"
            },
            {
               "id":"1392053",
               "name":"Film Noir"
            },
            {
               "id":"1392057",
               "name":"Giallo"
            },
            {
               "id":"1392099",
               "name":"Police Detective Film"
            },
            {
               "id":"1392105",
               "name":"Post-Noir (Modern Noir)"
            },
            {
               "id":"1392130",
               "name":"Romantic Mystery"
            },
            {
               "id":"1392184",
               "name":"Whodunit"
            }
         ]
      }
   ]
}

XML Response Example 1

Here's the response to Request Example 3, which asks for the US avant-garde and mystery categories and subcategories in an XML response.
Requested with http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig&
include=subcategories&categoryids=1391952,1391970&format=xml.
<MovieCategories 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.0</build>
  <parameters>
    <apiKey>apikey</apiKey>
    <id>1391952,1391970</id>
    <include>subcategories</include>
    <format>xml</format>
  </parameters>
  <view>
    <total>2</total>
  </view>
  <serverName>tul1cstrcs1.corporate.local</serverName>
  <startTime>2013-02-20T01:19:50Z</startTime>
  <endTime>2013-02-20T01:19:50Z</endTime>
  <duration>10</duration>
  <categories>
    <Category>
      <id>1391952</id>
      <name>Avant-Garde / Experimental</name>
      <subcategories>
        <subcategory>
          <id>1391985</id>
          <name>Abstract Film</name>
        </subcategory>
        <subcategory>
          <id>1392041</id>
          <name>Essay Film</name>
        </subcategory>
        <subcategory>
          <id>1392164</id>
          <name>Surrealist Film</name>
        </subcategory>
        <subcategory>
          <id>1392174</id>
          <name>Trash Film</name>
        </subcategory>
        <subcategory>
          <id>1392178</id>
          <name>Video Art [Nf]</name>
        </subcategory>
      </subcategories>
    </Category>
    <Category>
      <id>1391970</id>
      <name>Mystery</name>
      <subcategories>
        <subcategory>
          <id>1392021</id>
          <name>Comedy Thriller</name>
        </subcategory>
        <subcategory>
          <id>1392032</id>
          <name>Detective Film</name>
        </subcategory>
        <subcategory>
          <id>1392053</id>
          <name>Film Noir</name>
        </subcategory>
        <subcategory>
          <id>1392057</id>
          <name>Giallo</name>
        </subcategory>
        <subcategory>
          <id>1392099</id>
          <name>Police Detective Film</name>
        </subcategory>
        <subcategory>
          <id>1392105</id>
          <name>Post-Noir (Modern Noir)</name>
        </subcategory>
        <subcategory>
          <id>1392130</id>
          <name>Romantic Mystery</name>
        </subcategory>
        <subcategory>
          <id>1392184</id>
          <name>Whodunit</name>
        </subcategory>
      </subcategories>
    </Category>
  </categories>
</MovieCategories>

XML Response Example 2

Here's the response to Request Example 4, which asks for the first two movie categories in an XML and French language response.
Requested with http://api.rovicorp.com/data/v1.1/descriptor/moviecategories?apikey=apikey&sig=sig&
count=2&language=fr&format=xml.
<MovieCategories 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.0</build>
  <parameters>
    <apiKey>apikey</apiKey>
    <id i:nil="true" />
    <offset>0</offset>
    <count>2</count>
    <format>xml</format>
    <language>fr</language>
  </parameters>
  <view>
    <offset>0</offset>
    <count>2</count>
    <total>11</total>
  </view>
  <serverName>ubuntu</serverName>
  <startTime>2013-05-20T16:19:24Z</startTime>
  <endTime>2013-05-20T16:19:24Z</endTime>
  <duration>8776</duration>
  <categories>
    <Category>
      <id>1391973</id>
      <name>Autre</name>
    </Category>
    <Category>
      <id>1391955</id>
      <name>Comédie</name>
    </Category>
  </categories>
</MovieCategories>


See Also

↑ Top

Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/Data/descriptor-api/v1.1/descriptor/movie-categories"
Personal tools