MovieRelease/Videos

Returns data you can use to construct links to movie trailers hosted by Video Detective, a provider of videos and movie trailers. Trailers are available in all of the formats you need to guarantee high quality previews on web, mobile, iPad, and IPTV.

This request requires the following:

Our Video Experience subscription package.
A developer account with Internet Video Archive, a Video Detective site.
Use of an Internet Video Archive API.

Syntax

movierelease/videos?

upcid=upcid
moviereleaseid=moviereleaseid

&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request data for links to trailers for a release of Being John Malkovich using the release ID.

http://api.rovicorp.com/data/v1/movierelease/videos?apikey=apikey&sig=sig&moviereleaseid=E160870

Request Example 2

Request data for links using the UPC code.

http://api.rovicorp.com/data/v1/movierelease/videos?apikey=apikey&sig=sig&upcid=025195010191

Request Example 3

Request data for links to the first trailer in the list.

http://api.rovicorp.com/data/v1/movierelease/videos?apikey=apikey&sig=sig&upcid=025195010191&count=1

Request Example 4

Request data for links to the second trailer in the list.

http://api.rovicorp.com/data/v1/movierelease/videos?apikey=apikey&sig=sig&upcid=025195010191&offset=1&count=1

Request Parameters

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

Response	Type	Description
build	String	The software release level of the API.
code	Integer	HTTP status code. See the status field for the text part of the code.
duration	Integer	Server processing time in milliseconds. The difference between startTime and endTime.
endTime	String	When the server sent the response (UTC time).
messages	Message [ ]	Elements of a multiple HTTP response status message.
parameters	parameters	List of the parameters included in the request.
parentIds	parentIds	All of the IDs for the requested object that are recognized by the API.
serverName	String	Name of the server that processed the request.
startTime	String	When the server received the request (UTC time).
status	String	Text part of the HTTP status code that is shown in the code field.
view	view	Summary of items returned in a list of items.

Response for MovieRelease/Videos

Response	Type	Description
videos	Video [ ]	Data for constructing links to trailers of the release specified in the request.

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"
   },
   "view":{
      "total":1
   },
   "serverName":"tul1cssw3",
   "startTime":"2011-04-27T18:20:10.3454324Z",
   "endTime":"2011-04-27T18:20:10.3610577Z",
   "duration":15,
   "parentIds":{
      "releaseId":"E160870",
      "upcId":"025195010191"
   },
   "videos":[
      {
         "id":"684272",
         "screenshot":"http:\/\/actual-url-concealed.jpg",
         "provider":"Video Detective",
         "title":"Being John Malkovich"
      }
   ]
}

XML Response Example

Here's an XML response to Request Example 2.

<MovieReleaseVideos 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>
  <view>
    <total>1</total>
  </view>
  <serverName>tul1cssw4</serverName>
  <startTime>2011-04-27T18:21:35.5496925Z</startTime>
  <endTime>2011-04-27T18:21:35.5496925Z</endTime>
  <duration>0</duration>
  <parentIds>
    <releaseId>E160870</releaseId>
    <upcId>025195010191</upcId>
  </parentIds>
  <videos>
    <Video>
      <id>684272</id>
      <screenshot>http://actual-url-concealed.jpg</screenshot>
      <provider>Video Detective</provider>
      <title>Being John Malkovich</title>
    </Video>
  </videos>
</MovieReleaseVideos>

V1.MetaData.MovieService.MovieRelease:Videos

Topics

Search

TOOLBOX

Tools