V1.MetaData.MovieService.MovieRelease:Description

Jump to: navigation, search

MovieRelease/Description

Returns the description of a movie release.

Syntax

movierelease/description? upcid=upcid
moviereleaseid=moviereleaseid
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language]

Request Example 1

Request a description of a Being John Malkovich DVD using the release ID.

Request Example 2

Request a description using the UPC code.

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.
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 MovieRelease/Description

ResponseTypeDescription
author String Author of the description.
text String The full text of the description.

JSON Response Example

Here's the response to Request Example 2. 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":"025195010191"
  },
  "serverName":"tul1cssw3",
  "startTime":"2011-04-27T17:35:24.8094961Z",
  "endTime":"2011-04-27T17:35:24.8719973Z",
  "duration":62,
  "parentIds":{
    "releaseId":"E160870",
    "upcId":"025195010191"
  },
  "description":{
    "text":"Would you pay money to journey into the mind of the star of [rovilink=\"V  154933\"]Con Air[\/rovilink], [rovilink=\"V   27323\"]THE KILLING FIELDS[\/rovilink], and [rovilink=\"V   24644\"]In The Line of Fire[\/rovilink]? Puppeteer Craig Schwartz ([rovilink=\"P 16329\"]John Cusack[\/rovilink]) is having money problems, so he takes a temporary job as a file clerk on the seventh-and-a-half floor of a large office building. One day, while rummaging behind a cabinet, he finds a small door that leads to the center of the mind of actor [rovilink=\"P 44846\"]John Malkovich[\/rovilink] (played by, you guessed it, [rovilink=\"P 44846\"]John Malkovich[\/rovilink]). Craig discovers that entering the portal allows him to become [rovilink=\"P 44846\"]John Malkovich[\/rovilink] for a brief spell, and in time he and his beautiful but aloof co-worker Maxine ([rovilink=\"P 37341\"]Catherine Keener[\/rovilink]) get the bright idea to charge admission for the privilege of spending 15 minutes inside the head of a well-known actor. Malkovich realizes that something strange is happening to him, but can do little to stop it, as strangers take over his mind for a quarter-hour at a time. Craig's wife, Lotte ([rovilink=\"P195733\"]Cameron Diaz[\/rovilink]), eventually takes a trip into Malkovich's psyche, and she soon finds herself in love with Maxine, with whom Malkovich has an affair; meanwhile, Maxine in time becomes infatuated with both Craig and Lotte, but only when they're inside Malkovich. [rovilink=\"V  180993\"]Being John Malkovich[\/rovilink] marked the feature-length debut of director [rovilink=\"P263616\"]Spike Jonze[\/rovilink], who previously made acclaimed music videos for [rovilink=\"P319049\"]Weezer[\/rovilink], the [rovilink=\"P  4794\"]Beastie Boys[\/rovilink], and [rovilink=\"P524799\"]the Breeders[\/rovilink], among others.",
    "author":"Mark Deming"
  }
}

XML Response Example

Here's an XML response to Request Example 2.
<MovieReleaseDescription 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>025195010191</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cssw2</serverName>
  <startTime>2011-04-27T17:36:22.3163894Z</startTime>
  <endTime>2011-04-27T17:36:22.3320145Z</endTime>
  <duration>15</duration>
  <parentIds>
    <releaseId>E160870</releaseId>
    <upcId>025195010191</upcId>
  </parentIds>
  <description>
    <text>Would you pay money to journey into the mind of the star of [rovilink=&quot;V 154933&quot;]Con Air[/rovilink], [rovilink=&quot;V 27323&quot;]THE KILLING FIELDS[/rovilink], and [rovilink=&quot;V 24644&quot;]In The Line of Fire[/rovilink]? Puppeteer Craig Schwartz ([rovilink=&quot;P 16329&quot;]John Cusack[/rovilink]) is having money problems, so he takes a temporary job as a file clerk on the seventh-and-a-half floor of a large office building. One day, while rummaging behind a cabinet, he finds a small door that leads to the center of the mind of actor [rovilink=&quot;P 44846&quot;]John Malkovich[/rovilink] (played by, you guessed it, [rovilink=&quot;P 44846&quot;]John Malkovich[/rovilink]). Craig discovers that entering the portal allows him to become [rovilink=&quot;P 44846&quot;]John Malkovich[/rovilink] for a brief spell, and in time he and his beautiful but aloof co-worker Maxine ([rovilink=&quot;P 37341&quot;]Catherine Keener[/rovilink]) get the bright idea to charge admission for the privilege of spending 15 minutes inside the head of a well-known actor. Malkovich realizes that something strange is happening to him, but can do little to stop it, as strangers take over his mind for a quarter-hour at a time. Craig&apos;s wife, Lotte ([rovilink=&quot;P195733&quot;]Cameron Diaz[/rovilink]), eventually takes a trip into Malkovich&apos;s psyche, and she soon finds herself in love with Maxine, with whom Malkovich has an affair; meanwhile, Maxine in time becomes infatuated with both Craig and Lotte, but only when they&apos;re inside Malkovich. [rovilink=&quot;V 180993&quot;]Being John Malkovich[/rovilink] marked the feature-length debut of director [rovilink=&quot;P263616&quot;]Spike Jonze[/rovilink], who previously made acclaimed music videos for [rovilink=&quot;P319049&quot;]Weezer[/rovilink], the [rovilink=&quot;P 4794&quot;]Beastie Boys[/rovilink], and [rovilink=&quot;P524799&quot;]the Breeders[/rovilink], among others.</text>
    <author>Mark Deming</author>
  </description>
</MovieReleaseDescription>


See Also

↑ Top

Personal tools