Returns Rovi IDs for a person or group in your catalog in order of confidence level, based on name and field-level data, along with data you can use to verify a match.
Note: The primary Rovi ID for a name is the name ID.
catalog/match/name?apikey=apikey&sig=sig&name=name [&birthdate=birthdate] [&deathdate=deathdate] [&include=include] [&format=format] [&size=size]
♫ Music-related requests 日 Movie-related requests ⊑⊒ TV-related requests
Parameter | Required | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||
catalog | Yes | Database to match against.
| ||||||||||||||||
name | Yes | Name of the person or group. This returns the top search result for that name. Replace any spaces with plus (+) or percent20 (%20) symbols. | ||||||||||||||||
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. | ||||||||||||||||
birthdate | No | Date of birth in YYYYMMDD format. | ||||||||||||||||
deathdate | No | Date of death in YYYYMMDD format. | ||||||||||||||||
format | No | Format of the returned data: json or xml. The default is JSON.
Alternatively you can specify the response format in an HTTP Accept header with either of these Accept field content types:
If you specify both, the format parameter overrides the Accept header. | ||||||||||||||||
include | No | Additional data to include in each result returned. To include images of a person, for example, specify include=images. For multiple includes, separate the values with commas like this: include=images,factsheets. A request can contain up to 20 include values.
The data that is available for a person depends, in general, on the area of work they are involved in as shown by the catalog icons:
Reminder: These options may return a large amount of data. To speed data transmission, do the following:
| ||||||||||||||||
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 |
---|---|---|
results | result [ ] | Information about items that match the criteria specified in the request. |
Code | Description |
---|---|
400 | Incorrect or invalid request. The reason is shown in the Message object in ControlSet. |