AddressComplete – Web Services
Web Services
Description
Find addresses matching the search term.
Returns the full address details based on the Id.
Using the AddressComplete API
The AddressComplete API is an advanced option for companies who want to implement a custom integration of AddressComplete.
To setup a API key please visit our directions on Creating an API Key.
The AddressComplete API
The following 2 methods implement AddressComplete:
- AddressComplete Interactive Find
- AddressComplete Interactive Retrieve
Starting a Regular Search with Find
Searching is initiated on a key press with the full SearchTerm and ISO Country sent to Find. Call the method after each key press using the onkeyup event. Use caching where possible to reduce server load. The Find method will return a list of up to 8 matching objects.
Present the list to the user. The Text & Description fields show the content of the search results and should be concatenated, ideally utilising the Highlights field to embolden the appropriate parts. If the selected item has a Next field containing Retrieve, pass the selected Id to Retrieve. Otherwise perform another Find, passing the Id into the LastId parameter.
Retrieve
Retrieve returns the formatted address.
The results of Retrieve are a series of FieldGroups. The Common group is populated for all countries. The Common Label formats the address in the preferred casing and styling for the selected country. These fields can be used as appropriate to map back to a website or application after collecting the address.
API Documentation Overview
From the API page, select the name of the web service to access the documentation page for that method. Each page contains the following sections:
①
The top section of the page contains the link to the WSDL for SOAP requests on the left and on the right, samples for all RESTful endpoints and function examples for a number of common programming languages. Choose a code sample language and then select View. The code sample will be displayed and you can copy it for use within your own calls to the service.
②
Try it
This section allows you to enter dummy information, simulate a test request and view the response. A Results table will appear after you select Start the test.
③
Parameters
This section lists the parameters (optional and required) that you need to populate when making the request.
④
Fields
The elements contained in the response object.
⑤
Response Errors
Error messages and their codes specific to a particular web service.
⑥
General Errors
A comprehensive list of all account and web service errors. Not specific to a particular web service method.
