V1.MetaData.MovieService.MovieRelease:Info

Jump to: navigation, search

MovieRelease/Info

Returns basic information about a movie release plus customized requests for all of the other Movie Release content that is available. These customized requests are designed to make your programming easy and efficient: in a single step you both verify availability of the data and capture the request. You just add your sig parameter and execute the request.

The movierelease/info request also provides an optional argument to include responses from any or all of the other MovieRelease requests. This may return a large amount of data. To speed data transmission, do the following:

  • Request only data that you need to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

movierelease/info? upcid=upcid
moviereleaseid=moviereleaseid 		&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language] [&formatid=formatid]

Request Example 1

Request information about the extended collector's edition of Avatar using the movie release ID.
http://api.rovicorp.com/data/v1/movierelease/info?apikey=apikey&sig=sig&moviereleaseid=E247882

Request Example 2

Request information using the UPC code of the DVD.
http://api.rovicorp.com/data/v1/movierelease/info?apikey=apikey&sig=sig&upcId=024543713678

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.

moviereleaseid Conditional ID of a movie release. Your application can grab movie release IDs from Movie/Releases responses.

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

  • upcId
  • movieReleaseId
upcid Conditional The numbers from the Universal Product Code (UPC) barcode that identifies an item.

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

  • upcId
  • movieReleaseId
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.
formatid No If you specify All or Images in the include parameter, formatid specifies the size and image format of returned images. The format IDs available are shown in the Format IDs table. To select multiple format IDs, specify the IDs as a comma-separated list like this formatid=36,44,51.

Note: Your access to images is governed by your subscription level.

include No Any other Movie Release requests to include in the request. For example, to include the description, add &include=description. For multiple includes, separate the values with commas like this: &include=description,images. You can also include all Movie Release requests with include=all. The possible values are:

For information about a request, please see the documentation for the request.

Reminder: These options may return a large amount of data. To speed data transmission, do the following:

  • Request only data that you need to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.
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.
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 MovieRelease/Info

ResponseTypeDescription
aspect String Video display aspect ratio used by the release.
description description Description of the release, returned only if the request specified an include=description argument.
descriptionUri String The customized MovieRelease/Description request, returned only if a description is available.
featureRating Int MPAA rating of the movie.
features String [ ] Special features included on a release, returned only if the request specified an include=features argument. Features include trailers, interviews, commentaries, etc.
featuresUri String The customized MovieRelease/Features request, returned only if a list of features is available.
formats String [ ] Media and formats used for the release.
ids ids All of the IDs associated with the release that are recognized by the API. The possible IDs are:
  • upcId
  • releaseId
  • movieReleaseId
images Image [ ] URLs to images of the release, along with the size of each image. Returned only if the request specified an include=images argument and your subscription level enables access to images.
imagesUri String The customized MovieRelease/Images request, returned only if images are available.
languages String [ ] Language soundtracks that are available for the movie on the release.
movieId String Movie ID of the movie on the release.
rating Int An editorially assigned rating of the movie from 0 to 10, where 0 is no rating and higher numbers indicate a higher rating.
region Int DVD region code of the release.
releaseDate String Date the movie release was released in YYYY-MM-DD order.
requestedId String The ID in the request that applies to this response object.
screenFormat String Video display technology used by the release to accommodate the aspect ratio.
sides Int Number of DVD sides used on the release.
sound String Audio technology used by the release.
studio String The company that distributed the release.
subtitles String [ ] Languages of the subtitles available on the release.
title String Title of the release.
videos Video [ ] Data for constructing links to trailers for the movie release, returned only if the request specified an include=videos argument.
videosUri String The customized MovieRelease/Videos request, returned only if data is available.

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":"apikey",
    "id":"E247882"
  },
  "serverName":"tul1cssw3",
  "startTime":"2011-04-27T17:22:05.1535180Z",
  "endTime":"2011-04-27T17:22:05.2160192Z",
  "duration":62,
  "release":{
    "ids":{
      "releaseId":"E247882",
      "upcId":"024543713678"
    },
    "movieId":"V  352199",
    "title":"Avatar [Extended Collector's Edition] [3 Discs]",
    "rating":6,
    "featureRating":0,
    "formats":[
      "DVD"
    ],
    "releaseDate":"2010 11 16",
    "languages":[
      "English",
      "Spanish",
      "French"
    ],
    "subtitles":[
      "Spanish"
    ],
    "screenFormat":"WSE",
    "sound":"DD5.1\/DS",
    "aspect":"1.78:1",
    "region":1,
    "sides":3,
    "description":null,
    "descriptionUri":"http:\/\/api.rovicorp.com\/v1\/movierelease\/description?format=json&apikey=apikey&moviereleaseid=E247882",
    "features":null,
    "featuresUri":"http:\/\/api.rovicorp.com\/v1\/movierelease\/features?format=json&apikey=apikey&moviereleaseid=E247882",
    "images":null,
    "imagesUri":null,
    "videos":null,
    "videosUri":"http:\/\/api.rovicorp.com\/v1\/movierelease\/videos?format=json&apikey=apikey&moviereleaseid=E247882",
    "studio":"20th Century Fox",
    "requestedId":"E247882",
  }
}

XML Response Example

Here's an XML response to Request Example 1.
<MovieReleaseDetail 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>apikey</apiKey>
    <id>E247882</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cssw3</serverName>
  <startTime>2011-04-27T17:22:58.1232850Z</startTime>
  <endTime>2011-04-27T17:22:58.1232850Z</endTime>
  <duration>0</duration>
  <release>
    <ids>
      <releaseId>E247882</releaseId>
      <upcId>024543713678</upcId>
    </ids>
    <movieId>V 352199</movieId>
    <title>Avatar [Extended Collector&apos;s Edition] [3 Discs]</title>
    <rating>6</rating>
    <featureRating>0</featureRating>
    <formats xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>DVD</a:string>
    </formats>
    <releaseDate>2010 11 16</releaseDate>
    <languages xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>English</a:string>
      <a:string>Spanish</a:string>
      <a:string>French</a:string>
    </languages>
    <subtitles xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>Spanish</a:string>
    </subtitles>
    <screenFormat>WSE</screenFormat>
    <sound>DD5.1/DS</sound>
    <aspect>1.78:1</aspect>
    <region>1</region>
    <sides>3</sides>
    <description i:nil="true"/>
    <descriptionUri>http://api.rovicorp.com/v1/movierelease/description?format=xml&amp;apikey=apikey&amp;moviereleaseid=E247882</descriptionUri>
    <features xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true"/>
    <featuresUri>http://api.rovicorp.com/v1/movierelease/features?format=xml&amp;apikey=apikey&amp;moviereleaseid=E247882</featuresUri>
    <images i:nil="true"/>
    <imagesUri i:nil="true"/>
    <videos i:nil="true"/>
    <videosUri>http://api.rovicorp.com/v1/movierelease/videos?format=xml&amp;apikey=apikey&amp;moviereleaseid=E247882</videosUri>
    <studio>20th Century Fox</studio>
    <requestedId>E247882</requestedId>
  </release>
</MovieReleaseDetail>


See Also

↑ Top

Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V1.MetaData.MovieService.MovieRelease:Info"
Personal tools