ValidateAddressAUS - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

ValidateAddressAUS standardizes and validates Australian addresses using Australia Post address data. It also adds missing postal information, such as postal codes, city names, state/territory names, and more.

ValidateAddressAUS also returns result indicators about validation attempts, such as whether or not ValidateAddressAUS validated the address, and the reason for failure if the address could not be validated.

During address matching and standardization, ValidateAddressAUS separates address lines into components and compares them to the contents of a Universal Addressing Module database. If a match is found, the input address is standardized to the database information.

ValidateAddressAUS is part of the Universal Addressing Module.

Resource URL

JSON endpoint:

http://server:port/rest/ValidateAddressAUS/results.json
https://OnDemandServer/rest/ValidateAddressAUS/results.json 

XML endpoint:

http://server:port/rest/ValidateAddressAUS/results.xml
https://OnDemandServer/rest/ValidateAddressAUS/results.xml

For a list of Spectrum OnDemand servers, see Connecting to Spectrum OnDemand Servers.

Example with JSON Response

The following example requests a JSON response:

http://myserver:8080/rest/ValidateAddressAUS/results.json?​?Data.AddressLine1=73+YARANABBE+ROAD&Data.City=Darling+Point&Data.PostalCode=2027
https://spectrum.precisely.com/rest/ValidateAddressAUS/results.json?​Data.AddressLine1=73+YARANABBE+ROAD&Data.City=Darling+Point&Data.PostalCode=2027

The JSON returned by this request would be:

{"output_port": [{
   "AddressLine1": "73 YARRANABBE RD",
   "City": "DARLING POINT",
   "PostalCode": "2027",
   "StateProvince": "NSW",
   "CCD": "1440310",
   "DPID": "93400393",
   "AMAS.ResultCode": "2124",
   "AMAS.ResultMessage": "Street Name correction|State change/correction",
   "user_fields": []
}]}

Example with XML Response

The following example requests an XML response:

http://myserver:8080/rest/ValidateAddressAUS/results.xml?​Data.AddressLine1=73+YARANABBE+ROAD&Data.City=Darling+Point&Data.PostalCode=2027
https://spectrum.precisely.com/rest/ValidateAddressAUS/results.xml?​Data.AddressLine1=73+YARANABBE+ROAD&Data.City=Darling+Point&Data.PostalCode=2027

The XML returned by this request would be:

<xml.AMAS.ValidateAddressResponse​xmlns="http://www.pb.com/spectrum/services/AMAS.ValidateAddress">
   <output_port>
      <Address>
         <AddressLine1>73 YARRANABBE RD</AddressLine1>
         <City>DARLING POINT</City>
         <PostalCode>2027</PostalCode>
         <StateProvince>NSW</StateProvince>
         <CCD>1440310</CCD>
         <DPID>93400393</DPID>
         <AMAS.ResultCode>2124</AMAS.ResultCode>
         <AMAS.ResultMessage>Street Name correction|State change/correction</AMAS.ResultMessage>
         <user_fields/>
      </Address>
   </output_port>
</xml.AMAS.ValidateAddressResponse>