Tools
Performance/Images
Returns URLs to images of an album that contains the recording a classical music performance, 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
| performance/images? | performanceid=performanceid amgclassicalid=amgclassicalid |
&apikey=apikey&sig=sig [&format=format] [&country=country] [&language=language] |
Request Example 1
- Request images of an album with a performance of Carmina Burana.
Request Example 2
- Request the images in an XML response.
Request Parameters
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:
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 | 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:
|
| 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
| Response | Type | Description |
|---|---|---|
| build | string | The software release level of the API. |
| code | integer | HTTP status code. See the status field for the text part of the code. |
| duration | integer | Server processing time in milliseconds. The difference between startTime and endTime. |
| endTime | string | When the server sent the response (UTC time). |
| messages | Message [ ] | Elements of a multiple HTTP response status message. |
| parameters | parameters | The parameters that were included in the request. |
| parentIds | parentIds | All of the IDs for the requested object that are recognized by the API. |
| serverName | string | Name of the server that processed the request. |
| startTime | string | When the server received the request (UTC time). |
| status | string | Text part of the HTTP status code, which is shown in the code field. |
Response for Performance/Images
| Response | Type | Description |
|---|---|---|
| images | images | URLs to images of the album and information about the images. |
JSON Response Example
- Here's the response to Request Example 1, which asks for images of an album with a performance of Carmina Burana. 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/images?apikey=apikey&sig=sig&
performanceid=MQ0001255236.
{
"status":"ok",
"code":200,
"messages":null,
"build":"1.5.1.9",
"parameters":{
"apiKey":"apikey",
"id":"MQ0001255236"
},
"serverName":"tul1cssw2",
"startTime":"2011-04-28T00:28:51.2740268Z",
"endTime":"2011-04-28T00:28:51.2896519Z",
"duration":15,
"parentIds":{
"amgClassicalId":"F 2417001",
"performanceId":"MQ0001255236"
},
"images":{
"front":[
{
"height":74,
"width":75,
"formatid":71,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":168,
"width":170,
"formatid":63,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":247,
"width":250,
"formatid":44,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":396,
"width":400,
"formatid":64,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":495,
"width":500,
"formatid":16,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":1070,
"width":1080,
"formatid":62,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
}
],
"back":[ ]
}
}
"status":"ok",
"code":200,
"messages":null,
"build":"1.5.1.9",
"parameters":{
"apiKey":"apikey",
"id":"MQ0001255236"
},
"serverName":"tul1cssw2",
"startTime":"2011-04-28T00:28:51.2740268Z",
"endTime":"2011-04-28T00:28:51.2896519Z",
"duration":15,
"parentIds":{
"amgClassicalId":"F 2417001",
"performanceId":"MQ0001255236"
},
"images":{
"front":[
{
"height":74,
"width":75,
"formatid":71,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":168,
"width":170,
"formatid":63,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":247,
"width":250,
"formatid":44,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":396,
"width":400,
"formatid":64,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":495,
"width":500,
"formatid":16,
"url":"http://actual-url-concealed.jpg",
"author":null,
"copyrightOwner":null
},
{
"height":1070,
"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, which asks for images of an album with a performance of Carmina Burana in XML format.
- Requested with http://api.rovicorp.com/data/v1.1/performance/images?apikey=apikey&sig=sig&
performanceid=MQ0001255236&format=xml.
<PerformanceImages 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>MQ0001255236</id>
<format>xml</format>
</parameters>
<serverName>tul1cssw1</serverName>
<startTime>2011-04-28T00:29:02.2919663Z</startTime>
<endTime>2011-04-28T00:29:02.2919663Z</endTime>
<duration>0</duration>
<parentIds>
<amgClassicalId>F 2417001</amgClassicalId>
<performanceId>MQ0001255236</performanceId>
</parentIds>
<images>
<front>
<Image>
<height>74</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>168</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>247</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>396</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>495</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>1070</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>
</PerformanceImages>
<status>ok</status>
<code>200</code>
<messages i:nil="true"/>
<build>1.5.1.9</build>
<parameters>
<apiKey>apikey</apiKey>
<id>MQ0001255236</id>
<format>xml</format>
</parameters>
<serverName>tul1cssw1</serverName>
<startTime>2011-04-28T00:29:02.2919663Z</startTime>
<endTime>2011-04-28T00:29:02.2919663Z</endTime>
<duration>0</duration>
<parentIds>
<amgClassicalId>F 2417001</amgClassicalId>
<performanceId>MQ0001255236</performanceId>
</parentIds>
<images>
<front>
<Image>
<height>74</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>168</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>247</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>396</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>495</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>1070</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>
</PerformanceImages>