Method:
DataTools.Capture.Address.Predictive.UkPaf.RetrieveAddress
You can use this method to retrieve full address details from the Royal Mail PAF for record IDs prefixed with 'UkPaf'.
Test:
Input Parameters:
Output Fields:
Field | Description |
DomesticId | Domestic Address ID eg DPID |
Company | Company Name eg Royal Mail |
Department | Department |
BuildingName | Building Name |
UnitLevelNumber | Sub Building eg Croydon Delivery Office |
StreetNumber | Building Number eg 36-40 |
StreetName | Street Name eg Factory Lane |
SecondaryStreetName | Secondary Street Name |
Block | Block |
Neighbourhood | Neighbourhood |
AddressLine1 | Address Line 1 eg Croydon Delivery Office |
AddressLine2 | Address Line 2 eg 36-40 Factory Lane |
AddressLine3 | Address Line 3 |
AddressLine4 | Address Line 4 |
AddressLine5 | Address Line 5 |
District | District |
LocalityCityTown | Locality/City/Town eg Croydon |
StateProvince | State/Province |
StateProvinceName | State/Province Name |
StateProvinceCode | State/Province Code |
Postcode | Postal Code eg CR0 3RL |
CountryName | Country Name eg United Kingdom |
CountryIso2 | ISO 3166-2 character country code eg. 'GB' |
CountryIso3 | ISO 3166-3 character country code eg. 'GBR' |
CountryIsoNumber | ISO 3166 Numeric Code eg 826 |
AdminAreaName | Admin Area Name eg Croydon |
AdminAreaCode | Admin Area Code eg 00AH |
SortingNumber1 | Sorting Number 1 eg 79134 |
SortingNumber2 | Sorting Number 2 eg 79134 |
Barcode | Barcode eg (CR03RL1T1) |
PostBoxNumber | Post Box Number |
Language | Language |
LanguageAlternatives | Language Alternatives |
Type | Property Type [Option Values] |
DataLevel | Source Data Level [Option Values] |
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.Capture.Address.Predictive.UkPaf.RetrieveAddress&RecordId=&RequestId=&RequestKey=&DepartmentCode=
Sample JSON Response:
{
"DtResponse":{
"RequestId":"",
"ResultCount":"1",
"ErrorMessage":"",
"Result":[
{
"DomesticId":"",
"Company":"",
"Department":"",
"BuildingName":"",
"UnitLevelNumber":"",
"StreetNumber":"",
"StreetName":"",
"SecondaryStreetName":"",
"Block":"",
"Neighbourhood":"",
"AddressLine1":"",
"AddressLine2":"",
"AddressLine3":"",
"AddressLine4":"",
"AddressLine5":"",
"District":"",
"LocalityCityTown":"",
"StateProvince":"",
"StateProvinceName":"",
"StateProvinceCode":"",
"Postcode":"",
"CountryName":"",
"CountryIso2":"",
"CountryIso3":"",
"CountryIsoNumber":"",
"AdminAreaName":"",
"AdminAreaCode":"",
"SortingNumber1":"",
"SortingNumber2":"",
"Barcode":"",
"PostBoxNumber":"",
"Language":"",
"LanguageAlternatives":"",
"Type":"",
"DataLevel":""
}
]
}
}
* 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.