DataTools Kleber Method Description

Method:
DataTools.Verify.Address.NzPaf.VerifyAddress
Use to search an address against the New Zealand PAF using New Zealand Post's Batch rules. This method will return a single correct address match otherwise an error explaining why a match could not be found. This method requires no user interaction.

Test:

Parameter	Value
AddressLine1
AddressLine2
AddressLine3
AddressLine4
Suburb
TownCityMailtown
Postcode
RequestId
RequestKey
DepartmentCode

Input Parameters:

Parameter	Description
AddressLine1	Address line 1
AddressLine2	Address line 2
AddressLine3	Address line 3
AddressLine4	Address line 4
Suburb	Suburb
TownCityMailtown	Town, City or Mailtown
Postcode	Postcode
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
DPID	New Zealand Post Delivery Point Identifier
BuildingName	Building Name eg Sydney Square
AddressLine1	Address Line 1
AddressLine2	Address Line 2
AddressLine3	Address Line 3
Suburb	Suburb
TownCityMailtown	Town, City or Mailtown
Postcode	Postcode
MatchType	Returns a number that is the match type code for why an address didn't match [Option Values]
MatchTypeDescription	A meaningful description for why an address didn't match
FieldChanges	Codes representing the address components that were updated [Option Values]
ActiveStatus	Active Status
FormatFlag	Address Format Flag (output only)
AlternateLocality	Alternate Locality (output only)
LevelNumber	Building Level Number
LevelType	Building Level Type
UnitNumber	Flat / Unit Number
UnitType	Flat / Unit Type
PostBoxLobby	Post Box Lobby
PostBoxNumber	Postal Delivery Number
PostBoxType	Postal Delivery Type
RuralDeliveryType	Rural Delivery Type
RuralDeliveryNumber	Rural Delivery Number
RuralDeliverySupplement	Supplementary info for Rural Delivery
StreetName	Street Name
StreetType	Street Type
StreetNumber1	Street Number 1
StreetNumber1Alpha	Alpha suffix to Street Number 1
StreetTypeSuffix	Street Type Suffix or direction
StreetName2	Second Street Name
StreetType2	Second Street Type
StreetNumber2	Street Number 2
StreetNumber2Alpha	Alpha suffix to Street Number 2
StreetTypeSuffix2	Second Street Type Suffix or direction

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.Verify.Address.NzPaf.VerifyAddress&AddressLine1=&AddressLine2=&AddressLine3=&AddressLine4=&Suburb=&TownCityMailtown=&Postcode=&RequestId=&RequestKey=&DepartmentCode=

Sample JSON Response:
{
   "DtResponse":{
      "RequestId":"",
      "ResultCount":"1",
      "ErrorMessage":"",
      "Result":[
         {
            "DPID":"",
            "BuildingName":"",
            "AddressLine1":"",
            "AddressLine2":"",
            "AddressLine3":"",
            "Suburb":"",
            "TownCityMailtown":"",
            "Postcode":"",
            "MatchType":"",
            "MatchTypeDescription":"",
            "FieldChanges":"",
            "ActiveStatus":"",
            "FormatFlag":"",
            "AlternateLocality":"",
            "LevelNumber":"",
            "LevelType":"",
            "UnitNumber":"",
            "UnitType":"",
            "PostBoxLobby":"",
            "PostBoxNumber":"",
            "PostBoxType":"",
            "RuralDeliveryType":"",
            "RuralDeliveryNumber":"",
            "RuralDeliverySupplement":"",
            "StreetName":"",
            "StreetType":"",
            "StreetNumber1":"",
            "StreetNumber1Alpha":"",
            "StreetTypeSuffix":"",
            "StreetName2":"",
            "StreetType2":"",
            "StreetNumber2":"",
            "StreetNumber2Alpha":"",
            "StreetTypeSuffix2":""
         }
      ]
   }
}

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.Verify.Address.NzPaf.VerifyAddress", 
      "AddressLine1":"", 
      "AddressLine2":"", 
      "AddressLine3":"", 
      "AddressLine4":"", 
      "Suburb":"", 
      "TownCityMailtown":"", 
      "Postcode":"", 
      "RequestId":"", 
      "RequestKey":"", 
      "DepartmentCode":""
   }
}

Sample JSON Response:
{
   "DtResponse":{
      "RequestId":"",
      "ResultCount":"1",
      "ErrorMessage":"",
      "Result":[
         {
            "DPID":"",
            "BuildingName":"",
            "AddressLine1":"",
            "AddressLine2":"",
            "AddressLine3":"",
            "Suburb":"",
            "TownCityMailtown":"",
            "Postcode":"",
            "MatchType":"",
            "MatchTypeDescription":"",
            "FieldChanges":"",
            "ActiveStatus":"",
            "FormatFlag":"",
            "AlternateLocality":"",
            "LevelNumber":"",
            "LevelType":"",
            "UnitNumber":"",
            "UnitType":"",
            "PostBoxLobby":"",
            "PostBoxNumber":"",
            "PostBoxType":"",
            "RuralDeliveryType":"",
            "RuralDeliveryNumber":"",
            "RuralDeliverySupplement":"",
            "StreetName":"",
            "StreetType":"",
            "StreetNumber1":"",
            "StreetNumber1Alpha":"",
            "StreetTypeSuffix":"",
            "StreetName2":"",
            "StreetType2":"",
            "StreetNumber2":"",
            "StreetNumber2Alpha":"",
            "StreetTypeSuffix2":""
         }
      ]
   }
}

Multiple Requests

Sample JSON Request:
{
   "DtRequests":{
      "DtRequest":[
         {
            "Method":"DataTools.Verify.Address.NzPaf.VerifyAddress", 
            "AddressLine1":"", 
            "AddressLine2":"", 
            "AddressLine3":"", 
            "AddressLine4":"", 
            "Suburb":"", 
            "TownCityMailtown":"", 
            "Postcode":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         },
         {
            "Method":"DataTools.Verify.Address.NzPaf.VerifyAddress", 
            "AddressLine1":"", 
            "AddressLine2":"", 
            "AddressLine3":"", 
            "AddressLine4":"", 
            "Suburb":"", 
            "TownCityMailtown":"", 
            "Postcode":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         }
      ]
   }
}

Sample JSON Response:
{
   "DtResponses":{
      "ErrorMessage":"",
      "DtResponse":[
         {
            "RequestId":"",
            "ResultCount":"1",
            "ErrorMessage":"",
            "Result":[
               {
                  "DPID":"",
                  "BuildingName":"",
                  "AddressLine1":"",
                  "AddressLine2":"",
                  "AddressLine3":"",
                  "Suburb":"",
                  "TownCityMailtown":"",
                  "Postcode":"",
                  "MatchType":"",
                  "MatchTypeDescription":"",
                  "FieldChanges":"",
                  "ActiveStatus":"",
                  "FormatFlag":"",
                  "AlternateLocality":"",
                  "LevelNumber":"",
                  "LevelType":"",
                  "UnitNumber":"",
                  "UnitType":"",
                  "PostBoxLobby":"",
                  "PostBoxNumber":"",
                  "PostBoxType":"",
                  "RuralDeliveryType":"",
                  "RuralDeliveryNumber":"",
                  "RuralDeliverySupplement":"",
                  "StreetName":"",
                  "StreetType":"",
                  "StreetNumber1":"",
                  "StreetNumber1Alpha":"",
                  "StreetTypeSuffix":"",
                  "StreetName2":"",
                  "StreetType2":"",
                  "StreetNumber2":"",
                  "StreetNumber2Alpha":"",
                  "StreetTypeSuffix2":""
               }
            ]
         },
         {
            "RequestId":"",
            "ResultCount":"1",
            "ErrorMessage":"",
            "Result":[
               {
                  "DPID":"",
                  "BuildingName":"",
                  "AddressLine1":"",
                  "AddressLine2":"",
                  "AddressLine3":"",
                  "Suburb":"",
                  "TownCityMailtown":"",
                  "Postcode":"",
                  "MatchType":"",
                  "MatchTypeDescription":"",
                  "FieldChanges":"",
                  "ActiveStatus":"",
                  "FormatFlag":"",
                  "AlternateLocality":"",
                  "LevelNumber":"",
                  "LevelType":"",
                  "UnitNumber":"",
                  "UnitType":"",
                  "PostBoxLobby":"",
                  "PostBoxNumber":"",
                  "PostBoxType":"",
                  "RuralDeliveryType":"",
                  "RuralDeliveryNumber":"",
                  "RuralDeliverySupplement":"",
                  "StreetName":"",
                  "StreetType":"",
                  "StreetNumber1":"",
                  "StreetNumber1Alpha":"",
                  "StreetTypeSuffix":"",
                  "StreetName2":"",
                  "StreetType2":"",
                  "StreetNumber2":"",
                  "StreetNumber2Alpha":"",
                  "StreetTypeSuffix2":""
               }
            ]
         }
      ]
   }
}

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.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage="">
  <Result DPID="" BuildingName="" AddressLine1="" AddressLine2="" AddressLine3="" Suburb="" TownCityMailtown="" Postcode="" MatchType="" MatchTypeDescription="" FieldChanges="" ActiveStatus="" FormatFlag="" AlternateLocality="" LevelNumber="" LevelType="" UnitNumber="" UnitType="" PostBoxLobby="" PostBoxNumber="" PostBoxType="" RuralDeliveryType="" RuralDeliveryNumber="" RuralDeliverySupplement="" StreetName="" StreetType="" StreetNumber1="" StreetNumber1Alpha="" StreetTypeSuffix="" StreetName2="" StreetType2="" StreetNumber2="" StreetNumber2Alpha="" StreetTypeSuffix2="" />
</DtResponse>

Multiple Requests

Sample XML Request:
<DtRequests>
    <DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />
</DtRequests>

Sample XML Response:
<DtResponses ErrorMessage="">
  <DtResponse RequestId="" ResultCount="1" ErrorMessage="">
    <Result DPID="" BuildingName="" AddressLine1="" AddressLine2="" AddressLine3="" Suburb="" TownCityMailtown="" Postcode="" MatchType="" MatchTypeDescription="" FieldChanges="" ActiveStatus="" FormatFlag="" AlternateLocality="" LevelNumber="" LevelType="" UnitNumber="" UnitType="" PostBoxLobby="" PostBoxNumber="" PostBoxType="" RuralDeliveryType="" RuralDeliveryNumber="" RuralDeliverySupplement="" StreetName="" StreetType="" StreetNumber1="" StreetNumber1Alpha="" StreetTypeSuffix="" StreetName2="" StreetType2="" StreetNumber2="" StreetNumber2Alpha="" StreetTypeSuffix2="" />
  </DtResponse>
  <DtResponse RequestId="" ResultCount="1" ErrorMessage="">
    <Result DPID="" BuildingName="" AddressLine1="" AddressLine2="" AddressLine3="" Suburb="" TownCityMailtown="" Postcode="" MatchType="" MatchTypeDescription="" FieldChanges="" ActiveStatus="" FormatFlag="" AlternateLocality="" LevelNumber="" LevelType="" UnitNumber="" UnitType="" PostBoxLobby="" PostBoxNumber="" PostBoxType="" RuralDeliveryType="" RuralDeliveryNumber="" RuralDeliverySupplement="" StreetName="" StreetType="" StreetNumber1="" StreetNumber1Alpha="" StreetTypeSuffix="" StreetName2="" StreetType2="" StreetNumber2="" StreetNumber2Alpha="" StreetTypeSuffix2="" />
  </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.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage="">
  <Result DPID="" BuildingName="" AddressLine1="" AddressLine2="" AddressLine3="" Suburb="" TownCityMailtown="" Postcode="" MatchType="" MatchTypeDescription="" FieldChanges="" ActiveStatus="" FormatFlag="" AlternateLocality="" LevelNumber="" LevelType="" UnitNumber="" UnitType="" PostBoxLobby="" PostBoxNumber="" PostBoxType="" RuralDeliveryType="" RuralDeliveryNumber="" RuralDeliverySupplement="" StreetName="" StreetType="" StreetNumber1="" StreetNumber1Alpha="" StreetTypeSuffix="" StreetName2="" StreetType2="" StreetNumber2="" StreetNumber2Alpha="" StreetTypeSuffix2="" />
</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.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" 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.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" 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.