Data/name-api/v1.1/name/credits

Jump to: navigation, search

Name/Credits

Returns a person's movie and television credits. An optional parameter returns keywords and parental ratings that apply to movies and programs returned in the credits. Keywords and parental ratings are filtered by the country and language parameters, so you can return ratings and keywords that apply to a particular region.

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

name/credits? name=name
nameid=nameid
cosmoid=cosmoid
amgpopid=amgpopid
amgmovieid=amgmovieid
amgclassicalid=amgclassicalid 		&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language] [&include=include] [filteradultcontents=filteradultcontents]

Request Example 1

Request the movie and television credits for Mark Harmon.
http://api.rovicorp.com/data/v1.1/name/credits?apikey=apikey&sig=sig&name=Mark+Harmon

Request Example 2

Request just the first two credits in the list and include parental ratings and keywords.
http://api.rovicorp.com/data/v1.1/name/credits?apikey=apikey&sig=sig&nameid=MN0001598722&
count=2&include=parentalratings,keywords

Request Example 3

Request the next two credits.
http://api.rovicorp.com/data/v1.1/name/credits?apikey=apikey&sig=sig&nameid=MN0001598722&
count=2&offset=2&include=parentalratings,keywords

Request Example 4

Request an XML response with just the first two credits and include keywords and parental ratings just for the US.
http://api.rovicorp.com/data/v1.1/name/credits?apikey=apikey&sig=sig&nameid=MN0001598722&
count=2&include=parentalratings,keywords&country=US&language=en&format=xml

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.

amgclassicalid Conditional All Media Guide (AMG) ID for a classical music artist, consisting of a ten-character string that starts with Q and is followed by nine digits with leading spaces. For example: Q     9065.

When using an AMG Classical ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: Q+++++9065. AMG is a legacy database of entertainment information.

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

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
amgmovieid Conditional All Media Guide (AMG) ID for a person who works in movies, consisting of a seven-character string that starts with P and is followed by 6 digits with leading spaces. For example: P 30474.

When using an AMG Movie ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: P+30474.

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

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
amgpopid Conditional All Media Guide (AMG) ID for a popular music artist, consisting of a ten-character string that starts with P and is followed by 9 digits with leading spaces. For example: P    84363.

When using an AMG Pop ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: P++++84363.

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

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
cosmoid Conditional Cosmo database ID for a person, group, or organization. You can get Cosmo IDs with Search requests. Cosmo is a database of television data.

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

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
name Conditional Name of the person or group. This returns the top search result for that name. Replace any spaces with plus (+) or percent20 (%20) symbols.

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

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
nameid Conditional Rovi Music ID for a person, group, or organization, consisting of the prefix MN followed by a ten-digit number. For example: MN0000114342. Your application can grab name IDs from responses to Search and from Info, Credits, Tracks, and Recommendations requests. For a complete list of requests that return name IDs, click here.

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

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
count No Number of items to be returned. The default is zero, which returns all items after the offset.
country No Country the language parameter applies to, stated as a two-character ISO 3166 country code. Default is US (United States). 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.

filteradultcontents No Whether to filter out credits that are tagged as Adult: true or false. Default is false.
format No Format of the returned data: json or xml. The default is JSON.
include No Adds information about the movies and programs that are returned in the credits. The possible values are:
ValueDescription
keywordsKeywords that apply to the movies and programs.
parentalratings  Parental ratings of the movies and programs.

You can specify both values in either of the following ways:

  • In multiple arguments, like this: include=keywords&include=parentalratings.
  • In a single argument as a comma-separated list, like this: include=keywords,parentalratings.

Both include values are filtered by country and language as specified by the country and language parameters.

language No Language of the response data, stated as a two-character ISO 639 language code:
  • 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.

offset No Number of items at the start of the available data to skip. The default is zero.

Use count and offset to paginate the data that is available to be returned.

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.
parentIdsparentIdsAll of the IDs for the requested name that are recognized by the Name API.
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 Name/Credits

ResponseTypeDescription
credits NameCredit [ ] Movie or television credits earned by the person specified in the request, sorted by year (most recent first) and secondarily by title.

JSON Response Example

Here's a response to Request Example 2, which asks for the first two credits listed for Mark Harmon along with parental ratings and keywords. 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/name/credits?apikey=apikey&sig=sig&
nameid=MN0001598722&count=2&include=parentalratings,keywords.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.0",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"MN0001598722",
      "offset":0,
      "count":2,
      "include":"parentalratings,keywords",
      "format":"json"
   },
   "view":{
      "offset":0,
      "count":2,
      "total":57
   },
   "serverName":"tul1cssrcs6.corporate.local",
   "startTime":"2012-11-21T17:57:04Z",
   "endTime":"2012-11-21T17:57:04Z",
   "duration":19,
   "parentIds":{
      "amgClassicalId":"Q 1475190",
      "amgMovieId":"P 30474",
      "amgPopId":"P 84363",
      "cosmoId":"100857",
      "nameId":"MN0001598722"
   },
   "credits":[
      {
         "ids":{
            "amgMovieId":null,
            "cosmoId":"19901055",
            "iguideId":null,
            "pidPaid":null
         },
         "seriesid":null,
         "title":"John Sandford's Certain Prey",
         "episodetitle":null,
         "programtype":"Movie",
         "category":"Movie",
         "releaseyear":"2011",
         "partname":null,
         "credittype":"Executive Producer",
         "startyear":null,
         "endyear":null,
         "image":{
            "height":60,
            "width":45,
            "formatid":38,
            "url":"http://actual-url-concealed.jpg",
            "author":"Ben Mark Holzberg/USA Network",
            "copyrightOwner":null,
            "overRide":null,
            "musicSort":null
         },
         "starrating":null,
         "programlanguage":"English",
         "firstairdate":null,
         "lastairdate":null,
         "numberofepisodesin":0,
         "videoUri":"http://api.rovicorp.com/data/v1.1/video/info?format=json&apikey=4p1k3y&cosmoid=19901055",
         "parentalRatings":[
            {
               "ratingType":"Belgium TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"Denmark TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"FCTV",
               "rating":"13+",
               "reasons":[

               ]
            },
            {
               "ratingType":"Finland TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"MPAA",
               "rating":"NR",
               "reasons":[

               ]
            },
            {
               "ratingType":"Netherlands TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"Norway TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"RCQ",
               "rating":"13+",
               "reasons":[

               ]
            },
            {
               "ratingType":"Sweden TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"US TV",
               "rating":"None",
               "reasons":[

               ]
            }
         ],
         "keywords": {
             "keywords": [
               {
                  "id": "36",
                  "keyword": "mystery & suspense",
                  "weight": ""
               },
               {
                  "id": "204",
                  "keyword": "suspense/thriller",
                  "weight": ""
               },
               {
                  "id": "16",
                  "keyword": "drama",
                  "weight": ""
               },
               {
                  "id": "383",
                  "keyword": "adaptation",
                  "weight": ""
               }
             ],
             "characteristics": null
          }
      },
      {
         "ids":{
            "amgMovieId":null,
            "cosmoId":"14411924",
            "iguideId":null,
            "pidPaid":null
         },
         "seriesid":null,
         "title":"Justice League: Crisis on Two Earths",
         "episodetitle":null,
         "programtype":"Movie",
         "category":"Movie",
         "releaseyear":"2010",
         "partname":"Superman",
         "credittype":"Voice",
         "startyear":null,
         "endyear":null,
         "image":{
            "height":60,
            "width":45,
            "formatid":38,
            "url":"http://actual-url-concealed.jpg",
            "author":null,
            "copyrightOwner":null,
            "overRide":null,
            "musicSort":null
         },
         "starrating":null,
         "programlanguage":"English",
         "firstairdate":null,
         "lastairdate":null,
         "numberofepisodesin":0,
         "videoUri":"http://api.rovicorp.com/data/v1.1/video/info?format=json&apikey=4p1k3y&cosmoid=14411924",
         "parentalRatings":[
            {
               "ratingType":"Denmark TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"Finland TV",
               "rating":"None",
               "reasons":[

               ]
            },
            {
               "ratingType":"Germany TV",
               "rating":"FSK: 12",
               "reasons":[

               ]
            },
            {
               "ratingType":"Italy TV",
               "rating":"T",
               "reasons":[

               ]
            },
            {
               "ratingType":"MPAA",
               "rating":"PG-13",
               "reasons":[
                  "V"
               ]
            },
            {
               "ratingType":"OFRB",
               "rating":"14A",
               "reasons":[

               ]
            },
            {
               "ratingType":"US TV",
               "rating":"None",
               "reasons":[

               ]
            }
         ],
         "keywords": {
            "keywords": [
                {
                   "id": "1",
                   "keyword": "action/adventure",
                   "weight": ""
                },
                {
                   "id": "11",
                   "keyword": "animated",
                   "weight": ""
                }
            ],
            "characteristics": null
        }
      }
   ]
}

XML Response Example

Here's the response to Request Example 4, which asks for the first two credits listed for Mark Harmon along with keywords and parental ratings that apply only to the United States.
Requested with http://api.rovicorp.com/data/v1.1/name/credits?apikey=apikey&sig=sig&
nameid=MN0001598722&count=2&include=parentalratings,keywords&country=US&language=en&format=xml.
<NameCredits xmlns="com.rovicorp.metadataservice" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <status>ok</status>
   <code>200</code>
   <messages i:nil="true" />
   <build>1.0</build>
   <parameters>
      <apiKey>4p1k3y</apiKey>
      <id>MN0001598722</id>
      <offset>0</offset>
      <count>2</count>
      <include>parentalratings,keywords</include>
      <format>xml</format>
      <country>US</country>
      <language>en</language>
   </parameters>
   <view>
      <offset>0</offset>
      <count>2</count>
      <total>57</total>
   </view>
   <serverName>tul1cssrcs2.corporate.local</serverName>
   <startTime>2012-11-21T18:12:25Z</startTime>
   <endTime>2012-11-21T18:12:25Z</endTime>
   <duration>13</duration>
   <parentIds>
      <amgClassicalId>Q  1475190</amgClassicalId>
      <amgMovieId>P 30474</amgMovieId>
      <amgPopId>P    84363</amgPopId>
      <cosmoId>100857</cosmoId>
      <nameId>MN0001598722</nameId>
   </parentIds>
   <credits>
      <NameCredit>
         <ids>
            <amgMovieId i:nil="true" />
            <cosmoId>19901055</cosmoId>
            <iguideId i:nil="true" />
            <pidPaid i:nil="true" />
         </ids>
         <seriesid i:nil="true" />
         <title>John Sandford's Certain Prey</title>
         <episodetitle i:nil="true" />
         <programtype>Movie</programtype>
         <category>Movie</category>
         <releaseyear>2011</releaseyear>
         <partname i:nil="true" />
         <credittype>Executive Producer</credittype>
         <startyear i:nil="true" />
         <endyear i:nil="true" />
         <image>
            <height>60</height>
            <width>45</width>
            <formatid>38</formatid>
            <url>http://actual-url-concealed.jpg</url>
            <author>Ben Mark Holzberg/USA Network</author>
            <copyrightOwner i:nil="true" />
            <overRide i:nil="true" />
            <musicSort i:nil="true" />
         </image>
         <starrating i:nil="true" />
         <programlanguage>English</programlanguage>
         <firstairdate i:nil="true" />
         <lastairdate i:nil="true" />
         <numberofepisodesin>0</numberofepisodesin>
         <videoUri>http://api.rovicorp.com/data/v1.1/video/info?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19901055</videoUri>
         <parentalRatings>
            <ParentalRating>
               <ratingType>MPAA</ratingType>
               <rating>NR</rating>
               <reasons />
            </ParentalRating>
            <ParentalRating>
               <ratingType>US TV</ratingType>
               <rating>None</rating>
               <reasons />
            </ParentalRating>
         </parentalRatings>
         <keywords>
            <keywords>
               <Keyword>
                  <id>12</id>
                  <keyword>comedy</keyword>
                  <weight/>
               </Keyword>
               <Keyword>
                  <id>174</id>
                  <keyword>romance</keyword>
                  <weight/>
               </Keyword>
               <Keyword>
                  <id>69</id>
                  <keyword>teens</keyword>
                  <weight/>
               </Keyword>
            </keywords>
            <characteristics i:nil="true"/>
         </keywords>
      </NameCredit>
      <NameCredit>
         <ids>
            <amgMovieId i:nil="true" />
            <cosmoId>14411924</cosmoId>
            <iguideId i:nil="true" />
            <pidPaid i:nil="true" />
         </ids>
         <seriesid i:nil="true" />
         <title>Justice League: Crisis on Two Earths</title>
         <episodetitle i:nil="true" />
         <programtype>Movie</programtype>
         <category>Movie</category>
         <releaseyear>2010</releaseyear>
         <partname>Superman</partname>
         <credittype>Voice</credittype>
         <startyear i:nil="true" />
         <endyear i:nil="true" />
         <image>
            <height>60</height>
            <width>45</width>
            <formatid>38</formatid>
            <url>http://actual-url-concealed.jpg</url>
            <author i:nil="true" />
            <copyrightOwner i:nil="true" />
            <overRide i:nil="true" />
            <musicSort i:nil="true" />
         </image>
         <starrating i:nil="true" />
         <programlanguage>English</programlanguage>
         <firstairdate i:nil="true" />
         <lastairdate i:nil="true" />
         <numberofepisodesin>0</numberofepisodesin>
         <videoUri>http://api.rovicorp.com/data/v1.1/video/info?format=xml&amp;apikey=4p1k3y&amp;cosmoid=14411924</videoUri>
         <parentalRatings>
            <ParentalRating>
               <ratingType>MPAA</ratingType>
               <rating>PG-13</rating>
               <reasons>
                  <a:string>V</a:string>
               </reasons>
            </ParentalRating>
            <ParentalRating>
               <ratingType>US TV</ratingType>
               <rating>None</rating>
               <reasons />
            </ParentalRating>
         </parentalRatings>
         <keywords>
            <keywords>
               <Keyword>
                  <id>1</id>
                  <keyword>action/adventure</keyword>
                  <weight/>
               </Keyword>
               <Keyword>
                   <id>11</id>
                   <keyword>animated</keyword>
                   <weight/>
               </Keyword>
            </keywords>
            <characteristics i:nil="true"/>
         </keywords>
      </NameCredit>
   </credits>
</NameCredits>


See Also

↑ Top

 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/Data/name-api/v1.1/name/credits"
Personal tools