Returns a telephone number if the record can be matched
To connect to this service you'll need to use one of these endpoints:
Checks to see if a telephone number match can be made for this record. If it can, it returns the details of the record within BT OSIS.
By default matches are performed at
Surname level (i.e. a match will be allowed if the surname matches regardless of the title or forename passed in). This can be overridden by specifying the option
The following parameters can be supplied to this method
The following options can be specified as part of the
option parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
ApplicationNameGives the name of the calling application - used to break down usage by application in the usage reports on the dashboard
This uses the Electoral Roll to try and search for cohabitation. It is relatively common these days for households to be made up of several different surnames (for example - unmarried cohabitation). In these situations then the telephone line will usually be listed in one of the householders' names. If your record happens to be using another name in the household then you would not normally be able to make a match. To get around this problem, we look at the Edited Electoral Roll (ER) to see if we can identify a cohabitation situation. If we can then we will search under all the names in the household to see if a telephone line is listed under any the other occupants. Please note that in order for this option to work you will need to be licensed for the Electoral Roll service and you will be charged for a Name lookup for every query made.
This method returns an object containing the following fields:
Success field is
true, the other results described below can be used to get the results of the method.
false, some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the
ErrorMessage field, and any other results should be ignored
Contains the details found for the requested person on the telephone directory, in the following fields: