V1.Metadata.MusicService.Album:Images

Jump to: navigation, search

Album/Images

Returns URLs to pictures of an album along with associated image information. Note: Access to images is governed by your subscription level and geographical location.

IMPORTANT: Photography credits must be displayed with images.

Syntax

album/images? album=album
albumid=albumid
amgpopid=amgpopid
amgclassicalid=amgclassicalid
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language]

Request Example 1

Request images of the album The Doors.

Request Example 2

Request images of the album in an XML format.

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.

album Conditional Keywords from the album title. This searches for the most popular title with that combination of words. Replace spaces with plus (+) or percent20 (%20) symbols.

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

  • album
  • albumid
  • amgpopid
  • amgclassicalid
albumid Conditional Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number. For example: MW0000056882. You can grab album IDs from responses to the following requests:

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

  • album
  • albumid
  • amgpopid
  • amgclassicalid
amgclassicalid Conditional All Media Guide (AMG) ID for a classical music album, consisting of a ten-character string that starts with W and is followed by nine digits with leading spaces. For example: W   180317. When using an AMG Classical ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: W+++180317. AMG is a legacy database of entertainment information.

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

  • album
  • albumid
  • amgpopid
  • amgclassicalid
amgpopid Conditional All Media Guide (AMG) ID for a popular music album, consisting of a ten-character string that starts with R and is followed by nine digits with leading spaces. For example: R  1805889. When using an AMG Pop ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: R++1805889.

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

  • album
  • albumid
  • amgpopid
  • amgclassicalid
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 object that are recognized by the API.
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 Album/Images

ResponseTypeDescription
images images URLs to images of the main album release along with associated image information.

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.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":"MW0000650088"
  },
  "view":{
    "total":6
  },
  "serverName":"tul1cssw4",
  "startTime":"2011-04-27T21:36:33.4323510Z",
  "endTime":"2011-04-27T21:36:33.4323510Z",
  "duration":0,
  "parentIds":{
    "albumId":"MW0000650088",
    "amgPopId":"R    6209"
  },
  "images":{
    "front":[
      {
        "height":73,
        "width":75,
        "formatid":71,
        "url":"http:\/\/actual-url-concealed.jpg",
        "author":null,
        "copyrightOwner":null
      },
      {
        "height":167,
        "width":170,
        "formatid":63,
        "url":"http:\/\/actual-url-concealed.jpg",
        "author":null,
        "copyrightOwner":null
      },
      {
        "height":246,
        "width":250,
        "formatid":44,
        "url":"http:\/\/actual-url-concealed.jpg",
        "author":null,
        "copyrightOwner":null
      },
      {
        "height":393,
        "width":400,
        "formatid":64,
        "url":"http:\/\/actual-url-concealed.jpg",
        "author":null,
        "copyrightOwner":null
      },
      {
        "height":492,
        "width":500,
        "formatid":16,
        "url":"http:\/\/actual-url-concealed.jpg",
        "author":null,
        "copyrightOwner":null
      },
      {
        "height":1063,
        "width":1080,
        "formatid":62,
        "url":"http:\/\/actual-url-concealed.jpg",
        "author":null,
        "copyrightOwner":null
      }
    ],
    "back":[

    ]
  }
}

XML Response Example

Here's the response to Request Example 2.
<AlbumImages 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.5.1.9</build>
  <parameters>
    <apiKey>apikey</apiKey>
    <id>MW0000650088</id>
    <format>xml</format>
  </parameters>
  <view>
    <total>6</total>
  </view>
  <serverName>tul1cssw2</serverName>
  <startTime>2011-04-27T21:36:44.2704344Z</startTime>
  <endTime>2011-04-27T21:36:44.2860595Z</endTime>
  <duration>15</duration>
  <parentIds>
    <albumId>MW0000650088</albumId>
    <amgPopId>R 6209</amgPopId>
  </parentIds>
  <images>
    <front>
      <Image>
        <height>73</height>
        <width>75</width>
        <formatid>71</formatid>
        <url>http://actual-url-concealed.jpg</url>
        <author i:nil="true"/>
        <copyrightOwner i:nil="true"/>
      </Image>
      <Image>
        <height>167</height>
        <width>170</width>
        <formatid>63</formatid>
        <url>http://actual-url-concealed.jpg</url>
        <author i:nil="true"/>
        <copyrightOwner i:nil="true"/>
      </Image>
      <Image>
        <height>246</height>
        <width>250</width>
        <formatid>44</formatid>
        <url>http://actual-url-concealed.jpg</url>
        <author i:nil="true"/>
        <copyrightOwner i:nil="true"/>
      </Image>
      <Image>
        <height>393</height>
        <width>400</width>
        <formatid>64</formatid>
        <url>http://actual-url-concealed.jpg</url>
        <author i:nil="true"/>
        <copyrightOwner i:nil="true"/>
      </Image>
      <Image>
        <height>492</height>
        <width>500</width>
        <formatid>16</formatid>
        <url>http://actual-url-concealed.jpg</url>
        <author i:nil="true"/>
        <copyrightOwner i:nil="true"/>
      </Image>
      <Image>
        <height>1063</height>
        <width>1080</width>
        <formatid>62</formatid>
        <url>http://actual-url-concealed.jpg</url>
        <author i:nil="true"/>
        <copyrightOwner i:nil="true"/>
      </Image>
    </front>
    <back/>
  </images>
</AlbumImages>


See Also

↑ Top

Personal tools