V1.Metadata.MusicService.Composition:Releases

Jump to: navigation, search

Composition/Releases

Returns a list of album releases that feature a performance of a composition.

Syntax

composition/releases? compositionid=compositionid
amgclassicalid=amgclassicalid
&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language]

Request Example 1

Request a list of releases that feature a performance of Symphony No. 9 in D minor ("Choral"), Op. 125.

Request Example 2

Request just the first two releases.

Request Example 3

Request the next two releases.

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.

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

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

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

  • compositionid
  • amgclassicalid
compositionid Conditional Rovi Music ID for a classical music composition, consisting of the prefix MC followed by a ten-digit number. For example: MC0002369165. Your application can grab composition IDs from responses to the following requests:

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

  • compositionid
  • amgclassicalid
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 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).
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 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 Composition/Releases

ResponseTypeDescription
releases CompositionRelease [ ] Album releases featuring a performance of the composition specified in the request.

JSON Response Example

Here's the response to Request Example 3. 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":"MC0002366840",
    "offset":2,
    "count":2
  },
  "view":{
    "offset":2,
    "count":2,
    "total":1442
  },
  "serverName":"tul1cssw2",
  "startTime":"2011-04-27T23:40:27.5679432Z",
  "endTime":"2011-04-27T23:40:27.5679432Z",
  "duration":0,
  "parentIds":{
    "amgClassicalId":"C   34961",
    "compositionId":"MC0002366840"
  },
  "releases":[
    {
      "id":"MR0000213008",
      "title":"The Best of Classics",
      "performers":[
        {
          "id":"MN0000350127",
          "name":"Royal Philharmonic Orchestra"
        },
        {
          "id":"MN0000851272",
          "name":"Richard Clayderman"
        }
      ],
      "label":"Brilliant Classics \/ Delphine",
      "catalog":"2002",
      "releaseDate":"2005-01-04",
      "performanceRating":0,
      "isComplete":false
    },
    {
      "id":"MR0000253136",
      "title":"More Immortal Beloved",
      "performers":null,
      "label":"Sony Music Distribution",
      "catalog":"SK\/ST-62616",
      "releaseDate":"1996-08-?? a",
      "performanceRating":0,
      "isComplete":true
    }
  ]
}

XML Response Example

Here's an XML response to Request Example 3.
<CompositionReleasesDetail 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>MC0002366840</id>
    <offset>2</offset>
    <count>2</count>
    <format>xml</format>
  </parameters>
  <view>
    <offset>2</offset>
    <count>2</count>
    <total>1442</total>
  </view>
  <serverName>tul1cssw4</serverName>
  <startTime>2011-04-27T23:40:13.9485920Z</startTime>
  <endTime>2011-04-27T23:40:13.9642171Z</endTime>
  <duration>15</duration>
  <parentIds>
    <amgClassicalId>C 34961</amgClassicalId>
    <compositionId>MC0002366840</compositionId>
  </parentIds>
  <releases>
    <CompositionRelease>
      <id>MR0000213008</id>
      <title>The Best of Classics</title>
      <performers>
        <AlbumArtist>
          <id>MN0000350127</id>
          <name>Royal Philharmonic Orchestra</name>
        </AlbumArtist>
        <AlbumArtist>
          <id>MN0000851272</id>
          <name>Richard Clayderman</name>
        </AlbumArtist>
      </performers>
      <label>Brilliant Classics / Delphine</label>
      <catalog>2002</catalog>
      <releaseDate>2005-01-04</releaseDate>
      <performanceRating>0</performanceRating>
      <isComplete>false</isComplete>
    </CompositionRelease>
    <CompositionRelease>
      <id>MR0000253136</id>
      <title>More Immortal Beloved</title>
      <performers i:nil="true"/>
      <label>Sony Music Distribution</label>
      <catalog>SK/ST-62616</catalog>
      <releaseDate>1996-08-?? a</releaseDate>
      <performanceRating>0</performanceRating>
      <isComplete>true</isComplete>
    </CompositionRelease>
  </releases>
</CompositionReleasesDetail>


See Also

↑ Top

Personal tools