V1.MetaData.VideoService.Video:Awards

Jump to: navigation, search

Video/Awards

Returns awards a program has been nominated for or won.

This request may return a large amount of data. To speed data transmission, do the following:

  • Request one page of data at a time, requesting only what you want to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

video/awards? video=video
cosmoid=cosmoid
iguideid=iguideid		 &apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request awards Modern Family has been nominated for or won.
http://api.rovicorp.com/data/v1/video/awards?apikey=apikey&sig=sig&video=modern+family

Request Example 2

Request the awards in an XML format.
http://api.rovicorp.com/data/v1/video/awards?apikey=apikey&sig=sig&video=modern+family&format=xml

Request Example 3

Request awards the TV series The Simpsons has been nominated for or won.
http://api.rovicorp.com/data/v1/video/awards?apikey=apikey&sig=sig&cosmoid=7903

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
count No Number of items to be returned. The default is zero, which returns all items after the offset.

Use count and offset to paginate the response.

country No Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code. Default is US (United States). 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    
  • PT
Portugal
  • CA
Canada
  • HN
Honduras
  • ES
Spain
  • CL
Chile
  • IE
Ireland
  • SE
Sweden
  • CO
Colombia
  • IT
Italy
  • CH
Switzerland
  • CR
Costa Rica
  • JM
Jamaica
  • TR
Turkey
  • DK
Denmark
  • LU
Luxembourg   
  • GB
United Kingdom*
  • DO
Dominican Republic   
  • MX
Mexico
  • US
United States
  • EC
Ecuador
  • NL
Netherlands
  • VE
Venezuela

* Includes Wales, Scotland, and Northern Ireland.

format No Format of the returned data: json or xml. The default is JSON.
language No Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code. Valid language codes are:
  • da
Danish
  • fr
French
  • pl
Polish
  • nl
Dutch
  • de
German
  • pt
Portuguese
  • en
English    
  • it
Italian
  • es
Spanish
  • fi
Finnish
  • no
Norwegian    
  • sv
Swedish
  • fl
Flemish
  • tr
Turkish

Default is en (English). If a program description is not available in the language requested, a description in another language is provided if available. The language chosen is determined by the rules shown in the Language Fallback Sequence table.

offset No Number of items at the start of the returned list to skip. The default is zero.

Use count and offset to paginate the response.

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.
viewviewSummary of items returned in a list of items.

Response for Video/Awards

ResponseTypeDescription
awards VideoAward [ ] Awards the program specified in the request has been nominated for or won.

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.6.1.12",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"Modern Family",
      "format":"json"
   },
   "view":{
      "total":1
   },
   "serverName":"tul1cstw4",
   "startTime":"2011-08-01T22:41:31.4981312Z",
   "endTime":"2011-08-01T22:41:31.5293802Z",
   "duration":31,
   "parentIds":{
      "cosmoId":"3560954"
   },
   "awards":[
      {
         "recipients":[
            {
               "ids":{
                  "amgClassicalId":null,
                  "amgMovieId":null,
                  "amgPopId":null,
                  "cosmoId":"102461",
                  "nameId":null
               },
               "fullName":"Ed O'Neill",
               "nameUri":"http:\/\/api.rovicorp.com\/v1\/name\/info?format=json&apikey=4p1k3y&cosmoid=102461",
               "isCelebrity":true,
               "isOrganization":false
            }
         ],
         "ids":{
            "amgMovieId":null,
            "cosmoId":"3560954"
         },
         "title":"Modern Family",
         "type":"Screen Actors Guild Awards",
         "medium":"None",
         "category":"Outstanding Performance by a Male Actor in a Comedy Series",
         "year":2010,
         "isWinner":false
      }
   ]
}

XML Response Example

Here's the response to Request Example 2.
<VideoAwards 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.6.1.12</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>Modern Family</id>
    <format>xml</format>
  </parameters>
  <view>
    <total>1</total>
  </view>
  <serverName>tul1cstw2</serverName>
  <startTime>2011-08-01T22:43:46.7910195Z</startTime>
  <endTime>2011-08-01T22:43:47.2910291Z</endTime>
  <duration>500</duration>
  <parentIds>
    <cosmoId>3560954</cosmoId>
  </parentIds>
  <awards>
    <VideoAward>
      <recipients>
        <VideoAwardRecipient>
          <ids>
            <amgClassicalId i:nil="true"/>
            <amgMovieId i:nil="true"/>
            <amgPopId i:nil="true"/>
            <cosmoId>102461</cosmoId>
            <nameId i:nil="true"/>
          </ids>
          <fullName>Ed O&apos;Neill</fullName>
          <nameUri>http://api.rovicorp.com/v1/name/info?format=xml&amp;apikey=4p1k3y&amp;cosmoid=102461</nameUri>
          <isCelebrity>true</isCelebrity>
          <isOrganization>false</isOrganization>
        </VideoAwardRecipient>
      </recipients>
      <ids>
        <amgMovieId i:nil="true"/>
        <cosmoId>3560954</cosmoId>
      </ids>
      <title>Modern Family</title>
      <type>Screen Actors Guild Awards</type>
      <medium>None</medium>
      <category>Outstanding Performance by a Male Actor in a Comedy Series</category>
      <year>2010</year>
      <isWinner>false</isWinner>
    </VideoAward>
  </awards>
</VideoAwards>


See Also

↑ Top

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