DataTools Kleber Method Description

Method:
DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress
You can use this method to retrieve full address details from the Canada Post PAF for record IDs prefixed with 'CaPaf'.

Test:

Parameter	Value
RecordId
LanguagePreference
RequestId
RequestKey
DepartmentCode

Input Parameters:

Parameter	Description
RecordId	Record ID of the address you wish to retrieve full address details for. Only supports Record IDs prefixed with 'CaPaf'.
LanguagePreference	ISO 639-2 code for preferred address language. Unless specified addresses will be returned in English if available. 'ALL' will return all language options available for requested address.
RequestId	Optional user value to assist in linking DtRequests with DtResponses.
RequestKey	Required for user access verification. For client side script protect your Request Key by using the DataTools.Security.GenerateTemporaryRequestKey
DepartmentCode	Optional user value to allocate transaction usage by department. Limit of 50 unique Department codes per account.

Output Fields:

Field	Description
DomesticId	Domestic Address ID eg DPID
Company	Company Name
Department	Department
BuildingName	Building Name
UnitLevelNumber	Unit and Level Number eg Office 310 Level 3
StreetNumber	Street Number eg 123
StreetName	Street Name eg Rue Main
SecondaryStreetName	Secondary Street Name
Block	Block
Neighbourhood	Neighbourhood
AddressLine1	Address Line 1 eg 2-123 Rue Main
AddressLine2	Address Line 2
AddressLine3	Address Line 3
AddressLine4	Address Line 4
AddressLine5	Address Line 5
District	District
LocalityCityTown	Locality/City/Town eg Blackville
StateProvince	State/Province eg NB
StateProvinceName	State/Province Name eg New Brunswick
StateProvinceCode	State/Province Code eg NB
Postcode	Postcode eg E9B 1N7
CountryName	Country Name eg Canada
CountryIso2	ISO 3166-2 character country code eg. 'CA'
CountryIso3	ISO 3166-3 character country code eg. 'CAN'
CountryIsoNumber	ISO 3166 Numeric Code eg 124
AdminAreaName	Admin Area Name
AdminAreaCode	Admin Area Code
SortingNumber1	Sorting Number 1
SortingNumber2	Sorting Number 2
Barcode	Barcode
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 with QueryString)

Request Format: Url QueryString, Body (x-www-form-urlencoded), Response Formats: JSON, XML*,
Protocols: HTTP GET, HTTPS GET, HTTP POST, HTTPS POST, HTTP OPTIONS, HTTPS OPTIONS
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc

Sample QueryString Request:
/ProcessQueryStringRequest?Method=DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress&RecordId=&LanguagePreference=&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":""
         }
      ]
   }
}

Sample Code:

Web Service Method: ProcessQueryJsonRequest (REST with JSON)

Request Format: Body (Raw JSON), Response Formats: JSON, XML*,
Protocols: HTTP GET, HTTPS GET, HTTP POST, HTTPS POST, HTTP OPTIONS, HTTPS OPTIONS
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc

Single Request

Sample JSON Request:
{
   "DtRequest":{
      "Method":"DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress", 
      "RecordId":"", 
      "LanguagePreference":"", 
      "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":""
         }
      ]
   }
}

Multiple Requests

Sample JSON Request:
{
   "DtRequests":{
      "DtRequest":[
         {
            "Method":"DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress", 
            "RecordId":"", 
            "LanguagePreference":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         },
         {
            "Method":"DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress", 
            "RecordId":"", 
            "LanguagePreference":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         }
      ]
   }
}

Sample JSON Response:
{
   "DtResponses":{
      "ErrorMessage":"",
      "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":""
               }
            ]
         },
         {
            "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":""
               }
            ]
         }
      ]
   }
}

Web Service Method: ProcessQueryXmlRequest (REST with XML)

Request Format: Body (Raw XML), Response Formats: JSON, XML*,
Protocols: HTTP GET, HTTPS GET, HTTP POST, HTTPS POST, HTTP OPTIONS, HTTPS OPTIONS
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc

Single Request

Sample XML Request:
<DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML 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="" />
</DtResponse>

Multiple Requests

Sample XML Request:
<DtRequests>
    <DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" />
</DtRequests>

Sample XML Response:
<DtResponses ErrorMessage="">
  <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="" />
  </DtResponse>
  <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="" />
  </DtResponse>
</DtResponses>

Web Service Method: ProcessXmlRequest (SOAP)

Request Format: XML over SOAP, Protocols: HTTP POST, HTTPS POST, Response Formats: XML, JSON*
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebServiceSoap/DtKleberService.svc
SOAP WSDL: https://customname.datatoolscloud.net.au/KleberWebServiceSoap/DtKleberService.svc?wsdl

Sample XML Request:
<DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML 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="" />
</DtResponse>

SOAP Envelope: The XML request is passed through a single parameter in the SOAP envelope <DtXmlRequest>. Where the development language requires the SOAP envelope contents to be defined manually, the additional step of encoding the Dt XML Request is required. The encoding required needs to transform "<" of the DtRequest to "<" and ">" to ">". See example below.

Sample SOAP Envelope:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
  <soapenv:Header/>
  <soapenv:Body>
    <tem:ProcessXmlRequest>
      <!--Optional:-->
      <tem:DtXmlRequest>
        &lt;DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" /&gt;
      </tem:DtXmlRequest>
    </tem:ProcessXmlRequest>
  </soapenv:Body>
</soapenv:Envelope>

Batching Requests: Use the <DtRequests> (plural) tag to send through multiple requests in a single transaction.

<DtRequests>
    <DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress" RecordId="" LanguagePreference="" RequestId="" RequestKey="" DepartmentCode="" />
</DtRequests>

Sample Code:

* 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.