Searches titles for a string in select areas of Rovi Cloud Services and returns a JSON response with results listed in order of popularity and similarity to the search query.
search?query=query&entitytype=entitytype&facet=facet&apikey=apikey&sig=sig [&filter=filter] [&include=include] [&provider=provider] [&offset=offset] [&size=size]
Parameter | Required | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||||||||||||||||||||||||||||
entitytype | Yes | Type of content to search for.
| ||||||||||||||||||||||||||||||||||||||||||
facet | Yes | Count of items available to be returned.
| ||||||||||||||||||||||||||||||||||||||||||
query | Yes | The URL-encoded search string. Spaces may be replaced with plus (+) or percent20 (%20) symbols. The case of characters does not affect the results (search is not case-sensitive). | ||||||||||||||||||||||||||||||||||||||||||
sig | Yes | A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
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. | ||||||||||||||||||||||||||||||||||||||||||
filter | No | Field content that determines which results are returned. Like a WHERE clause in an SQL statement, this parameter selects only results with fields that meet your criteria. Note: Operators within the parameter value must be specified URL-encoded.
Examples:
The selection operators include:
URL-encoded characters are not case-sensitive. For the And operation, specify another filter parameter like this: filter=releasedate%3E%3D20070101&filter=releasedate%3C20080101. A request can contain up to 20 filter parameters. The following shows which fields you can select for each entity type. If you specify a filter that does not apply to an entity type, no data will be returned for that entity type.
| ||||||||||||||||||||||||||||||||||||||||||
include | No | Additional data to include in each response. To include moods in movie results, for example, specify include=movie:moods. For multiple includes, separate the values with commas like this: include=movie:moods,styles. For multiple entity types, specify separate parameters like this: include=movie:moods,tones&include=tvseries:moods,tones. A request can contain up to 100 include values.
| ||||||||||||||||||||||||||||||||||||||||||
offset | No | Number of items at the start of the returned list to skip. The default is zero.
Use offset and size to paginate the response. | ||||||||||||||||||||||||||||||||||||||||||
provider | No | Not currently used; reserved for future use. | ||||||||||||||||||||||||||||||||||||||||||
size | No | The number of items you want to be returned. The default is 20. |
Response | Type | Description |
---|---|---|
controlSet | ControlSet | The HTTP response status. |
id | String | Server transaction ID for the response. |
Response | Type | Description |
---|---|---|
album | Album | Album/Info response, returned only for a request with an entity type of album. |
facetcounts | FacetCounts [ ] | Number of results available to be returned in each genre or entity type, as requested by the facet parameter. |
id | String | Database ID for an item returned in a search response. |
messages | String [ ] | Reasons why an item was selected for the search response. |
movie | Movie | A Movie/Info response, returned only for a search request with an entitytype of movie or tvseries. |
name | Name | Name/Info response, returned only for a search request with an entity type of artist. |
provider | String | Database in which a search result was found:
|
relevance | Relevance [ ] | Rating of an item in a search response. Items with a higher relevance appear earlier in the list of items. |
song | Song | Song/Info response, returned only for a request with an entity type of song. |
type | String | Entity type of a search result. |
Error Codes
Code | Description |
---|---|
400 | Incorrect or invalid request. The reason is shown in the Message object in ControlSet. |
502 | No results found. The Message object in ControlSet returns the following:
{ "code": "Empty Result", "name": "No results available for this request" } |