ValidateAddressAUS - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (SOAP)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (SOAP)
First publish date
2006

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

https://OnDemandServer/soap/ValidateAddressAUS

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

Example

The following shows a SOAP request:

<soapenv:Envelope
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:val="http://www.pb.com/spectrum/services/ValidateAddressAUS">
	<soapenv:Header/>
	<soapenv:Body>
		<val:ValidateAddressAUSRequest>
			<val:input_port>
				<val:Address>
					<!--Optional:-->
					<val:AddressLine1>73 YARANABBE ROAD</val:AddressLine1>
					<!--Optional:-->
					<val:AddressLine2></val:AddressLine2>
					<!--Optional:-->
					<val:AddressLine3></val:AddressLine3>
					<!--Optional:-->
					<val:AddressLine4></val:AddressLine4>
					<!--Optional:-->
					<val:City>Darling Point</val:City>
					<!--Optional:-->
					<val:StateProvince></val:StateProvince>
					<!--Optional:-->
					<val:PostalCode>2027</val:PostalCode>
					<!--Optional:-->
					<val:user_fields>
						<val:user_field>
							<val:name>?</val:name>
							<val:value>?</val:value>
						</val:user_field>
					</val:user_fields>
				</val:Address>
			</val:input_port>
		</val:ValidateAddressAUSRequest>
	</soapenv:Body>
</soapenv:Envelope>

This would be the response:

<soap:Envelope
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns3:ValidateAddressAUSResponse
			xmlns:ns2="http://spectrum.pb.com/"
			xmlns:ns3="http://www.pb.com/spectrum/services/ValidateAddressAUS">
			<ns3:output_port>
				<ns3:Address>
					<ns3:CouldNotValidate/>
					<ns3:AddressLine1>73 Yarranabbe Rd</ns3:AddressLine1>
					<ns3:City>DARLING POINT</ns3:City>
					<ns3:ApartmentLabel/>
					<ns3:ApartmentNumber/>
					<ns3:City.Result>V</ns3:City.Result>
					<ns3:AddressLine2/>
					<ns3:AddressLine3/>
					<ns3:AddressLine4/>
					<ns3:StateProvince>NSW</ns3:StateProvince>
					<ns3:PostalCode>2027</ns3:PostalCode>
					<ns3:HouseNumber>73</ns3:HouseNumber>
					<ns3:StreetName>Yarranabbe Rd</ns3:StreetName>
					<ns3:StreetSuffix>Rd</ns3:StreetSuffix>
					<ns3:HouseNumber.Result>V</ns3:HouseNumber.Result>
					<ns3:StreetName.Result>C</ns3:StreetName.Result>
					<ns3:StreetSuffix.Result>F</ns3:StreetSuffix.Result>
					<ns3:StateProvince.Result>A</ns3:StateProvince.Result>
					<ns3:PostalCode.Result>V</ns3:PostalCode.Result>
					<ns3:user_fields>
						<ns3:user_field>
							<ns3:name>?</ns3:name>
							<ns3:value>?</ns3:value>
						</ns3:user_field>
					</ns3:user_fields>
				</ns3:Address>
			</ns3:output_port>
		</ns3:ValidateAddressAUSResponse>
	</soap:Body>
</soap:Envelope>