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:
movierelease/info? | upcid=upcid moviereleaseid=moviereleaseid |
&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language] [&formatid=formatid] [&imagecount=imagecount] [&imageoffset=imageoffset] [&imagesize=imagesize] [&imagesort=imagesort] |
Click to re-sort
Parameter | Required | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||
sig | Yes | A calculated, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three ASCII strings:
Express the alpha hex digits as lower case. 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 | Conditional | The numbers from the Universal Product Code (UPC) barcode that identifies an item.
Condition: The request must contain just one of these parameters:
| ||||||||||||
country | No | Country the language parameter applies to. 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 file format of returned images. Select the format IDs you want from the Format IDs table.
Specify multiple format IDs in a comma-separated list, like this: formatid=36,44,51. If you also specify imagesize, returned images meet a combination of one formatid and one imagesize filter. Note: Your access to images is governed by your subscription level. | ||||||||||||
imagecount | No | If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.
Use imagecount and imageoffset to paginate images in the response. | ||||||||||||
imageoffset | No | If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero.
Use imagecount and imageoffset to paginate images in the response. | ||||||||||||
imagesize | No | If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
If you also specify formatid, returned images meet a combination of one formatid and one imagesize filter. Note: Your access to images is governed by your subscription level. | ||||||||||||
imagesort | No | If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images. Images can be sorted in ascending or descending order by the following properties:
Specify a descending sort order with a minus (-) sign, like this: imagesort=-width. Note: Your access to images is governed by your subscription level. multi and imagesort cannot be used in the same request, only one or the other is permitted | ||||||||||||
include | No | Any other Movie Release requests to include in the request. For example, to include the description, add &include=description.
You can specify multiple includes in either of the following ways:
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:
| ||||||||||||
language | No | Language of the response data. This request supports only en (English). |
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 | The parameters that were included in the request. |
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, which is shown in the code field. |
Response | Type | Description |
---|---|---|
aspect | string | Video display aspect ratio used by the release. |
chapters | string [ ] | Chapters of the movie in the movie release, returned only if the request specified an include=chapters argument. |
chaptersUri | string | The customized MovieRelease/Chapters request, returned only if chapters data is available. |
collection | collection | Links to information about the movies, series, seasons, and episodes included in a collection on a release, returned only if the request specified an include=collection argument. |
collectionUri | string | The customized MovieRelease/Collection request, returned only if the data is available. |
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. |
directors | Director [ ] | Directors of the movie or TV series, listed alphabetically in order of last name. |
featureRating | integer | 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. |
genres | Genre [ ] | Genres that apply to the movie, along with a weighting that reflects the relative importance of each genre.
Genres are sorted in order of importance (highest to lowest weight) and, within the same weight, alphabetically by genre name. |
ids | ids | All of the IDs associated with the release that are recognized by the API. The possible IDs are:
|
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. |
programType | string | Type of program:
|
rating | integer | An editorially assigned rating of the movie from 0 to 9, where 0 is no rating and higher numbers indicate a higher rating. |
region | integer | 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 | integer | 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. |