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

Jump to: navigation, search

Name/Web

Returns Twitter and Facebook resources for a person or group.

Note: Access to Facebook data is governed by subscription level.

Syntax

name/web? name=name
nameid=nameid
cosmoid=cosmoid
amgpopid=amgpopid
amgmovieid=amgmovieid
amgclassicalid=amgclassicalid 		&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language]

Request Example 1

Request Web resources for Rosanne Cash.
http://api.rovicorp.com/data/v1.1/name/web?apikey=apikey&sig=sig&name=rosanne+cash

Request Example 2

Request Web resources for Tim Brown, American football wide receiver, in an XML response.
http://api.rovicorp.com/data/v1.1/name/web?apikey=apikey&sig=sig&cosmoId=614996&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
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).

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.

Response for Name/Web

ResponseTypeDescription
facebook NameFacebook [ ] Facebook accounts associated with the person or group named in the request.
twitter NameTwitter [ ] Twitter accounts associated with the person or group named in the request.

JSON Response Example

Here's the response to Request Example 1, which asks for Web resources for Rosanne Cash. 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/web?apikey=apikey&sig=sig&name=rosanne+cash.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.6.1.8",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"rosanne cash"
   },
   "serverName":"tul1cstw4",
   "startTime":"2011-06-22T20:42:21.9858624Z",
   "endTime":"2011-06-22T20:42:22.0327380Z",
   "duration":46,
   "parentIds":{
      "amgClassicalId":"Q 429770",
      "amgMovieId":"P 11574",
      "amgPopId":"P 1549",
      "cosmoId":"403401",
      "nameId":"MN0000285272"
   },
   "web":{
      "twitter":[
         {
            "sn":"rosannecash",
            "n":"rosanne cash",
            "bio":"Writer\/musician\/New Yorker\/married to @johnleventhal.NeoFolkBuddhiscopalian-paganPostFeministProgressive. I like Twitter as cafe society.",
            "url":"http:\/\/rosannecash.com"
         }
      ],
      "facebook":null
   }
}

XML Response Example

Here's the response to Request Example 2, which asks for Web resources for Tim Brown in an XML response.
Requested with http://api.rovicorp.com/data/v1.1/name/web?apikey=apikey&sig=sig&cosmoId=614996&
format=xml.
<NameWeb 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.0</build>
    <parameters>
        <apiKey>apikey</apiKey>
        <id>614996</id>
        <format>xml</format>
    </parameters>
    <serverName>tul1cstrcs1.corporate.local</serverName>
    <startTime>2013-07-23T02:35:28Z</startTime>
    <endTime>2013-07-23T02:35:28Z</endTime>
    <duration>20</duration>
    <parentIds>
        <cosmoId>614996</cosmoId>
    </parentIds>
    <web>
        <twitter>
            <NameTwitter>
                <sn>81TimBrown</sn>
                <n>Tim Brown</n>
                <bio>The Official Twitter of Tim Brown/ Touchdown Timmy/ Mr. Raider</bio>
                <url>http://www.smartgivingcards.com</url>
            </NameTwitter>
        </twitter>
        <facebook>
            <NameFacebook>
                <name>Tim Brown</name>
                <urlType>Official</urlType>
                <url>https://www.facebook.com/pages/Tim-Brown/228405374859</url>
                <status/>
            </NameFacebook>
        </facebook>
    </web>
</NameWeb>


See Also

↑ Top

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