DataTools Kleber Method Description

Method:
DataTools.Capture.Address.Predictive.NzPaf.SearchAddress
You can use this method when you have the start of an address you wish to search against the New Zealand PAF. This method is perfect for Predictive Search rapid address capture.

Please Note:
Special conditions apply to the use of this method. This method must always be used in conjunction with the retrieve method DataTools.Capture.Address.Predictive.NzPaf.RetrieveAddress. If the retrieve method is not called, or not utilised with an appropriate retrieve ratio to searches, an auto retrieve cost will be applied to your account to ensure you do not breach the data licencing conditions.

Test:

Parameter	Value
AddressLine
ResultLimit
SearchOption
RequestId
RequestKey
DepartmentCode

Input Parameters:

Parameter	Description
AddressLine	A full or part of a New Zealand address line of eg. '27 Hunter St' or '27 Hun'. The AddressLine argument can also optionally include the locality information eg '27 Hunt St Richmond'
ResultLimit	A numeric value representing the maximum results to be returned. If no value supplied a default maximum of 100 results will be returned.
SearchOption	Use to set search option such as when to start returning results as addresses are being entered. [Option Values]
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
RecordId	Record ID used to retrieve further information
AddressLine	Address Line eg. 'Level 5 200 Smith St'
Suburb	Suburb or Town
TownCityMailtown	Town, City or Mailtown eg. Palmerston North
Postcode	Postcode

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.NzPaf.SearchAddress&AddressLine=&ResultLimit=&SearchOption=&RequestId=&RequestKey=&DepartmentCode=

Sample JSON Response:
{
   "DtResponse":{
      "RequestId":"",
      "ResultCount":"1",
      "ErrorMessage":"",
      "Result":[
         {
            "RecordId":"",
            "AddressLine":"",
            "Suburb":"",
            "TownCityMailtown":"",
            "Postcode":""
         }
      ]
   }
}

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.NzPaf.SearchAddress", 
      "AddressLine":"", 
      "ResultLimit":"", 
      "SearchOption":"", 
      "RequestId":"", 
      "RequestKey":"", 
      "DepartmentCode":""
   }
}

Sample JSON Response:
{
   "DtResponse":{
      "RequestId":"",
      "ResultCount":"1",
      "ErrorMessage":"",
      "Result":[
         {
            "RecordId":"",
            "AddressLine":"",
            "Suburb":"",
            "TownCityMailtown":"",
            "Postcode":""
         }
      ]
   }
}

Multiple Requests

Sample JSON Request:
{
   "DtRequests":{
      "DtRequest":[
         {
            "Method":"DataTools.Capture.Address.Predictive.NzPaf.SearchAddress", 
            "AddressLine":"", 
            "ResultLimit":"", 
            "SearchOption":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         },
         {
            "Method":"DataTools.Capture.Address.Predictive.NzPaf.SearchAddress", 
            "AddressLine":"", 
            "ResultLimit":"", 
            "SearchOption":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         }
      ]
   }
}

Sample JSON Response:
{
   "DtResponses":{
      "ErrorMessage":"",
      "DtResponse":[
         {
            "RequestId":"",
            "ResultCount":"1",
            "ErrorMessage":"",
            "Result":[
               {
                  "RecordId":"",
                  "AddressLine":"",
                  "Suburb":"",
                  "TownCityMailtown":"",
                  "Postcode":""
               }
            ]
         },
         {
            "RequestId":"",
            "ResultCount":"1",
            "ErrorMessage":"",
            "Result":[
               {
                  "RecordId":"",
                  "AddressLine":"",
                  "Suburb":"",
                  "TownCityMailtown":"",
                  "Postcode":""
               }
            ]
         }
      ]
   }
}

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.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage="">
  <Result RecordId="" AddressLine="" Suburb="" TownCityMailtown="" Postcode="" />
</DtResponse>

Multiple Requests

Sample XML Request:
<DtRequests>
    <DtRequest Method="DataTools.Capture.Address.Predictive.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Capture.Address.Predictive.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" RequestId="" RequestKey="" DepartmentCode="" />
</DtRequests>

Sample XML Response:
<DtResponses ErrorMessage="">
  <DtResponse RequestId="" ResultCount="1" ErrorMessage="">
    <Result RecordId="" AddressLine="" Suburb="" TownCityMailtown="" Postcode="" />
  </DtResponse>
  <DtResponse RequestId="" ResultCount="1" ErrorMessage="">
    <Result RecordId="" AddressLine="" Suburb="" TownCityMailtown="" Postcode="" />
  </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.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage="">
  <Result RecordId="" AddressLine="" Suburb="" TownCityMailtown="" Postcode="" />
</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.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" 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.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Capture.Address.Predictive.NzPaf.SearchAddress" AddressLine="" ResultLimit="" SearchOption="" 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.