V1.MetaData.VideoService.Video:Synopsis

Jump to: navigation, search

Video/Synopsis

Returns the best available synopsis associated with a movie or program.

Syntax

video/synopsis? video=video
cosmoid=cosmoid
iguideid=iguideid		 &apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language]

Request Example 1

Request the synopsis for the movie Indiana Jones and the Kingdom of the Crystal Skull.
http://api.rovicorp.com/data/v1/video/synopsis?apikey=apikey&sig=sig&cosmoid=7967407

Request Example 2

Request an XML response for the synopsis for Indiana Jones and the Kingdom of the Crystal Skull.
http://api.rovicorp.com/data/v1/video/synopsis?apikey=apikey&sig=sig&cosmoid=7967407&format=xml

Request Example 3

Request the synopsis for the movie The English Patient.
http://api.rovicorp.com/data/v1/video/synopsis?apikey=apikey&sig=sig&video=english+patient

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 authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three 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.

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 a television series, season, or program. Cosmo is a database of television information. You can grab Cosmo IDs from responses to the following requests:

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

  • video
  • cosmoid
  • iguideid
iguideid Conditional A 24-bit program ID for a television program used by the i‑Guide™ interactive digital cable TV program guide. You can get i‑Guide IDs from i‑Guide and from responses to the following requests:

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

  • video
  • cosmoid
  • iguideid
video Conditional Title of a movie, television program, or television series, or keywords from the title. This searches for the most popular title with that combination of words. Replace any spaces with plus (+) or percent20 (%20) symbols.

Note: This parameter currently returns only US-English results. Support for other countries and languages will be added in the future.

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

  • video
  • cosmoid
  • iguideid
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

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.
parametersparametersList of the parameters included in the request.
parentIdsparentIdsAll of the IDs for the requested movie or program that are recognized by the Video Service.
serverNameStringName of the server that processed the request.
startTimeStringWhen the server received the request (UTC time).
statusStringText part of the HTTP status code that is shown in the code field.

Response for Video/Synopsis

ResponseTypeDescription
cuttingPositions String Character positions at which you can end the text to conserve space. A cutting position is the number of the last character to include, not the first character to cut. Add a period if needed (plus, for a quote, a closing single or double quotation mark).
language URL Language of the synopsis.
source String Source of the synopsis.
synopsis String The 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.7.0.1",
   "parameters":{
      "apiKey":"apikey",
      "id":"7967407",
      "format":"json"
   },
   "serverName":"tul1cstw1",
   "startTime":"2011-09-12T19:09:24.0732481Z",
   "endTime":"2011-09-12T19:09:25.7607265Z",
   "duration":1687,
   "synopsis":{
      "synopsis":"Swashbuckling archaeologist Indiana Jones (Harrison Ford) returns to keep a weird artifact out of communist hands. Old friends return, new enemies appear and elaborate action sequences abound. Shia LaBoeuf, Ray Winstone, John Hurt.",
      "source":null,
      "language":"English",
      "cuttingPositions":"65,114,192,205,219"
   }
}

XML Response Example

Here's the response to Request Example 2.
<VideoSynopsis 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.7.0.1</build>
   <parameters>
      <apiKey>apikey</apiKey>
      <id>7967407</id>
      <format>xml</format>
   </parameters>
   <serverName>tul1cstw1</serverName>
   <startTime>2011-09-12T19:13:59.4915977Z</startTime>
   <endTime>2011-09-12T19:13:59.7884689Z</endTime>
   <duration>296</duration>
   <synopsis>
      <synopsis>Swashbuckling archaeologist Indiana Jones (Harrison Ford) returns to keep a weird artifact out of communist hands. Old friends return, new enemies appear and elaborate action sequences abound. Shia LaBoeuf, Ray Winstone, John Hurt.</synopsis>
      <source i:nil="true"/>
      <language>English</language>
      <cuttingPositions>65,114,192,205,219</cuttingPositions>
   </synopsis>
</VideoSynopsis>


See Also

↑ Top

Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V1.MetaData.VideoService.Video:Synopsis"
Personal tools