Tools
Movie/Synopsis
Returns a synopsis of the plot and the name of the author.
Syntax
| movie/synopsis? | movie=movie movieid=movieid cosmoid=cosmoid |
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language] |
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 synopsis for the movie Grease using the movie ID.
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:
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 | 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:
|
| 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:
|
| 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). |
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. |
Response for Movie/Synopsis
| Response | Type | Description |
|---|---|---|
| author | String | Author of the synopsis. |
| text | String | The full text of the movie synopsis. |
JSON Response Example
- Here's the response to Request Example 1. 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":"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"
}
}
"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"
}
}
XML Response Example
- Here's an XML response to Request Example 1.
<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>"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.</text>
<author>Lucia Bozzola</author>
</synopsis>
</MovieSynopsis>
<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>"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.</text>
<author>Lucia Bozzola</author>
</synopsis>
</MovieSynopsis>