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

Jump to: navigation, search

MovieRelease/Chapters

Returns a list of the chapters in a movie release.

Most DVDs and Blu-rays provide a menu of chapters that make it easy to replay or skip forward through the content in the release.

Syntax

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

Request Example 1

Request the chapters on a release of Avatar using the release ID.

Request Example 2

Request the chapters 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, 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
count No Number of items to be returned. The default is zero, which returns all items after the offset.
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).
offset No Number of items at the start of the available data to skip. The default is zero.

Use count and offset to paginate the data that is available to be returned.

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

Response for MovieRelease/Chapters

ResponseTypeDescription
chapters string [ ] Chapters in the release.

JSON Response Example

Here's the response to Request Example 1, which asks for the chapters in a release of Avatar using the release ID. The response is formatted with extra spaces and carriage returns to make it easy to read.
Requested with http://api.rovicorp.com/data/v1.1/movierelease/chapters?apikey=apikey&sig=sig&
moviereleaseid=E247882
.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"024543713678",
      "format":"json"
   },
   "view":{
      "total":37
   },
   "serverName":"tul1cssrcs5.corporate.local",
   "startTime":"2015-05-18T14:24:04Z",
   "endTime":"2015-05-18T14:24:04Z",
   "duration":5,
   "parentIds":{
      "releaseId":"E247882",
      "upcId":"024543713678"
   },
   "chapters":[
      "Disc #1 -- Avatar",
      "1. A New World [:02]",
      "2. You Are Not in Kansas Anymore [1:41]",
      "3. \"This is Your Avatar Now, Jake.\" [4:02]",
      "4. \"This is Why We're Here...\" [:32]",
      "5. First Awakening [1:35]",
      "6. Colonel Quaritch [4:11]",
      "7. First Sortie [1:55]",
      "8. Thanator Chase [5:59]",
      "9. A Sign [3:59]",
      "10. Viperwolves [:15]",
      "11. Neytiri [:38]",
      "12. The Omaticaya Clan [:31]",
      "13. Covert Report [:10]",
      "14. The Hallelujah Mountains [1:16]",
      "15. Learn Fast or Die [:13]",
      "16. Banshee Rookery [:39]",
      "17. First Flight [3:55]",
      "18. Last Shadow [1:51]",
      "19. A Son of the Omatic'aya [2:10]",
      "Disc #2 -- Avatar",
      "1. Willow Glade Destruction [6:37]",
      "2. \"You Will Never Be One of the People\" [:14]",
      "3. Assault on Home Tree [1:36]",
      "4. Aftermath [1:49]",
      "5. Escape From Hell's Gate [1:03]",
      "6. \"There's Something We Gotta Do... [1:50]",
      "7. Toruk Macto [6:36]",
      "8. \"She's Real\" [3:42]",
      "9. Recruiting the Clans [5:39]",
      "10. Preamble to Battle [1:37]",
      "11. Battle For Pandora [3:06]",
      "12. Fall of the Heroes [3:26]",
      "13. Eywa [3:28]",
      "14. Quaritch Fight [2:39]",
      "15. \"I See You\" [1:48]",
      "16. End Credits [6:05]"
   ]
}

XML Response Example

Here's an XML response to Request Example 1, which asks for the chapters on a release of Avatar using the release ID.
Requested with http://api.rovicorp.com/data/v1.1/movierelease/chapters?apikey=apikey&sig=sig&
moviereleaseid=E247882&format=xml
.
<MovieReleaseChapters
   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>4p1k3y</apiKey>
        <id>024543713678</id>
        <format>xml</format>
    </parameters>
    <view>
        <total>37</total>
    </view>
    <serverName>tul1cssrcs7.corporate.local</serverName>
    <startTime>2015-05-18T14:25:29Z</startTime>
    <endTime>2015-05-18T14:25:29Z</endTime>
    <duration>4</duration>
    <parentIds>
        <releaseId>E247882</releaseId>
        <upcId>024543713678</upcId>
    </parentIds>
    <chapters>
        <a:string>Disc #1 -- Avatar</a:string>
        <a:string>1. A New World [:02]</a:string>
        <a:string>2. You Are Not in Kansas Anymore [1:41]</a:string>
        <a:string>3. "This is Your Avatar Now, Jake." [4:02]</a:string>
        <a:string>4. "This is Why We're Here..." [:32]</a:string>
        <a:string>5. First Awakening [1:35]</a:string>
        <a:string>6. Colonel Quaritch [4:11]</a:string>
        <a:string>7. First Sortie [1:55]</a:string>
        <a:string>8. Thanator Chase [5:59]</a:string>
        <a:string>9. A Sign [3:59]</a:string>
        <a:string>10. Viperwolves [:15]</a:string>
        <a:string>11. Neytiri [:38]</a:string>
        <a:string>12. The Omaticaya Clan [:31]</a:string>
        <a:string>13. Covert Report [:10]</a:string>
        <a:string>14. The Hallelujah Mountains [1:16]</a:string>
        <a:string>15. Learn Fast or Die [:13]</a:string>
        <a:string>16. Banshee Rookery [:39]</a:string>
        <a:string>17. First Flight [3:55]</a:string>
        <a:string>18. Last Shadow [1:51]</a:string>
        <a:string>19. A Son of the Omatic'aya [2:10]</a:string>
        <a:string>Disc #2 -- Avatar</a:string>
        <a:string>1. Willow Glade Destruction [6:37]</a:string>
        <a:string>2. "You Will Never Be One of the People" [:14]</a:string>
        <a:string>3. Assault on Home Tree [1:36]</a:string>
        <a:string>4. Aftermath [1:49]</a:string>
        <a:string>5. Escape From Hell's Gate [1:03]</a:string>
        <a:string>6. "There's Something We Gotta Do... [1:50]</a:string>
        <a:string>7. Toruk Macto [6:36]</a:string>
        <a:string>8. "She's Real" [3:42]</a:string>
        <a:string>9. Recruiting the Clans [5:39]</a:string>
        <a:string>10. Preamble to Battle [1:37]</a:string>
        <a:string>11. Battle For Pandora [3:06]</a:string>
        <a:string>12. Fall of the Heroes [3:26]</a:string>
        <a:string>13. Eywa [3:28]</a:string>
        <a:string>14. Quaritch Fight [2:39]</a:string>
        <a:string>15. "I See You" [1:48]</a:string>
        <a:string>16. End Credits [6:05]</a:string>
    </chapters>
</MovieReleaseChapters>


See Also

↑ Top

Personal tools