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

Jump to: navigation, search

Performance/Info

Returns basic information about a classical music performance plus customized requests for all of the other Performance content that is 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 your signature argument and execute the request.

The performance/info request also provides an optional argument to include responses from any or all of the other Performance 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

performance/info? performanceid=performanceid
amgclassicalid=amgclassicalid
&apikey=apikey&sig=sig [&include=include] [&format=format] [&country=country] [&language=language]

Request Example 1

Request the basic information about a performance using the performance ID.

Request Example 2

Request the basic information plus the credits.

Request Example 3

Request information using an AMG classical ID for an existing application that uses legacy AMG IDs.

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 performance, consisting of a string that starts with F and is followed by 9 digits with leading spaces. For example, F  2229909. AMG is a legacy database of entertainment information.

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

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

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

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

  • performanceid
  • 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.
include No Other Performance requests to include in the request. To include credits, for example, add include=credits.

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

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

You can also include all Performance 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 Performance/Info

ResponseTypeDescription
composition composition Information about the compositions performed in a classical music performance, returned only if the request specified an include=composition argument.
compositionUri string The customized Performance/Composition request, returned only if the data is available.
credits PerformanceCredit [ ] Production credits for the classical music performance, returned only if the request specified an include=credits argument.
creditsUri string The customized Performance/Credits request, returned only if the data is available.
duration integer Length of the performance in seconds.
excerpt string Title of the part performed if only part of the composition was performed.
ids ids All of the IDs that are recognized by the API for a performance. The possible IDs are:
  • performanceId
  • amgClassicalId
images images URLs to images of the album that contains the recording the classical music performance, returned only if the request specified an include=images argument and your subscription level enables access to images.
imagesUri string The customized Performance/Images request, returned only if the data is available.
isPick Boolean Whether the performance is recommended by Rovi: true or false.
notes string Short notes about the performance.
performers albumArtist [ ] List of the soloists, conductors, orchestras, and other performers.
rating integer An editorially assigned rating of the performance from 0 to 9, where 0 is no rating and higher numbers indicate a higher rating.
recordingDate string Date of the performance in YYYY-MM-DD format.
recordingPlace string Location of the performance.
release release Information about an album release that contains the recording of the classical music performance, returned only if the request specified an include=release argument.
releaseUri string The customized Performance/Release request, returned only if the data is available.
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.

JSON Response Example

Here's the response to Request Example 1, which asks for basic information about a performance. 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/performance/info?apikey=apikey&sig=sig&
performanceid=MQ0001169372
.
{
  "status":"ok",
  "code":200,
  "messages":null,
  "build":"1.5.1.9",
  "parameters":{
    "apiKey":"apikey",
    "id":"MQ0001169372"
  },
  "serverName":"tul1cssw1",
  "startTime":"2011-04-27T23:50:11.0270463Z",
  "endTime":"2011-04-27T23:50:11.0426714Z",
  "duration":15,
  "performance":{
    "ids":{
      "amgClassicalId":"F  2229909",
      "performanceId":"MQ0001169372"
    },
    "performers":null,
    "rating":0,
    "soundRating":0,
    "isPick":false,
    "recordingDate":"1961-03-20",
    "recordingPlace":"Manhattan Center, New York, NY",
    "duration":2204,
    "composition":null,
    "compositionUri":"http://api.rovicorp.com/data/v1.1/performance/composition?format=json&apikey=apikey&performanceid=MQ0001169372",
    "credits":null,
    "creditsUri":"http://api.rovicorp.com/data/v1.1/performance/credits?format=json&apikey=apikey&performanceid=MQ0001169372",
    "images":null,
    "imagesUri":"http://api.rovicorp.com/data/v1.1/performance/images?format=json&apikey=apikey&performanceid=MQ0001169372",
    "release":null,
    "releaseUri":"http://api.rovicorp.com/data/v1.1/performance/release?format=json&apikey=apikey&performanceid=MQ0001169372",
    "notes":"",
    "excerpt":""
  }
}

XML Response Example

Here's an XML response to Request Example 1, which asks for basic information about a performance.
Requested with http://api.rovicorp.com/data/v1.1/performance/info?apikey=apikey&sig=sig&
performanceid=MQ0001169372&format=xml
.
<PerformanceDetail 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>MQ0001169372</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cssw3</serverName>
  <startTime>2011-04-27T23:49:42.2648813Z</startTime>
  <endTime>2011-04-27T23:49:42.2961319Z</endTime>
  <duration>31</duration>
  <performance>
    <ids>
      <amgClassicalId>F 2229909</amgClassicalId>
      <performanceId>MQ0001169372</performanceId>
    </ids>
    <performers i:nil="true"/>
    <rating>0</rating>
    <soundRating>0</soundRating>
    <isPick>false</isPick>
    <recordingDate>1961-03-20</recordingDate>
    <recordingPlace>Manhattan Center, New York, NY</recordingPlace>
    <duration>2204</duration>
    <composition i:nil="true"/>
    <compositionUri>http://api.rovicorp.com/data/v1.1/performance/composition?format=xml&apikey=apikey&performanceid=MQ0001169372</compositionUri>
    <credits i:nil="true"/>
    <creditsUri>http://api.rovicorp.com/data/v1.1/performance/credits?format=xml&apikey=apikey&performanceid=MQ0001169372</creditsUri>
    <images i:nil="true"/>
    <imagesUri>http://api.rovicorp.com/data/v1.1/performance/images?format=xml&apikey=apikey&performanceid=MQ0001169372</imagesUri>
    <release i:nil="true"/>
    <releaseUri>http://api.rovicorp.com/data/v1.1/performance/release?format=xml&apikey=apikey&performanceid=MQ0001169372</releaseUri>
    <notes/>
    <excerpt/>
  </performance>
</PerformanceDetail>


See Also

↑ Top

Personal tools