V1.Metadata.MovieService.Movie:Related

Jump to: navigation, search

Movie/Related

Returns titles of movies that are related to a movie specified in the request. Movies returned are related in one or more of the following ways:

  • Movies related to the movie in the request
  • Movies that spoof the movie in the request
  • Movies spoofed by the movie in the request
  • Movies that feature the movie in the request
  • Movies influenced by the movie in the request
  • Movies that influenced the movie in the request
  • The movie that follows the movie in the request
  • The movie that precedes the movie in the request
  • Movies that are similar to the movie in the request
  • The film series the movie in the request belongs to
  • Movies that are a re-edit of the movie in the request
  • Movies that are a version of the movie in the request

This request may return a large amount of data. To speed data transmission, request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

movie/related? movie=movie
movieid=movieid
cosmoid=cosmoid
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language]

Request Example 1

Request movies related to The Girl Who Played With Fire.

Request Example 2

Use the Cosmo ID to request movies related to Airport 1975.

Request Example 3

Use the movie title to request movies related to Airport 1975 with an XML response format.

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 television series. Cosmo is a database of television information.

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

  • movie
  • movieId
  • cosmoId
movie Conditional Keywords from the title of the movie or TV series. This searches for the most popular title with that combination of words. Replace spaces with plus (+) or percent20 (%20) symbols.

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

  • movie
  • movieId
  • cosmoId
movieid Conditional AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces. When using an AMG Video ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: V+++295550. Your application can grab movie IDs from responses to the following requests:

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

  • movie
  • movieId
  • cosmoId
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.
language No Language of the response data. This request supports only en (English).

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.
parentIdsparentIdsAll of the IDs for the requested object that are recognized by the API.
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.

Response for Movie/Related

ResponseTypeDescription
influenced MovieAbstract [ ] Movies that the movie in the request influenced.
isFeaturedIn MovieAbstract [ ] Movies that feature the movie in the request.
isFollowedBy MovieAbstract [ ] The movie that follows the movie in the request.
isInfluencedBy MovieAbstract [ ] Movies that influenced the movie in the request.
isPartOfSeries MovieAbstract [ ] The film series the movie in the request belongs to.
isReeditedBy MovieAbstract [ ] Movies that are a re-edit of the movie in the request.
isRelatedTo MovieAbstract [ ] Movies related to the movie in the request.
isSpoofedIn MovieAbstract [ ] Movies that spoof the movie in the request.
isSpoofOf MovieAbstract [ ] Movies spoofed by the movie in the request.
isVersionOf MovieAbstract [ ] Movies that are a version of the movie in the request.
precededBy MovieAbstract [ ] The movie that preceded the movie in the request.
similarTo MovieAbstract [ ] Movies that are similar to the movie in the 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.5.1.9",
  "parameters":{
    "apiKey":"4p1k3y",
    "id":"V 500869",
    "format":"json"
  },
  "serverName":"tul1cssw3",
  "startTime":"2011-04-27T21:32:23.3634391Z",
  "endTime":"2011-04-27T21:32:23.3790655Z",
  "duration":15,
  "parentIds":{
    "cosmoId":"12621709",
    "movieId":"V 500869"
  },
  "related":{
    "similarTo":[
      {
        "ids":{
          "cosmoId":null,
          "movieId":"V 56098"
        },
        "title":"Z",
        "directors":[
          {
            "id":"P 15220",
            "name":"Costa-Gavras"
          }
        ],
        "releaseYear":"1969",
        "rating":8
      },
      {
        "ids":{
          "cosmoId":null,
          "movieId":"V 44734"
        },
        "title":"Silkwood",
        "directors":[
          {
            "id":"P104435",
            "name":"Mike Nichols"
          }
        ],
        "releaseYear":"1983",
        "rating":7
      },
      {
        "ids":{
          "cosmoId":null,
          "movieId":"V 267687"
        },
        "title":"Veronica Guerin",
        "directors":[
          {
            "id":"P110432",
            "name":"Joel Schumacher"
          }
        ],
        "releaseYear":"2003",
        "rating":5
      },
      {
        "ids":{
          "cosmoId":null,
          "movieId":"V 337402"
        },
        "title":"Human Trafficking",
        "directors":[
          {
            "id":"P 88380",
            "name":"Christian Duguay"
          }
        ],
        "releaseYear":"2005",
        "rating":5
      }
    ],
    "isFollowedBy":[
      {
        "ids":{
          "cosmoId":null,
          "movieId":"V 503018"
        },
        "title":"The Girl Who Kicked the Hornet's Nest",
        "directors":[
          {
            "id":"P233237",
            "name":"Daniel Alfredson"
          }
        ],
        "releaseYear":"2009",
        "rating":5
      }
    ],
    "precededBy":[
      {
        "ids":{
          "cosmoId":null,
          "movieId":"V 481689"
        },
        "title":"The Girl With the Dragon Tattoo",
        "directors":[
          {
            "id":"P205616",
            "name":"Niels Arden Oplev"
          }
        ],
        "releaseYear":"2009",
        "rating":7
      }
    ]
  }
}

XML Response Example

Here's the XML response to Request Example 1.
<MovieRelated 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.5.1.9</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>V 500869</id>
    <format>json,xml</format>
  </parameters>
  <serverName>tul1cssw3</serverName>
  <startTime>2011-04-27T22:21:17.5637884Z</startTime>
  <endTime>2011-04-27T22:21:17.5950390Z</endTime>
  <duration>31</duration>
  <parentIds>
    <cosmoId>12621709</cosmoId>
    <movieId>V 500869</movieId>
  </parentIds>
  <related>
    <similarTo>
      <MovieAbstract>
        <ids>
          <cosmoId i:nil="true"/>
          <movieId>V 56098</movieId>
        </ids>
        <title>Z</title>
        <directors>
          <Director>
            <id>P 15220</id>
            <name>Costa-Gavras</name>
          </Director>
        </directors>
        <releaseYear>1969</releaseYear>
        <rating>8</rating>
      </MovieAbstract>
      <MovieAbstract>
        <ids>
          <cosmoId i:nil="true"/>
          <movieId>V 44734</movieId>
        </ids>
        <title>Silkwood</title>
        <directors>
          <Director>
            <id>P104435</id>
            <name>Mike Nichols</name>
          </Director>
        </directors>
        <releaseYear>1983</releaseYear>
        <rating>7</rating>
      </MovieAbstract>
      <MovieAbstract>
        <ids>
          <cosmoId i:nil="true"/>
          <movieId>V 267687</movieId>
        </ids>
        <title>Veronica Guerin</title>
        <directors>
          <Director>
            <id>P110432</id>
            <name>Joel Schumacher</name>
          </Director>
        </directors>
        <releaseYear>2003</releaseYear>
        <rating>5</rating>
      </MovieAbstract>
      <MovieAbstract>
        <ids>
          <cosmoId i:nil="true"/>
          <movieId>V 337402</movieId>
        </ids>
        <title>Human Trafficking</title>
        <directors>
          <Director>
            <id>P 88380</id>
            <name>Christian Duguay</name>
          </Director>
        </directors>
        <releaseYear>2005</releaseYear>
        <rating>5</rating>
      </MovieAbstract>
    </similarTo>
    <isFollowedBy>
      <MovieAbstract>
        <ids>
          <cosmoId i:nil="true"/>
          <movieId>V 503018</movieId>
        </ids>
        <title>The Girl Who Kicked the Hornet&apos;s Nest</title>
        <directors>
          <Director>
            <id>P233237</id>
            <name>Daniel Alfredson</name>
          </Director>
        </directors>
        <releaseYear>2009</releaseYear>
        <rating>5</rating>
      </MovieAbstract>
    </isFollowedBy>
    <precededBy>
      <MovieAbstract>
        <ids>
          <cosmoId i:nil="true"/>
          <movieId>V 481689</movieId>
        </ids>
        <title>The Girl With the Dragon Tattoo</title>
        <directors>
          <Director>
            <id>P205616</id>
            <name>Niels Arden Oplev</name>
          </Director>
        </directors>
        <releaseYear>2009</releaseYear>
        <rating>7</rating>
      </MovieAbstract>
    </precededBy>
  </related>
</MovieRelated>


See Also

↑ Top

Personal tools