Returns one of three types of a synopsis of a movie or TV series:
To return this type of synopsis... | Description | Specify this synopsistype... |
---|---|---|
long | Brief description, which may be extended slightly with a more info link to an extended synopsis. | synopsistype=long |
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. | synopsistype=extended |
synopsis | A 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.
movie/synopsis? | movie=movie movieid=movieid cosmoid=cosmoid |
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language] [&synopsistype=synopsistype] |
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. | ||||
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 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:
Note: To return both the long and extended synopsis in the same response, use the Movie/Info request. |
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. |
Response | Type | Description |
---|---|---|
author | string | Author of the synopsis. |
text | string | The text of the synopsis, long synopsis, or extended synopsis. |