V1.MetaData.VideoService.Video:Related

Jump to: navigation, search

Video/Related

Returns movies, series, seasons, and programs that have a relationship with a movie, series, season, or program specified in the request.

The show in the request . . .

  • Is similar to
  • Is related to
  • Is remade as
  • Features
  • Is featured in   
  • Is a spoof of
  • Is spoofed by
  • Is a version of
  • Is followed by
  • Is preceded by   
  • Is a re-edit of
  • Is re-edited by
  • Is a spinoff of
  • Influenced
  • Was influenced by   
  • Includes
  • Is in the series of

. . . the movies, series, seasons, and programs in the response.

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

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

Request Example 1

Request names of movies and programs related to the movie The Girl Who Played With Fire.
http://api.rovicorp.com/data/v1/video/related?apikey=apikey&sig=sig&
video=The+Girl+Who+Played+With+Fire

Request Example 2

Request an XML response with the names of movies and programs related to the movie The Girl Who Played With Fire.
http://api.rovicorp.com/data/v1/video/related?apikey=apikey&sig=sig&cosmoid=12621709&format=xml

Request Example 3

Request names of movies and programs related to the American TV Series The Office.
http://api.rovicorp.com/data/v1/video/related?apikey=apikey&sig=sig&cosmoid=4477399

Request Example 4

Request names of movies and programs related to the X-Files episode Jump the Shark.
http://api.rovicorp.com/data/v1/video/related?apikey=apikey&sig=sig&cosmoid=3470193

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.
parentIdsparentIdsAll of the IDs for the requested movie or program that are recognized by the Video Service.
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 Video/Related

The Video Service returns only categories that have content and lists items in each category in order of release year.

ResponseTypeDescription
featuredIn VideoAbstract [ ] Shows that feature the movie or program in the request.
features VideoAbstract [ ] Shows that the movie or program in the request feature.
followedBy VideoAbstract [ ] The show that follows the movie or program in the request.
includes VideoAbstract [ ] Seasons or shows that are in the series specified in the request.
influenced VideoAbstract [ ] Shows that the movie or program in the request influenced.
influencedBy VideoAbstract [ ] Shows that influenced the movie or program in the request.
partOfSeries VideoAbstract [ ] The series the movie or program in the request is part of.
precededBy VideoAbstract [ ] The show that preceded the movie or program in the request.
reeditedBy VideoAbstract [ ] Shows that are a re-edit of the movie or program in the request.
reeditedFrom VideoAbstract [ ] The show that the movie or program in the request is a re-edit of.
relatedTo VideoAbstract [ ] Shows related to the movie or program in the request.
remadeAs VideoAbstract [ ] Shows that remade the movie or program in the request.
similarTo VideoAbstract [ ] Shows that are similar to the movie or program in the request.
spinOffOf VideoAbstract [ ] The show that the movie or program in the request has been spun off from.
spoofedIn VideoAbstract [ ] Shows that spoof the movie or program in the request.
spoofOf VideoAbstract [ ] Shows that the movie or program in the request spoof.
versionOf VideoAbstract [ ] Shows that the movie or program in the request is a version of.

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.0.1",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"The Girl Who Played With Fire",
   },
   "serverName":"tul1cstw1",
   "startTime":"2011-08-16T00:02:48.6867357Z",
   "endTime":"2011-08-16T00:02:48.7023607Z",
   "duration":15,
   "parentIds":{
      "cosmoId":"12621709"
   },
   "related":{
      "similarTo":[
         {
            "ids":{
               "cosmoId":"1219106",
               "movieId":"V 56098"
            },
            "title":"Z",
            "directors":[
               {
                  "id":"P 15220",
                  "name":"Costa-Gavras"
               }
            ],
            "releaseYear":"1969",
            "rating":8
         },
         {
            "ids":{
               "cosmoId":"61705",
               "movieId":"V 44734"
            },
            "title":"Silkwood",
            "directors":[
               {
                  "id":"P104435",
                  "name":"Mike Nichols"
               }
            ],
            "releaseYear":"1983",
            "rating":7
         },
         {
            "ids":{
               "cosmoId":"3995359",
               "movieId":"V 267687"
            },
            "title":"Veronica Guerin",
            "directors":[
               {
                  "id":"P110432",
                  "name":"Joel Schumacher"
               }
            ],
            "releaseYear":"2003",
            "rating":5
         },
         {
            "ids":{
               "cosmoId":"4896426",
               "movieId":"V 337402"
            },
            "title":"Human Trafficking",
            "directors":[
               {
                  "id":"P 88380",
                  "name":"Christian Duguay"
               }
            ],
            "releaseYear":"2005",
            "rating":5
         }
      ],
      "followedBy":[
         {
            "ids":{
               "cosmoId":"18635139",
               "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":"10308390",
               "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 response to Request Example 2.
<VideoRelated 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.0.1</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>12621709</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cstw3</serverName>
  <startTime>2011-08-15T23:59:01.1605035Z</startTime>
  <endTime>2011-08-15T23:59:01.1761285Z</endTime>
  <duration>15</duration>
  <parentIds>
    <cosmoId>12621709</cosmoId>
  </parentIds>
  <related>
    <similarTo>
      <VideoAbstract>
        <ids>
          <cosmoId>1219106</cosmoId>
          <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>
      </VideoAbstract>
      <VideoAbstract>
        <ids>
          <cosmoId>61705</cosmoId>
          <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>
      </VideoAbstract>
      <VideoAbstract>
        <ids>
          <cosmoId>3995359</cosmoId>
          <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>
      </VideoAbstract>
      <VideoAbstract>
        <ids>
          <cosmoId>4896426</cosmoId>
          <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>
      </VideoAbstract>
    </similarTo>
    <followedBy>
      <VideoAbstract>
        <ids>
          <cosmoId>18635139</cosmoId>
          <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>
      </VideoAbstract>
    </followedBy>
    <precededBy>
      <VideoAbstract>
        <ids>
          <cosmoId>10308390</cosmoId>
          <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>
      </VideoAbstract>
    </precededBy>
  </related>
</VideoRelated>


See Also

↑ Top

Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V1.MetaData.VideoService.Video:Related"
Personal tools