Data/video-api/v1.1/video/review

Jump to: navigation, search

Video/Review

Returns a professional review of a movie or program.

Syntax

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

Request Example 1

Request the review of the movie The Time Traveler's Wife.

Request Example 2

Request an XML response with the movie review of The Time Traveler's Wife.

Request Example 3

Request the review of the movie Star Trek

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, program, episode, or television series. 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 An 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 the language parameter applies to, stated as a two-character ISO 3166 country code. Default is the default country of the language you specify (US if language is not specified). If an invalid combination of country and language is specified, US English will be returned.

Valid country codes are:

  • AR
Argentina
  • SV
El Salvador
  • NI
Nicaragua
  • AT
Austria
  • FI
Finland
  • NO
Norway
  • BE
Belgium
  • FR
France
  • PA
Panama
  • BM
Bermuda
  • DE
Germany
  • PE
Peru
  • BO
Bolivia
  • GT
Guatemala
  • PL
Poland
  • BR
Brazil
  • HN
Honduras
  • PT
Portugal
  • CA
Canada
  • IE
Ireland
  • ES
Spain
  • CL
Chile
  • IT
Italy
  • SE
Sweden
  • CO
Colombia
  • JM
Jamaica
  • CH
Switzerland
  • CR
Costa Rica
  • LU
Luxembourg 
  • GB
United Kingdom*
  • DK
Denmark
  • MX
Mexico
  • US
United States
  • DO
Dominican Republic 
  • NL
Netherlands
  • VE
Venezuela
  • EC
Ecuador

* Includes Wales, Scotland, and Northern Ireland.

format No Format of the returned data: json or xml. The default is JSON.
language No Language of response data. Although this request currently returns only English responses, you can specify a preferred language to be ready for future language expansion. Valid language codes are:
  • da
Danish
  • fr
French
  • pt
Portuguese
  • nl
Dutch
  • de
German
  • es
Spanish
  • en
English
  • it
Italian
  • sv
Swedish
  • fi
Finnish
  • no
Norwegian    
  • fl
Flemish    
  • pl
Polish

Default is en (English). If content is not available in the language requested, another language is chosen as determined by the Language Fallback Sequence table.

localeresolution No How the language fallback rules should be applied for any content that is not available for the specified language and country. The values are:
  • None
Return the content for the specified Cosmo ID.
  • Full
Fall back to the next available language per the fallback rules.
  • Exact   
If the program is available in the specified language, return content for that Cosmo ID instead, like Full. Otherwise, return the content for the specified Cosmo ID, like None.
  • Targeted
Fall back to the next available language per the fallback rules like Full, but override the IDs and masterTitle values like None.

Default is Full.

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.
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 Video/Review

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 there is no ending punctuation (a period or a period followed by a single of double quotation mark).
language string Language of the review.
review string The review.
source string Source of the review.

JSON Response Example

Here's the response to Request Example 1, which asks for the review of the movie The Time Traveler's Wife. 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/video/review?apikey=apikey&sig=sig&cosmoid=12226703.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.7.0.1",
   "parameters":{
      "apiKey":"ap1k3y",
      "id":"12226703",
      "format":"json"
   },
   "view":{
      "offset":0,
      "count":0,
      "total":0
   },
   "serverName":"tul1cstw1",
   "startTime":"2011-09-12T18:52:30.8518425Z",
   "endTime":"2011-09-12T18:52:32.5861953Z",
   "duration":449,
   "review":{
      "review":"As a book, The Time Traveler's Wife charmed millions with its tale of doomed love, but the fantastical premise will make the movie a challenge for some viewers to follow. Eric Bana stars as Henry, a research librarian who suffers from a genetic disorder that makes him disappear suddenly, and then reappear at some other point in time. This makes maintaining his marriage to artist Clare (Rachel McAdams) very emotionally difficult for the both of them. For example, Henry first meets Clare at a library when they are in their twenties, but Clare sees Henry initially when she is 6 and he is 38 because that's the age Harry is when he first travels to that time in the past. Although the adult couple are happy when they're together, Clare often grows despondent because she never knows when Henry will disappear, or for how long. Eventually, hints of Henry's death begin to appear, forcing the couple to appreciate every second they have together.\u000d\u000dWhile that may sound like a confounding setup, the movie has the smarts to not worry about plausibility. No, instead of encouraging you to think about what's happening, director Robert Schwentke wants you to feel -- deeply and profoundly -- every fleeting moment of happiness the doomed couple can share before their imminent demise. The problem is that there aren't enough of them. Between debating about having a child, fighting over his constant disappearances, and trying to figure out why they saw an older version of Harry naked and bleeding on the floor, we're left with so few moments of domestic bliss that it becomes hard to believe Clare isn't certifiably crazy for staying with him. But after all, who said love, or a three-hanky tearjerker, has to be sane? The Time Traveler's Wife shares something with another time-bending romance, The Curious Case of Benjamin Button. Both movies offer a fatalistic viewpoint toward relationships -- they want to make it clear that because death is unavoidable, you need to love as strongly as you can and for as long as possible. But where Fincher's film explored this idea at a nearly philosophical level, Schwentke and his crew go exclusively for the gut. The result is a film so single-minded in its attempt to wring tears that it's easy to dismiss, but so effective in its execution that it's hard to deny it achieves its very simple goals.",
   "source":null,
   "language":"English",
   "cuttingPositions":null
   }
}

XML Response Example

Here's the response to Request Example 2, which asks for the review of the movie The Time Traveler's Wife in an XML response.
Requested with http://api.rovicorp.com/data/v1.1/video/review?apikey=apikey&sig=sig&cosmoid=12226703&
format=xml
.
<VideoReview 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>ap1k3y</apiKey>
    <id>12226703</id>
    <format>xml</format>
  </parameters>
  <view>
    <offset>0</offset>
    <count>0</count>
    <total>0</total>
  </view>
  <serverName>tul1cstw1</serverName>
  <startTime>2011-09-12T18:57:30.2386353Z</startTime>
  <endTime>2011-09-12T18:57:30.7073793Z</endTime>
  <duration>468</duration>
  <review>
    <review>As a book, The Time Traveler's Wife charmed millions with its tale of doomed love, but the fantastical premise will make the movie a challenge for some viewers to follow. Eric Bana stars as Henry, a research librarian who suffers from a genetic disorder that makes him disappear suddenly, and then reappear at some other point in time. This makes maintaining his marriage to artist Clare (Rachel McAdams) very emotionally difficult for the both of them. For example, Henry first meets Clare at a library when they are in their twenties, but Clare sees Henry initially when she is 6 and he is 38 because that's the age Harry is when he first travels to that time in the past. Although the adult couple are happy when they're together, Clare often grows despondent because she never knows when Henry will disappear, or for how long. Eventually, hints of Henry's death begin to appear, forcing the couple to appreciate every second they have together.&#xD;&#xD;While that may sound like a confounding setup, the movie has the smarts to not worry about plausibility. No, instead of encouraging you to think about what's happening, director Robert Schwentke wants you to feel -- deeply and profoundly -- every fleeting moment of happiness the doomed couple can share before their imminent demise. The problem is that there aren't enough of them. Between debating about having a child, fighting over his constant disappearances, and trying to figure out why they saw an older version of Harry naked and bleeding on the floor, we're left with so few moments of domestic bliss that it becomes hard to believe Clare isn't certifiably crazy for staying with him. But after all, who said love, or a three-hanky tearjerker, has to be sane? The Time Traveler's Wife shares something with another time-bending romance, The Curious Case of Benjamin Button. Both movies offer a fatalistic viewpoint toward relationships -- they want to make it clear that because death is unavoidable, you need to love as strongly as you can and for as long as possible. But where Fincher's film explored this idea at a nearly philosophical level, Schwentke and his crew go exclusively for the gut. The result is a film so single-minded in its attempt to wring tears that it's easy to dismiss, but so effective in its execution that it's hard to deny it achieves its very simple goals.</review>
    <source i:nil="true"/>
    <language>English</language>
    <cuttingPositions i:nil="true"/>
  </review>
</VideoReview>


See Also

↑ Top

 
Personal tools