Page tree
Skip to end of metadata
Go to start of metadata


Introduction


DOTS Address Validation International (AVI) can be used as a RESTful service or with SOAP. AVI is designed to take an international address, validate it  and return a standardized international version of the address. Depending on the information available for a given address, AVI can return additional information about a given address. For example, it can return Delivery Point Validation (DPV) information for US addresses.

AVI can provide instant address verification and correction to websites or enhancement to contact lists.  However, the output from AVI must be considered carefully before the existence or non-existence of an address is decided


Developer Guide Map


Operations

This section lists the DOTS Address Validation International operations and goes into the details behind the inputs and outputs. 

Operations:

GetAddressInfo


Country Support Table

This section outlines all the countries supported by DOTS Address Validation International.


Status and ResolutionLevel Tables

This section outlines the Status and ResolutionLevel values returned by the service.


InformationComponents and Status Codes

This section outlines the possible InformationComponent and Status code values returned by the service.


Errors

This section reflects details on the error outputs that can happen with the service.


Code Snippets and Sample Code

Here you'll find code snippets for various programming languages and frameworks along with links to our sample code page on the web site.


Try The API

This is where you'll go to take the API for a spin.  There you can test our recommended operation GetAddressInfo.


Service Reference

In this section you'll find all the different endpoints supported by this service, input and output schema information as well as an opportunity to try the other endpoints as well.


Frequently Asked Questions

This is a list of some of the questions we hear more often that you can reference and get answers on right away.

Integration Basics


Integrating AVI into your application should be easy and straightforward.  If you are using a common platform, Service Objects may already have sample code built that you can use. However, if you are using a common platform that does not already have sample code, you can ask Service Objects to build you an example.  Email support@serviceobjects.com for more details.

Web Service Structure:

Web services are methods that integrate with other applications via the web, and encapsulate tricky business logic.  Web services are too large of a topic to cover in this document, but Service Objects has developed its web services to be as easy to integrate and as accessible as possible.

AVI is a public web service that supports SOAP, POST and GET operations, using RESTful paradigms or simple HTTP transport calls.


The host path, or physical location of the RESTful web service is here:
https://trial.serviceobjects.com/avi/api.svc/help


The host path, or physical location of the SOAP web service is here:
https://trial.serviceobjects.com/avi/soap.svc


A test page for the recommended operation can be found here:
AVI - Try The API


See the service references and try the other operations here:

AVI - Service Reference


The location of the WSDL, or Web Service Definition Language document, is here (This is also accessible via the "Service Definition" link.):
https://trial.serviceobjects.com/avi/soap.svc?singleWsdl


Important Notes!

  1. This XML is the definition of the web service, meaning its inputs, outputs, operations, and the like.  Most likely, you will have another tool read this WSDL and make the operations available to you in your application.  Whenever your utilities or IDE asks for a WSDL path to AVI, you can provide this one.

  2. SOAP is done via POST, only with special XML markup in the post-body.


  • No labels