Data/movie-api/v1.1/movie/synopsis

Jump to: navigation, search

Movie/Synopsis

Returns one of three types of a synopsis of a movie or TV series:

To return this type of synopsis...DescriptionSpecify this synopsistype...
longBrief description, which may be extended slightly with a more info link to an extended synopsis.synopsistype=long
extendedTrailing part of a long synopsis, meant to be appended to a long synopsis. By itself, an extended synopsis does not necessarily make sense.synopsistype=extended
synopsisA plot synopsis, usually a complete summary, often created by a Rovi Editor, who may include IDs of cast and other movies and TV series mentioned in the synopsis. Synopsis is always longer than Long Synopsis.None (omit synopsistype)

Note: To return both the long and extended synopsis in the same response, use the Movie/Info request instead.

Syntax

movie/synopsis? movie=movie
movieid=movieid
cosmoid=cosmoid
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language] [&synopsistype=synopsistype]

Request Example 1

Request a synopsis for the movie Grease using the movie ID.

Request Example 2

Request a synopsis using the title of the movie.

Request Example 3

Request a long synopsis for the movie D.O.A.

Request Example 4

Request an extended synopsis for the movie D.O.A.

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.

cosmoid Conditional Cosmo database ID for a movie or television series. Cosmo is a database of television information.

Condition: The request must contain just one of these parameters:

  • movie
  • movieId
  • cosmoId
movie Conditional Keywords from the title of the movie or TV series. This searches for the most popular title with that combination of words. Replace spaces with plus (+) or percent20 (%20) symbols.

Condition: The request must contain just one of these parameters:

  • movie
  • movieId
  • cosmoId
movieid Conditional AMG ID of a movie or TV series, consisting of the letter V followed by 9 digits with leading spaces. When using an AMG Video ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: V+++295550. Your application can grab movie IDs from responses to the following requests:

Condition: The request must contain just one of these parameters:

  • movie
  • movieId
  • cosmoId
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).
synopsistype No Type of synopsis:
  • long
Brief description of a movie, which may be extended slightly with a more info link and then appending the extended synopsis.
  • extended
Trailing part of a long synopsis, meant to be appended to a long synopsis. By itself, an extended synopsis does not necessarily make sense.

Note: To return both the long and extended synopsis in the same response, use the Movie/Info request.

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.

Response for Movie/Synopsis

ResponseTypeDescription
author string Author of the synopsis.
text string The text of the synopsis, long synopsis, or extended synopsis.

Response Example 1

Here's the response to Request Example 1, which asks for a synopsis for the movie Grease. 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/movie/synopsis?apikey=apikey&sig=sig&movieid=V++++20546.
{
  "status":"ok",
  "code":200,
  "messages":null,
  "build":"1.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":"V   20546"
  },
  "serverName":"tul1cssw3",
  "startTime":"2011-04-27T16:42:11.2638062Z",
  "endTime":"2011-04-27T16:42:11.2794315Z",
  "duration":15,
  "parentIds":{
    "cosmoId":"262068",
    "movieId":"V   20546"
  },
  "synopsis":{
    "text":"\"Grease,\" said the poster and the [rovilink=\"P 26707\"]Barry Gibb[\/rovilink] song, \"is the word.\" Transferring its setting from Chicago to sunny California, and adding a dash of [rovilink=\"D\"]disco[\/rovilink] to the ersatz '50s score, producer [rovilink=\"P 84236\"]Allan Carr[\/rovilink] and director [rovilink=\"P 97609\"]Randal Kleiser[\/rovilink] turned this long-running [rovilink=\"P119002\"]Jim Jacobs[\/rovilink]-[rovilink=\"P175060\"]Warren Casey[\/rovilink] Broadway smash into the biggest blockbuster of 1978. 1950s teens Danny ([rovilink=\"P 71670\"]John Travolta[\/rovilink]) and Australian transfer Sandy ([rovilink=\"P 52476\"]Olivia Newton-John[\/rovilink]) spend their [rovilink=\"MT\"]\"Summer Nights\"[\/rovilink] falling in love, but once fall comes, it's back to Rydell High and its cliques. As one of the bad-boy T-Birds, Danny has to act cool for best pal Kenickie ([rovilink=\"P 85641\"]Jeff Conaway[\/rovilink]) and their leather-clad mates Sonny ([rovilink=\"P 72022\"]Michael Tucci[\/rovilink]) and Doody ([rovilink=\"P 55677\"]Barry Pearl[\/rovilink], in the role [rovilink=\"P 71670\"]Travolta[\/rovilink] played on-stage). Despite befriending Frenchy ([rovilink=\"P 14487\"]Didi Conn[\/rovilink]), one of the rebel Pink Ladies, virginal Sandy is \"too pure to be Pink,\" as the Ladies' leader, Rizzo ([rovilink=\"P 12304\"]Stockard Channing[\/rovilink]), acidly observes. Declaring their devotion in such [rovilink=\"D\"]ballads[\/rovilink] as [rovilink=\"MT\"]\"Hopelessly Devoted to You\"[\/rovilink] and [rovilink=\"MT\"]\"Sandy,\"[\/rovilink] Sandy and Danny split, reconcile, and split again amidst a pep rally, dances, drive-ins, and a drag race, before deciding [rovilink=\"MT\"]\"You're the One That I Want\"[\/rovilink] at the climactic carnival. With [rovilink=\"P 71670\"]Travolta[\/rovilink] white-hot from [rovilink=\"V   42923\"]Saturday Night Fever[\/rovilink] (1977), [rovilink=\"V   20546\"]Grease[\/rovilink] soundtrack singles climbed the charts and summer movie crowds poured in. With the presence of [rovilink=\"P  6812\"]Joan Blondell[\/rovilink], [rovilink=\"P  2128\"]Eve Arden[\/rovilink], [rovilink=\"P 10145\"]Sid Caesar[\/rovilink], [rovilink=\"P 10048\"]Edd \"Kookie\" Byrnes[\/rovilink], and [rovilink=\"P  2922\"]Frankie Avalon[\/rovilink] appealing to grown-up memories, [rovilink=\"V   20546\"]Grease[\/rovilink] became the highest-grossing film of 1978, the highest-grossing movie [rovilink=\"D\"]musical[\/rovilink] ever, and the third most popular film of the new blockbuster '70s after [rovilink=\"V   46636\"]Star Wars[\/rovilink] (1977) and [rovilink=\"V   25912\"]Jaws[\/rovilink] (1975). Its sequel, [rovilink=\"V  151390\"]Grease 2[\/rovilink], did not exactly set the world on fire in 1982.",
    "author":"Lucia Bozzola"
  }
}

Response Example 2

Here's the response to Request Example 3, which asks for a long synopsis for the movie D.O.A. 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/movie/synopsis?apikey=apikey&sig=sig&cosmoid=62527&synopsistype=long.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"62527",
      "format":"json"
   },
   "serverName":"tul1csprcs1.corporate.local",
   "startTime":"2016-06-13T17:28:16Z",
   "endTime":"2016-06-13T17:28:16Z",
   "duration":4,
   "parentIds":{
      "cosmoId":"62527",
      "movieId":"V    11915"
   },
   "longsynopsis":{
      "text":"Film noir told in flashback chronicles the story of an accountant who has 24 hours to find out who poisoned him before he dies. His investigation uncovers a ruthless gang that previously used the deadly poison during the commission of a crime. But a bigger question that remains is why was this seemingly innocent man targeted.",
      "author":null,
      "language":"English"
   }
}

Response Example 3

Here's the response to Request Example 4, which asks for an extended synopsis for the movie D.O.A. 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/movie/synopsis?apikey=apikey&sig=sig&cosmoid=62527&synopsistype=extended.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"62527",
      "format":"json"
   },
   "serverName":"tul1csprcs4.corporate.local",
   "startTime":"2016-06-13T17:29:01Z",
   "endTime":"2016-06-13T17:29:01Z",
   "duration":3,
   "parentIds":{
      "cosmoId":"62527",
      "movieId":"V    11915"
   },
   "extendedsynopsis":{
      "text":"Rather than lie down and die, O'Brien is determined to find his murderer, a quest that will take him down into the dregs of society.",
      "author":null,
      "language":"English"
   }
}

XML Response Example

Here's an XML response to Request Example 1, which asks for a synopsis for the movie Grease.
Requested with http://api.rovicorp.com/data/v1.1/movie/synopsis?apikey=apikey&sig=sig&movieid=V++++20546&
format=xml
.
<MovieSynopsis 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>V 20546</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cssw2</serverName>
  <startTime>2011-04-27T16:45:16.3123921Z</startTime>
  <endTime>2011-04-27T16:45:16.3280172Z</endTime>
  <duration>15</duration>
  <parentIds>
    <cosmoId>262068</cosmoId>
    <movieId>V 20546</movieId>
  </parentIds>
  <synopsis>
    <text>&quot;Grease,&quot; said the poster and the [rovilink=&quot;P 26707&quot;]Barry Gibb[/rovilink] song, &quot;is the word.&quot; Transferring its setting from Chicago to sunny California, and adding a dash of [rovilink=&quot;D&quot;]disco[/rovilink] to the ersatz &apos;50s score, producer [rovilink=&quot;P 84236&quot;]Allan Carr[/rovilink] and director [rovilink=&quot;P 97609&quot;]Randal Kleiser[/rovilink] turned this long-running [rovilink=&quot;P119002&quot;]Jim Jacobs[/rovilink]-[rovilink=&quot;P175060&quot;]Warren Casey[/rovilink] Broadway smash into the biggest blockbuster of 1978. 1950s teens Danny ([rovilink=&quot;P 71670&quot;]John Travolta[/rovilink]) and Australian transfer Sandy ([rovilink=&quot;P 52476&quot;]Olivia Newton-John[/rovilink]) spend their [rovilink=&quot;MT&quot;]&quot;Summer Nights&quot;[/rovilink] falling in love, but once fall comes, it&apos;s back to Rydell High and its cliques. As one of the bad-boy T-Birds, Danny has to act cool for best pal Kenickie ([rovilink=&quot;P 85641&quot;]Jeff Conaway[/rovilink]) and their leather-clad mates Sonny ([rovilink=&quot;P 72022&quot;]Michael Tucci[/rovilink]) and Doody ([rovilink=&quot;P 55677&quot;]Barry Pearl[/rovilink], in the role [rovilink=&quot;P 71670&quot;]Travolta[/rovilink] played on-stage). Despite befriending Frenchy ([rovilink=&quot;P 14487&quot;]Didi Conn[/rovilink]), one of the rebel Pink Ladies, virginal Sandy is &quot;too pure to be Pink,&quot; as the Ladies&apos; leader, Rizzo ([rovilink=&quot;P 12304&quot;]Stockard Channing[/rovilink]), acidly observes. Declaring their devotion in such [rovilink=&quot;D&quot;]ballads[/rovilink] as [rovilink=&quot;MT&quot;]&quot;Hopelessly Devoted to You&quot;[/rovilink] and [rovilink=&quot;MT&quot;]&quot;Sandy,&quot;[/rovilink] Sandy and Danny split, reconcile, and split again amidst a pep rally, dances, drive-ins, and a drag race, before deciding [rovilink=&quot;MT&quot;]&quot;You&apos;re the One That I Want&quot;[/rovilink] at the climactic carnival. With [rovilink=&quot;P 71670&quot;]Travolta[/rovilink] white-hot from [rovilink=&quot;V 42923&quot;]Saturday Night Fever[/rovilink] (1977), [rovilink=&quot;V 20546&quot;]Grease[/rovilink] soundtrack singles climbed the charts and summer movie crowds poured in. With the presence of [rovilink=&quot;P 6812&quot;]Joan Blondell[/rovilink], [rovilink=&quot;P 2128&quot;]Eve Arden[/rovilink], [rovilink=&quot;P 10145&quot;]Sid Caesar[/rovilink], [rovilink=&quot;P 10048&quot;]Edd &quot;Kookie&quot; Byrnes[/rovilink], and [rovilink=&quot;P 2922&quot;]Frankie Avalon[/rovilink] appealing to grown-up memories, [rovilink=&quot;V 20546&quot;]Grease[/rovilink] became the highest-grossing film of 1978, the highest-grossing movie [rovilink=&quot;D&quot;]musical[/rovilink] ever, and the third most popular film of the new blockbuster &apos;70s after [rovilink=&quot;V 46636&quot;]Star Wars[/rovilink] (1977) and [rovilink=&quot;V 25912&quot;]Jaws[/rovilink] (1975). Its sequel, [rovilink=&quot;V 151390&quot;]Grease 2[/rovilink], did not exactly set the world on fire in 1982.</text>
    <author>Lucia Bozzola</author>
  </synopsis>
</MovieSynopsis>


See Also

↑ Top

Personal tools