Data/music-api/v1.1/release/info

Jump to: navigation, search

Release/Info

Returns basic information about an LP, CD, DVD, cassette, download, or other release of an album, plus customized requests for all of the other Release requests that have content available. These customized requests are designed to make your programming easy and efficient: in a single step you both verify availability of data and capture the request. You just add the sig parameter and execute the request.

The release/info request also provides an optional argument to include responses from any or all of the other Release requests. This may return a large amount of data. To speed data transmission, do the following:

  • Request only data that you need to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

release/info? eanid=eanid
upcid=upcid
amgpopid=amgpopid
releaseid=releaseid
amgclassicalid=amgclassicalid 		&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language] [&formatid=formatid] [&imagecount=imagecount] [&imageoffset=imageoffset] [&imagesize=imagesize] [&imagesort=imagesort]

Request Example 1

Request information about a release of Tan Dun: Ghost Opera.
http://api.rovicorp.com/data/v1.1/release/info?apikey=apikey&sig=sig&releaseid=MR0002392414

Request Example 2

Request information about a release of Double Live along with track information and album images that are in the range of 60 to 80 pixels in both dimensions.
http://api.rovicorp.com/data/v1.1/release/info?apikey=apikey&sig=sig&releaseid=MR0001367205&
include=images,tracks&imagesize=60-80x60-80

Request Example 3

Use the album UPC code to request information.
http://api.rovicorp.com/data/v1.1/release/info?apikey=apikey&sig=sig&upcid=724349742420

Request Example 4

Request information using an AMG classical release ID for an existing application that uses the legacy AMG classical ID.
http://api.rovicorp.com/data/v1.1/release/info?apikey=apikey&sig=sig&amgclassicalid=W++++17244

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 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:

  • eanid
  • upcid
  • releaseid   
  • 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:

  • eanid
  • upcid
  • releaseid   
  • amgpopid
  • amgclassicalid
eanid Conditional The numbers from the EAN barcode that identifies the release.

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

  • eanid
  • upcid
  • releaseid   
  • amgpopid
  • amgclassicalid
releaseid Conditional Rovi Music ID for the release, consisting of the prefix MR followed by a ten-digit number. Your application can grab release IDs from responses to the following requests:

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

  • eanid
  • upcid
  • releaseid   
  • amgpopid
  • amgclassicalid
upcid Conditional The numbers from the barcode that identifies a music release:
  • 14 digits for music downloads
  • Fewer than 14 digits for CDs, DVDs, and other physical products

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

  • eanid
  • upcid
  • releaseid   
  • amgpopid
  • 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.
formatid No If you specify All or Images in the include parameter, formatid specifies the size and file format of returned images. Select the format IDs you want from the Format IDs table.

Specify multiple format IDs in a comma-separated list, like this: formatid=36,44,51.

If you also specify imagesize, returned images meet a combination of one formatid and one imagesize filter. Note: Your access to images is governed by your subscription level.

imagecount No If you specify All or Images in the include parameter, imagecount specifies the number of images to be returned. If fewer images are available, the available images are returned without error. The default is 25.

Use imagecount and imageoffset to paginate images in the response.
Note:  Your access to images is governed by your subscription level.

imageoffset No If you specify All or Images in the include parameter, imageoffset specifies the number of images at the start of the response to skip. The default is zero.

Use imagecount and imageoffset to paginate images in the response.
Note:  Your access to images is governed by your subscription level.

imagesize No If you specify All or Images in the include parameter, imagesize specifies the image sizes to be returned. Images are not dynamically resized to fit, so only available sizes are returned.
  • Specify an exact size in width x height format, like this: imagesize=332x419.
  • Specify a size range in width x height format, like this: imagesize=60-80x80-100.
  • Specify multiple sizes in a comma-separated list, like this: imagesize=332x419,60-80x80-100.

If you also specify formatid, returned images meet a combination of one formatid and one imagesize filter. Note:  Your access to images is governed by your subscription level.

imagesort No If you specify All or Images in the include parameter, imagesort specifies the sort order of returned images. Images can be sorted in ascending or descending order by the following properties:
  • width
Image width.
  • height
Image height.
  • formatid
Image format ID, as shown in the Format IDs table.
  • author
Person or company that took the photo.
  • copyrightowner  
Company that owns the image copyright.
  • url
URL to the image (ASCII sort).

Specify a descending sort order with a minus (-) sign, like this: imagesort=-width.
Specify a multilevel sort in highest-to-lowest order in a comma-separated list, like this: imagesort=formatid,-height,width.

Note:  Your access to images is governed by your subscription level.

multi and imagesort cannot be used in the same request, only one or the other is permitted

include No Other Release requests to include in the request. To include the list of tracks, for example, add include=tracks.

You can specify multiple includes in either of the following ways:

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

You can also include all Release requests with include=all. The possible values are:

For information about a request, please see the documentation for the request.

Reminder: These options may return a large amount of data. To speed data transmission, do the following:

  • Request only data that you need to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.
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.
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 Release/Info

ResponseTypeDescription
catalog string Product identification number a record company assigned to the release. Catalog numbers are used for ordering and tracking purposes.
classicalReview classicalReview An editorial review of a classical music release, returned only if the request specified an include=classicalreview argument.
classicalReviewUri string The customized Release/ClassicalReview request, returned only if the data is available.
credits AlbumCredit [ ] Production credits for the album release, returned only if the request specified an include=credits argument.
creditsUri string The customized Release/Credits request, returned only if the data is available.
duration integer Playing time in seconds.
flags string [ ] Additional features and characteristics that apply to the release:
  • 24-Bit Mastered
  • Arrangement
  • Bootleg
  • Cast Recording
  • Christmas
  • Collectors Edition
  • Compilation
  • Digitally Remastered
  • DJ Mix
  • Exercise
  • Expurgated Version
  • Field Recording
  • HDCD Mastered
  • Highlights
  • Holiday
  • Import
  • Instrumental
  • International Version
  • Interview
  • Karaoke
  • Limited Edition
  • Live Recording
  • Mastered
  • Mixed
  • Mono
  • Multichannel
  • Offensive image,title,lyrics
  • Religious
  • Remastered
  • Remixes
  • Soundtrack
  • Stereo
  • Studio & Live
  • Studio Recording
  • Tribute
  • Unknown
  • Video
  • XRCD Mastered
format string Type of media used for the release.
genres Genre [ ] Musical genres the release falls into, along with a weighting that reflects the relative importance of each genre.

Genres are sorted in order of importance (highest to lowest weight) and, within the same weight, alphabetically by genre name.

guestArtists AlbumArtist [ ] Names of guest artists that appear on the release, listed alphabetically by last name.
headlineReview headlineReview A capsule review that sums up the critical and historical perspective of the release in one or two sentences.
ids ids All of the IDs that are recognized by the API for a release of an album. The possible IDs are:
  • eanId
  • upcId
  • albumId
  • releaseId
  • amgPopId
  • amgClassicalId
images images URLs to images of the release, returned only if the request specified an include=images argument and your subscription level enables access to images.
imagesUri string The customized Release/Images request, returned only if the data is available.
isPurchasable Boolean Whether an MSRP is listed for the release: true or false.
label string Record company that released the album.
moods Mood [ ] Terms that describe expressive characteristics of the music, returned only if the request specified an include=moods argument.
moodsUri string The customized Release/Moods request, returned only if the data is available.
parentalAdvisory string Parental Advisory label for the album. The possible values are:
Value    Description
N/ANot applicable. No Parental Advisory label.
Clean  An edited version of an album with Parental Advisory label.
PAParental Advisory, explicit content. Indicates excessive sexual references or profane language.
performanceRating integer An editorially assigned rating of a classical music performance on a release from 0 to 9, where 0 is no rating and higher numbers indicate a higher rating.
performances ReleasePerformance [ ] Information about the performances in a classical music release, returned only if the request specified an include=performances argument.
performancesUri string The customized Release/Performances request, returned only if the data is available.
primaryArtists AlbumArtist [ ] Names of the primary artists on the release.
primaryReview primaryReview The most recent major review of the release, returned only if the request specified an include=primaryreview argument.
primaryReviewUri string The customized Release/PrimaryReview request, returned only if the data is available.
rating integer An editorially assigned rating of the release from 0 to 9, where 0 is no rating and higher numbers indicate a higher rating.
releaseDate string Date of the release in YYYY-MM-DD format.
soundRating integer An editorially assigned rating of the sound quality from 0 to 10, where 0 is no rating and higher numbers indicate a higher rating.
styles Style [ ] Musical styles and subgenres relevant to the album release, returned only if the request specified an include=styles argument.
stylesUri string The customized Release/Styles request, returned only if the data is available.
themes Theme [ ] Topics, feelings, and circumstances that motivate or fit with the music, returned only if the request specified an include=themes argument.
themesUri string The customized Release/Themes request, returned only if the data is available.
title string Full name of the release.
tracks Track [ ] List of tracks on the release, returned only if the request specified an include=tracks argument.
tracksUri string The customized Release/Tracks request, returned only if the data is available.

JSON Response Example

Here's the response to Request Example 1, which asks for information about a release of Tan Dun: Ghost Opera. 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/release/info?apikey=apikey&sig=sig&
releaseid=MR0002392414.
{
  "status":"ok",
  "code":200,
  "messages":null,
  "build":"1.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":"MR0002392414"
  },
  "serverName":"tul1cssw3",
  "startTime":"2011-04-28T00:43:04.8888705Z",
  "endTime":"2011-04-28T00:43:04.9044958Z",
  "duration":15,
  "release":{
    "ids":{
      "albumId":"MW0001145279",
      "amgClassicalId":"W   17244",
      "amgPopId":"R  518192",
      "eanId":null,
      "releaseId":"MR0002392414",
      "upcId":"075597944525"
    },
    "title":"Tan Dun: Ghost Opera",
    "primaryArtists":[
      {
        "id":"MN0000775212",
        "name":"Kronos Quartet"
      }
    ],
    "guestArtists":null,
    "flags":null,
    "duration":0,
    "releaseDate":"1997-03-18",
    "rating":7,
    "performanceRating":0,
    "soundRating":0,
    "format":"CD",
    "label":"Nonesuch",
    "catalog":"79445",
    "isPurchasable":true,
    "parentalAdvisory":"",
    "genres":[
      {
        "id":"MA0000002521",
        "name":"Classical",
        "weight":10
      }
    ],
    "headlineReview":null,
    "classicalReviewUri":"http://api.rovicorp.com/data/v1.1/release/classicalReview?format=json&apikey=apikey&releaseid=MR0002392414",
    "classicalReview":null,
    "creditsUri":"http://api.rovicorp.com/data/v1.1/release/credits?format=json&apikey=apikey&releaseid=MR0002392414",
    "credits":null,
    "imagesUri":null,
    "images":null,
    "moodsUri":"http://api.rovicorp.com/data/v1.1/release/moods?format=json&apikey=apikey&releaseid=MR0002392414",
    "moods":null,
    "performancesUri":"http://api.rovicorp.com/data/v1.1/release/performances?format=json&apikey=apikey&releaseid=MR0002392414",
    "performances":null,
    "primaryReviewUri":"http://api.rovicorp.com/data/v1.1/release/primaryReview?format=json&apikey=apikey&releaseid=MR0002392414",
    "primaryReview":null,
    "stylesUri":"http://api.rovicorp.com/data/v1.1/release/styles?format=json&apikey=apikey&releaseid=MR0002392414",
    "styles":null,
    "themesUri":"http://api.rovicorp.com/data/v1.1/release/themes?format=json&apikey=apikey&releaseid=MR0002392414",
    "themes":null,
    "tracksUri":"http://api.rovicorp.com/data/v1.1/release/tracks?format=json&apikey=apikey&releaseid=MR0002392414",
    "tracks":null
  }
}

XML Response Example

Here's an XML response to Request Example 1, which asks for information about a release of Tan Dun: Ghost Opera.
Requested with http://api.rovicorp.com/data/v1.1/release/info?apikey=apikey&sig=sig&
releaseid=MR0002392414&format=xml.
<ReleaseDetail 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>MR0002392414</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cssw4</serverName>
  <startTime>2011-04-28T00:43:17.5821821Z</startTime>
  <endTime>2011-04-28T00:43:17.5821821Z</endTime>
  <duration>0</duration>
  <release>
    <ids>
      <albumId>MW0001145279</albumId>
      <amgClassicalId>W 17244</amgClassicalId>
      <amgPopId>R 518192</amgPopId>
      <eanId i:nil="true"/>
      <releaseId>MR0002392414</releaseId>
      <upcId>075597944525</upcId>
    </ids>
    <title>Tan Dun: Ghost Opera</title>
    <primaryArtists>
      <AlbumArtist>
        <id>MN0000775212</id>
        <name>Kronos Quartet</name>
      </AlbumArtist>
    </primaryArtists>
    <guestArtists i:nil="true"/>
    <flags xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true"/>
    <duration>0</duration>
    <releaseDate>1997-03-18</releaseDate>
    <rating>7</rating>
    <performanceRating>0</performanceRating>
    <soundRating>0</soundRating>
    <format>CD</format>
    <label>Nonesuch</label>
    <catalog>79445</catalog>
    <isPurchasable>true</isPurchasable>
    <parentalAdvisory/>
    <genres>
      <Genre>
        <id>MA0000002521</id>
        <name>Classical</name>
        <weight>10</weight>
      </Genre>
    </genres>
    <headlineReview i:nil="true"/>
    <classicalReviewUri>http://api.rovicorp.com/data/v1.1/release/classicalReview?format=xml&apikey=apikey&releaseid=MR0002392414</classicalReviewUri>
    <classicalReview i:nil="true"/>
    <creditsUri>http://api.rovicorp.com/data/v1.1/release/credits?format=xml&apikey=apikey&releaseid=MR0002392414</creditsUri>
    <credits i:nil="true"/>
    <imagesUri i:nil="true"/>
    <images i:nil="true"/>
    <moodsUri>http://api.rovicorp.com/data/v1.1/release/moods?format=xml&apikey=apikey&releaseid=MR0002392414</moodsUri>
    <moods i:nil="true"/>
    <performancesUri>http://api.rovicorp.com/data/v1.1/release/performances?format=xml&apikey=apikey&releaseid=MR0002392414</performancesUri>
    <performances i:nil="true"/>
    <primaryReviewUri>http://api.rovicorp.com/data/v1.1/release/primaryReview?format=xml&apikey=apikey&releaseid=MR0002392414</primaryReviewUri>
    <primaryReview i:nil="true"/>
    <stylesUri>http://api.rovicorp.com/data/v1.1/release/styles?format=xml&apikey=apikey&releaseid=MR0002392414</stylesUri>
    <styles i:nil="true"/>
    <themesUri>http://api.rovicorp.com/data/v1.1/release/themes?format=xml&apikey=apikey&releaseid=MR0002392414</themesUri>
    <themes i:nil="true"/>
    <tracksUri>http://api.rovicorp.com/data/v1.1/release/tracks?format=xml&apikey=apikey&releaseid=MR0002392414</tracksUri>
    <tracks i:nil="true"/>
  </release>
</ReleaseDetail>


See Also

↑ Top

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