V1.MetaData.MovieService.MovieRelease:Images

Jump to: navigation, search

MovieRelease/Images

Returns URLs to images of a movie release along with associated image information. Note: Access to images is governed by your subscription level and geographical location.

IMPORTANT: Creator (author) credit for an image must be displayed with the image if available. For images from Getty Images, the full photographer/collection/owner credit must be displayed next to the image. If space prevents that, you may omit parts of the credit to show just Getty Images or Getty, provided the full credit is displayed at the next reasonable alternative location, even if that is on another screen, if that location exists.

A movierelease/images response sorts movie images by type in the following order:

  1. Poster art
  2. DVD box art
  3. Video box art
  4. DVD set
  5. Any other

Images within each type are sorted by width, from narrow to wide.

Syntax

movierelease/images? upcid=upcid
moviereleaseid=moviereleaseid
&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request images of a release of Being John Malkovich using the release ID.

Request Example 2

Request images using the UPC code.

Request Example 3

Request the first image in the list.

Request Example 4

Request the second image in the list.

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
count No Number of items to be returned. The default is zero, which returns all items after the offset.

Use count and offset to paginate the response.

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).
offset No Number of items at the start of the returned list to skip. The default is zero.

Use count and offset to paginate the response.

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.
viewviewSummary of items returned in a list of items.

Response for MovieRelease/Images

ResponseTypeDescription
images Image [ ] URLs to images of the movie release along with information about the images.

JSON Response Example

The following example has been edited to reduce the length and formatted with extra spaces and carriage returns to make it easy to read.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.3.2.3",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"E247882",
      "format":"json"
   },
   "view":{
      "total":7
   },
   "serverName":"tul1cstw1",
   "startTime":"2010-12-10T22:44:29.8091645Z",
   "endTime":"2010-12-10T22:44:29.8247900Z",
   "duration":15,
   "parentIds":{
      "releaseId":"E247882",
      "upcId":"024543713678"
   },
   "images":[
      {
         "height":100,
         "width":69,
         "formatid":51,
         "url":"http:\/\/actual-url-concealed.jpg",
         "author":null,
         "copyrightOwner":null
      },
      {
         "height":108,
         "width":75,
         "formatid":65,
         "url":"http:\/\/actual-url-concealed.jpg",
         "author":null,
         "copyrightOwner":null
      },
      {
         "height":361,
         "width":250,
         "formatid":69,
         "url":"http:\/\/actual-url-concealed.jpg",
         "author":null,
         "copyrightOwner":null
      }
   ]
}

XML Response Example

The following example has been edited to reduce the length.
<MovieImages xmlns="com.rovicorp.metadataservice" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <build>1.3.2.3</build>
  <parameters>
    <apiKey>apikey</apiKey>
    <id>E247882</id>
    <format>xml</format>
  </parameters>
  <view>
    <total>2</total>
  </view>
  <serverName>tul1cssw2</serverName>
  <startTime>2010-04-26T23:05:35.7346238Z</startTime>
  <endTime>2010-04-26T23:05:35.7346238Z</endTime>
  <duration>15</duration>
  <parentIds>
    <releaseId>E247882</releaseId>
    <upcId>024543713678</upcId>
  </parentIds>
  <images>
    <Image>
      <height>100</height>
      <width>69</width>
      <formatid>51</formatid>
      <url>http://actual-url-concealed.jpg</url>
      <author i:nil="true"/>
      <copyrightOwner i:nil="true"/>
    </Image>
    <Image>
      <height>108</height>
      <width>75</width>
      <formatid>65</formatid>
      <url>http://actual-url-concealed.jpg</url>
      <author i:nil="true"/>
      <copyrightOwner i:nil="true"/>
    </Image>
    <Image>
      <height>361</height>
      <width>250</width>
      <formatid>69</formatid>
      <url>http://actual-url-concealed.jpg</url>
      <author i:nil="true"/>
      <copyrightOwner i:nil="true"/>
    </Image>
  </images>
</MovieImages>


See Also

↑ Top

Personal tools