Data/descriptor-api/v1.1/descriptor/significant-movies

Jump to: navigation, search

Descriptor/SignificantMovies

Returns the current top movies and TV shows in a movie genre or subgenre. The list changes over time and, by design, is limited to a maximum of 100 per genre or subgenre.

Syntax

descriptor/significantmovies?apikey=apikey&sig=sig&genreids=genreids [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request the top movies and TV shows in the Western and Reality Show [TV] genres.

Request Example 2

Request the top movie or TV show in the Western genre.

Request Example 3

Request the number two movie or TV show in the Western genre in an XML response.

Request Parameters

Sort none.gif  Click to re-sort

Parameter Required Description
apikey Yes Access code that authorizes your request for data from Rovi.
genreids Yes Genre ID or subgenre ID. You can get IDs of movie genres and subgenres from Descriptor/Genres or Descriptor/MovieGenres.

Replace any spaces in an ID with plus (+) or percent20 (%20) symbols. To specify multiple IDs, use a comma-separated list, like this: genreids=D+++646,D+++647.

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.

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. The current release of the API supports only US.
format No Format of the returned data: json or xml. The default is JSON.
language No Language of the response data. This request supports only en (English).
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/SignificantMovies

ResponseTypeDescription
movies SignificantMovie [ ] Top movies and TV shows in the genres or subgenres specified in the request.

JSON Response Example

Here's the response to Request Example 2, which asks for the top movie or TV show in the Western genre. The response has been formatted with extra space and carriage returns to make it easy to read.
Requested with http://api.rovicorp.com/data/v1.1/descriptor/significantmovies?apikey=apikey&sig=sig&
genreids=D+++656&count=1
.
{
  "status":"ok",
  "code":200,
  "messages":null,
  "build":"1.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":"D   656",
    "offset": 0,
    "count": 1,
  },
  "view":{
    "offset": 0,
    "count": 1,
    "total": 163
  },
  "serverName":"tul1cssw1",
  "startTime":"2011-04-28T23:52:55.2471936Z",
  "endTime":"2011-04-28T23:52:55.2940689Z",
  "duration":46,
  "movies":[
    {
      "genre":{
        "id":"D   656",
        "name":"Western"
      },
      "rank":9,
      "id":"V     6029",
      "title":"Blazing Saddles",
      "releaseYear":"1974",
      "thumbnail":"http:\/\/actual-url-concealed.jpg",
      "genres":[
        {
          "id":"D   648",
          "name":"Comedy",
          "weight":9
        },
        {
          "id":"D   656",
          "name":"Western",
          "weight":5
        }
      ]
    }
  ]
}

XML Response Example

Here's the response to Request Example 3, which asks for the number two movie or TV show in the Western genre in an XML response.
Requested with http://api.rovicorp.com/data/v1.1/descriptor/significantmovies?apikey=apikey&sig=sig&
genreids=D+++656&count=1&offset=1&format=xml
.
<SignificantMovies 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>D   656</id>
    <offset>1</offset>
    <count>1</count>
    <format>xml</format>
  </parameters>
  <view>
    <offset>1</offset>
    <count>1</count>
    <total>163</total>
  </view>
  <serverName>tul1cssw2</serverName>
  <startTime>2011-10-10T22:09:50.6052904Z</startTime>
  <endTime>2011-10-10T22:09:50.6677896Z</endTime>
  <duration>62</duration>
  <movies>
    <SignificantMovie>
      <genre>
        <id>D   656</id>
        <name>Western</name>
      </genre>
      <rank>9</rank>
      <id>V    54529</id>
      <title>The Wild Bunch</title>
      <releaseYear>1969</releaseYear>
      <thumbnail>http://actual-url-concealed.jpg</thumbnail>
      <genres>
        <Genre>
          <id>D   656</id>
          <name>Western</name>
          <weight>5</weight>
        </Genre>
      </genres>
    </SignificantMovie>
  </movies>
</SignificantMovies>


See Also

↑ Top

Personal tools