Method:
DataTools.Repair.Address.AuPaf.ReturnAddressSuggestions
Use to search for address suggestions against the Australian PAF using Australia Post's Rapid rules. This method will return multiple address suggestions closely matching the input address. This method requires user interaction to verify if a correct address match was found.
Test:
Input Parameters:
Output Fields:
| Field | Description |
| BuildingName | Building Name eg Sydney Square |
| AddressLine | Address Line eg. 'Level 5 200 Smith St' |
| Locality | Locality, Suburb or Town |
| State | State eg. NSW, VIC |
| Postcode | Postcode |
| AddressBlockLine1 | Address Line 1 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
| AddressBlockLine2 | Address Line 2 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
| AddressBlockLine3 | Address Line 3 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
| AddressBlockLine4 | Address Line 4 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
| AddressBlockLine5 | Address Line 5 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
| AddressBlockLine6 | Address Line 6 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
| AddressBlockLine7 | Address Line 7 of address block, use AddressBlockLine1 to 7 as an alternative to AddressLine, Locality, State and Postcode |
Supported Web Service API Interfaces:
Web Service Method: ProcessQueryStringRequest (REST)
Request Format: Url QueryString,
Protocols: HTTP GET, HTTPS GET,
Response Formats: JSON, XML*
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc
Sample QueryString Request:
/ProcessQueryStringRequest?Method=DataTools.Repair.Address.AuPaf.ReturnAddressSuggestions&AddressLine1=&AddressLine2=&AddressLine3=&AddressLine4=&AddressLine5=&AddressLine6=&Locality=&State=&Postcode=&RequestId=&RequestKey=&DepartmentCode=
Sample JSON Response:
{
"DtResponse":{
"RequestId":"",
"ResultCount":"1",
"ErrorMessage":"",
"Result":[
{
"BuildingName":"",
"AddressLine":"",
"Locality":"",
"State":"",
"Postcode":"",
"AddressBlockLine1":"",
"AddressBlockLine2":"",
"AddressBlockLine3":"",
"AddressBlockLine4":"",
"AddressBlockLine5":"",
"AddressBlockLine6":"",
"AddressBlockLine7":""
}
]
}
}
* Add the additional input parameter "OutputFormat=json" or "OutputFormat=xml" to change the response format from default.
* Add the additional input parameter "callback" to convert JSON responses to JSONP responses for across domains support.
CORS header included where callback is not defined.
Please Note:
Ensure you thoroughly test all the methods you are using and are happy with the results before going into production. DataTools is charged by the data suppliers for use of every method – therefore
ALL calls to any method will incur a COST. When you register DataTools provides you with free credit to help with development and trialling of the service. Once that credit is used you will need to purchase a monthly subscription and/or top up to continue using the service, even for development purposes. Please check the Method Pricing List for all current costs. DataTools does not warrant or guarantee the quality of the results returned and will not be held responsible for any costs incurred by using a method. Should you have any questions please contact your Sales representative or the Client Services team.