Returns terms that describe expressive characteristics of a movie or television program, along with weightings that reflect the relative strength of each term.
video/moods? | video=video cosmoid=cosmoid iguideid=iguideid |
&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language] [&localeresolution=localeresolution] |
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cosmoid | Conditional | Cosmo database ID for a movie, program, episode, or television series. 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. 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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
video | Conditional | Title of a movie, television program, or television series, or keywords from the title. This searches for the most popular title with that combination of words. Replace any spaces with plus (+) or percent20 (%20) symbols. Note: This parameter currently returns only US-English results. Support for other countries and languages will be added in the future. Condition: The request must contain just one of these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
count | No | Number of items to be returned. The default is zero, which returns all items after the offset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
country | No | Country the language parameter applies to, stated as a two-character ISO 3166 country code. Default is the default country of the language you specify (US if language is not specified). If an invalid combination of country and language is specified, US English will be returned.
Valid country codes are:
* Includes Wales, Scotland, and Northern Ireland. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | No | Format of the returned data: json or xml. The default is JSON. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
language | No | Language of response data. Although this request currently returns only English responses, you can specify a preferred language to be ready for future language expansion. Valid language codes are:
Default is en (English). If content is not available in the language requested, another language is chosen as determined by the Language Fallback Sequence table. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
localeresolution | No | How the language fallback rules should be applied for any content that is not available for the specified language and country. The values are:
Default is Full. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset | No | Number of items at the start of the available data to skip. The default is zero.
Use count and offset to paginate the data that is available to be returned. |
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 movie or program that are recognized by the Video Service. |
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 |
---|---|---|
moods | VideoMood [ ] | Moods that apply to the movie or program specified in the request. |