Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
country | country The ISO 2-character country code of the search i.e. "GB" |
id | id The |
options | options |
Advanced Options
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.
IncludeMR | IncludeMR Includes addresses from the Multiple Residency database in the results (requires additional licensing). |
---|---|
IncludeNYB | IncludeNYB Includes addresses from the Not Yet Built database in the results (requires additional licensing). |
PreferredLanguage | PreferredLanguage Set this to |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is 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
|
---|---|
Results | Results A list of possible matches. Each one has the following properties:
|
Count | Count The number of matches found based on the information provided. |
SessionID | SessionID A SessionID is also included in the response. This should be included in any subsequent calls to the |