MovieRelease/Collection

Returns movie/info links to the movies, series, seasons, and episodes included in a collection on a release.

Syntax

movierelease/collection?

upcid=upcid
moviereleaseid=moviereleaseid

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

Request Example 1

Request information about the movies in Star Wars Trilogy: Episodes I-III.

http://api.rovicorp.com/data/v1.1/movierelease/collection?apikey=apikey&sig=sig&
moviereleaseid=E317171

Request Example 2

Make the request using the UPC code.

http://api.rovicorp.com/data/v1.1/movierelease/collection?apikey=apikey&sig=sig&upcid=024543876229

Request Example 3

Request information about the seasons and episodes in the series Star Wars: The Clone Wars - The Complete Seasons 1-5 [Collector's Edition].

http://api.rovicorp.com/data/v1.1/movierelease/collection?apikey=apikey&sig=sig&moviereleaseid=E316501

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, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three ASCII 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. 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` `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 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.
language	No	Language of the response data. This request supports only en (English).

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	The parameters that were 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, which is shown in the code field.
view	view	Summary of items returned in a list of items.

Response for MovieRelease/Collection

Response	Type	Description
movieIds	MovieId [ ]	Links to information about the movies in the collection.
seriesIds	SeriesId [ ]	Links to information about the series in the collection.
seasonIds	SeasonId [ ]	Links to information about the series seasons in the collection.
episodeIds	EpisodeId [ ]	Links to information about the episodes in the collection.

JSON Response Example

Here's the response to Request Example 1, which asks about Star Wars Trilogy: Episodes I-III. The response has been formatted with extra spaces and carriage returns to make it easy to read.

Requested with http://api.rovicorp.com/data/v1.1/movierelease/collection?apikey=apikey&sig=sig&
moviereleaseid=E317171.

{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"apikey",
      "id":"E317171",
      "format":"json"
   },
   "view":{
      "total":1
   },
   "serverName":"tul1cssrcs10.corporate.local",
   "startTime":"2015-07-09T19:54:01Z",
   "endTime":"2015-07-09T19:54:01Z",
   "duration":4,
   "parentIds":{
      "releaseId":"E317171",
      "upcId":"024543876229"
   },
   "collection":{
      "movieIds":[
         {
            "cosmoId":"2977662",
            "movieId":"V   179455",
            "movieUri":"http://api.rovicorp.com/data/v1.1/movie/info?format=json&apikey=apikey&movieid=V+++179455"
         },
         {
            "cosmoId":"3849335",
            "movieId":"V   261809",
            "movieUri":"http://api.rovicorp.com/data/v1.1/movie/info?format=json&apikey=apikey&movieid=V+++261809"
         },
         {
            "cosmoId":"4818189",
            "movieId":"V   286686",
            "movieUri":"http://api.rovicorp.com/data/v1.1/movie/info?format=json&apikey=apikey&movieid=V+++286686"
         }
      ],
      "seriesIds":null,
      "seasonIds":null,
      "episodeIds":null
   }
}

XML Response Example

Here's the XML response to Request Example 1, which asks about Star Wars Trilogy: Episodes I-III.

Requested with http://api.rovicorp.com/data/v1.1/movierelease/collection?apikey=apikey&sig=sig&
moviereleaseid=E317171&format=xml.

<MovieReleaseCollection
    xmlns="com.rovicorp.metadataservice"
    xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
    xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <status>ok</status>
    <code>200</code>
    <messages i:nil="true" />
    <build>1.0</build>
    <parameters>
        <apiKey>apikey</apiKey>
        <id>E317171</id>
        <format>xml</format>
    </parameters>
    <view>
        <total>1</total>
    </view>
    <serverName>tul1cssrcs1.corporate.local</serverName>
    <startTime>2015-07-09T19:18:41Z</startTime>
    <endTime>2015-07-09T19:18:41Z</endTime>
    <duration>4</duration>
    <parentIds>
        <releaseId>E317171</releaseId>
        <upcId>024543876229</upcId>
    </parentIds>
    <collection>
        <movieIds>
            <MovieId>
                <cosmoId>2977662</cosmoId>
                <movieId>V   179455</movieId>
                <movieUri>http://api.rovicorp.com/data/v1.1/movie/info?format=xml&apikey=apikey&movieid=V+++179455</movieUri>
            </MovieId>
            <MovieId>
                <cosmoId>3849335</cosmoId>
                <movieId>V   261809</movieId>
                <movieUri>http://api.rovicorp.com/data/v1.1/movie/info?format=xml&apikey=apikey&movieid=V+++261809</movieUri>
            </MovieId>
            <MovieId>
                <cosmoId>4818189</cosmoId>
                <movieId>V   286686</movieId>
                <movieUri>http://api.rovicorp.com/data/v1.1/movie/info?format=xml&apikey=apikey&movieid=V+++286686</movieUri>
            </MovieId>
        </movieIds>
        <seriesIds i:nil="true" />
        <seasonIds i:nil="true" />
        <episodeIds i:nil="true" />
    </collection>
</MovieReleaseCollection>

Data/movie-api/v1.1/movie-release/collection

Topics

Search

TOOLBOX

Tools