Returns the best image for each of up to 25 movies and television programs, as determined by four possible image metadata filters.
image/videomap? | cosmoid=cosmoid iguideid=iguideid |
&apikey=apikey&sig=sig&formatid=formatid [&imagetypeid=imagetypeid] [&zoomlevel=zoomlevel] [&multi=multi] [&format=format] |
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. | ||||||||||
formatid | Yes | Image size and file format to be returned. Select the format ID you want from the Format IDs table.
In case an image is unavailable in that format ID, specify multiple IDs in order of preference in a comma-separated list, like this: formatid=36,44,51. Returned images meet a combination of all of the following specified filters:
| ||||||||||
cosmoid | Conditional | Cosmo database ID for a movie, program, episode, or television series. Specify up to 25 IDs in a comma-separated list, like this: cosmoid=7903,22067749,20176744,20503614.
Cosmo is a database of television information. You can grab Cosmo IDs from responses to the following requests: Condition: The request must contain just one of these parameters:
| ||||||||||
iguideid | Conditional | An ID for a television program used by the i‑Guide™ interactive digital cable TV program guide. Specify up to 25 IDs in a comma-separated list, like this: iguideid=7072858,4834385,5239665,3899277.
You can get i‑Guide IDs from i‑Guide and from responses to the following requests: Condition: The request must contain just one of these parameters:
| ||||||||||
format | No | Format of the returned data: json or xml. The default is JSON. | ||||||||||
imagetypeid | No | Image type of returned images. Select the image type ID you want from the Image Type IDs table.
In case that image type is unavailable, specify multiple IDs in order of preference in a comma-separated list, like this: imagetypeid=6,8 Returned images meet a combination of all of the following specified filters:
| ||||||||||
multi | No | How to score images against multiple filters and multiple filter values. Applies to formatid, imagetype, and zoomlevel. Default is balanced.
| ||||||||||
zoomlevel | No | How close up people in the image appear. Select the zoom level you want from the Image Zoom Level table.
In case an image with that zoom level is unavailable, specify multiple zoom levels in order of preference in a comma-separated list, like this: zoomlevel=1,2,3 Returned images meet a combination of all of the following specified filters:
|
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. |
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. |
view | view | Summary of items returned in a list of items. |
Response | Type | Description |
---|---|---|
images | item [ ] | URLs to images that meet the specifications in the request, one for each ID, along with information about each image. |