W2 Data Address Lookup 024 Service

W2 Data Address Lookup 024 Service

W2DataAddressLookup024Service is an address verification service. It provides a fully-formed address where partial details are provided. If there are multiple possible matches, it provides the list of them, up to a limit of 100.

Properties

The following properties pertain to this service.

Property Name Type Length Optional/Mandatory Notes
HouseNameNumber
String
26 Optional  
HouseName
String
26 Optional  
HouseNumber
String
26 Optional  
Postcode
String
8 Mandatory  
Street
String
40 Optional  
City
String
20 Optional  
Country
String
3 Optional  If set, must be a valid three-letter ISO country code as described here. If not set, the search will be within the United Kingdom (GBR)

Notes

  1. Usually this service is part of a larger bundle and appears toward the start of the workflow.

    Each address match will have an AddressId element. You can use this address code to call the service again and retrieve that specific address only at no cost. To do this add a QueryOptions property with key AddressLookupRef and with the address code as the value.

    If this QueryOptions parameter is provided the above QueryData will be ignored.

Response

The following is an example response:

<W2DataAddressLookUp024Result>
 <!-- One or more of these -->
 <Results>
	<W2DataAddressLookUp024Response>
	   <AddressLookupRef>TEST0004494</AddressLookupRef>
	   <Country>GBR/>
<HouseName />
<HouseNumber />
<SubBuildingName>Flat 12</SubBuildingName>
<DepartmentName/>
<DependentLocality/>
<DependentThroughfare/>
<DoubleDependentLocality/>
<OrganisationName/>
<PoBox/>
<Postcode>IV448TZ</Postcode>
<PostTown>TRAINING TOWN</PostTown>
<Thoroughfare>Heathfield House</Thoroughfare>
<AddressLine1>Flat 12 Heathfield House</AddressLine1>
<AddressLine2>TRAINING TOWN IV448TZ</AddressLine2>
<AddressLine3>United Kingdom</AddressLine3>
<AddressSummary>Flat 12, Heathfield House, TRAINING TOWN, IV448TZ, United kingdom</AddressSummary>
</W2DataAddressLookUp024Response>
</Results>
</W2DataAddressLookUp024Result>

Transaction Result

HaltTriggered False
ServiceTransactionResult
  • Success
  • ClientErrorInsufficientInformation Required field not supplied
ServiceInterpretResult
  • OneResult
  • MultipleResults
  • NoResults
  • NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult
  • NotApplicable - No search occurred to match against
  • Fail MissingMandatoryField or PatternNotMatched

 


Sandbox

<QueryOptions>
        <KeyValueOfstringstring>
            <Key>Sandbox</Key>
            <Value>true</Value>
        </KeyValueOfstringstring>
    </QueryOptions>

If the Sandbox query option is set to "true" the following entry will be returned in the ServiceResult: 

If HouseNameNumber = "26" and Postcode = "LN4 7AT":

The W2DataAddressLookup024Result will be null and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult NoResults
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If HouseNameNumber = "68" and Postcode = "RH13 3HE":

The W2DataAddressLookup024Result will have 2 results and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult MultipleResults
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If HouseNameNumber = "42" and Postcode = "hu12 9fl":

The W2DataAddressLookup024Result will have 1 result and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult OneResult
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If Postcode = "bs3 5an":

The W2DataAddressLookup024Result will have 3 results and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult MultipleResults
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If AddressLookupRef = "W2AR0001-0001-0001-0007":

The W2DataAddressLookup024Result will have 1 result and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult OneResult
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If Country = "USA" and Postcode = "20500-001:

The W2DataAddressLookup024Result will have 1 result and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult OneResult
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable