Descriptor/MovieGenres

Returns the movie genres and subgenres recognized by Rovi DVDs.

Syntax

descriptor/moviegenres?apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language]

Request Example 1

Request movie genre information.

http://api.rovicorp.com/data/v1/descriptor/moviegenres?apikey=apikey&sig=sig

Request Example 2

Request movie genre information with subgenres.

http://api.rovicorp.com/data/v1/descriptor/moviegenres?apikey=apikey&sig=sig&include=subgenres

Request Example 3

Request movie genre information with subgenres in an XML response.

http://api.rovicorp.com/data/v1/descriptor/moviegenres?apikey=apikey&sig=sig&include=subgenres& format=xml

Request Parameters

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.
country	No	Country of the language of the response. The current release of the API supports only US.
format	No	Format of the returned data: json or xml. The default is JSON.
include	No	The subgenres request. To include subgenres in the response, add `include=subgenres`.
language	No	Language of the response data. This request supports only en (English).

Response

Response Header

Response	Type	Description
build	String	The software release level of the API.
code	Integer	HTTP status code. See the status field for the text part of the code.
duration	Integer	Server processing time in milliseconds. The difference between startTime and endTime.
endTime	String	When the server sent the response (UTC time).
messages	Message [ ]	Elements of a multiple HTTP response status message.
parameters	parameters	List of the parameters included in the request.
serverName	String	Name of the server that processed the request.
startTime	String	When the server received the request (UTC time).
status	String	Text part of the HTTP status code that is shown in the code field.
view	view	Summary of items returned in a list of items.

Response for Descriptor/MovieGenres

Response	Type	Description
genres	Genre [ ]	Movie genres and, if requested, subgenres in each genre.

Response Example 1

Here's the first two genres returned for Request Example 1. This response has been edited to reduce the length and formatted to make it easy to read.

{
  "status":"ok",
  "code":200,
  "messages":null,
  "build":"1.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":null
  },
  "view":{
    "total":41
  },
  "serverName":"tul1cssw4",
  "startTime":"2011-04-28T23:13:05.4256061Z",
  "endTime":"2011-04-28T23:13:05.4256061Z",
  "duration":0,
  "genres":[
    {
      "id":"D  646",
      "name":"Action",
      "type":"Movie Genre"
    },
    {
      "id":"D  995",
      "name":"Adult",
      "type":"Movie Genre"
    }
  ]
}

Response Example 2

Here's the first genre and first two subgenres returned for Request Example 2.

{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.7.2.5",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":null,
      "include":"subgenres"
   },
   "view":{
      "total":41
   },
   "serverName":"tul1cssw1",
   "startTime":"2011-10-07T01:09:59.7807707Z",
   "endTime":"2011-10-07T01:09:59.7807707Z",
   "duration":0,
   "genres":[
      {
         "id":"D 646",
         "name":"Action",
         "type":"Movie Genre",
         "subgenres":[
            {
               "id":"D 513",
               "name":"Action Comedy",
               "type":"Movie SubGenre"
            },
            {
               "id":"D 509",
               "name":"Action Thriller",
               "type":"Movie SubGenre"
            }
         ]
      }
   ]
}

XML Response Example

Here's the first genre and first two subgenres returned for Request Example 3. It has been edited to reduce the length.

<MovieGenres 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 i:nil="true"/>
    <include>subgenres</include>
    <format>xml</format>
  </parameters>
  <view>
    <total>41</total>
  </view>
  <serverName>tul1cssw4</serverName>
  <startTime>2011-10-07T01:14:17.6829635Z</startTime>
  <endTime>2011-10-07T01:14:17.6985884Z</endTime>
  <duration>15</duration>
  <genres>
    <Genre>
      <id>D 646</id>
      <name>Action</name>
      <type>Movie Genre</type>
      <subgenres>
        <subgenre>
          <id>D 513</id>
          <name>Action Comedy</name>
          <type>Movie SubGenre</type>
        </subgenre>
        <subgenre>
          <id>D 509</id>
          <name>Action Thriller</name>
          <type>Movie SubGenre</type>
        </subgenre>
      </subgenres>
    </Genre>
  </genres>
</MovieGenres>

V1.MetaData.MusicService.Descriptor:MovieGenres

Topics

Search

TOOLBOX

Tools