This comprehensive guide is designed to help technical staff effectively implement POSTMan web services.
Getting Started
The setup process is as follows:
purchase PWS credits. Please refer to our FAQ section on how credit use works.
review your welcome email from our team which includes your username and password
visit the PWS Dashboard and use your username and password. We recommend changing your password and checking that your usage credits are displayed correctly on the dashboard
go through the Integrating POSTman Web Services section
The POSTman Web Services site is where you access the product itself.
It is important that you monitor your usage from time to time; usage can be checked via the PWS Dashboard or via a method call in POSTman Web Services itself.
Integrating POSTman Web Services
Interface Examples
POSTman Web Services can be integrated into virtually any web form or application where an address is captured.
Minor corrections to an address or reformatting of an address to Australia Post standards can be done automatically without a user knowing.
Here you see an address was entered in the web form but was written slightly differently into the underlying database. This happens without the operator knowing it has occurred and improves the consistency of the data in your database.
If an address cannot be corrected automatically using Australia Post’s AMAS rules, the operator will be taken to a near matches list such as this one.
Usually at this point, you provide your operators with three options;
Select the correct address from the list
Leave the address as it is (a small percentage of valid addresses are not in the PAF, mainly in distant rural communities and new estates)
Go back and edit the original address
This type of interface is simple, intuitive and can have a dramatic effect improving the quality of the address data coming from your website.
Reference Manual
Set Log in
The SetLogin function is the first call made to the Postman KEngine to set the username and password. Other web methods are valid only if the user set a valid username and password by calling this web method.
Input Parameters
Parameter Name | Value | Description |
username | string | DMS username |
password | string | DMS password |
Return Structure
The call to setLogin will return unique string which needs to be saved by the user for the further use.
SetAddressFormat
The SetAddressFormat function is the first call made to the Postman KEngine to change the way the POSTman formats and returns address data.
Input Parameters
Parameter Name | Value | Description |
sessionID | string | Has to set to the string returned by the setLogin function |
mixedCase | boolean | Whether or not the search address can contain Mixed cases |
expandAbbreviations | boolean | Whether or not Postman engine expands the search address’s abbreviations |
Return Structure
The call to SetAddressFormat will return nothing; it only will set the settings for next search addresses
ScanAddress
The ScanAddress function is the first call made to the Postman KEngine to validate and correct an Australian postal address.
Input Parameters
Parameter Name | Value | Description |
sessionID | string | Has to set to the string returned by the setLogin function |
address1 | string | First line of the address to search for |
address2 | string | Second line of the address to search for |
address3 | string | Third line of the address to search for |
address4 | string | 4th line of the address to search for |
address5 | string | 5th line of the address to search for |
address6 | string | 6th line of the address to search for |
suburb | string | Suburb of the address to search for |
state | string | State of the address to search for |
postcode | string | Postcode of the address to search for |
country | string | Country of the address to search for |
Return Structure
The call to ScanAddress will return an XML packet with a table in it, POSTmanAddressRecord. The field structure for it is shown below
Parameter Name | Value | Description |
address1 | string | First line of the address to search for |
address2 | string | Second line of the address to search for |
address3 | string | Third line of the address to search for |
address4 | string | 4th line of the address to search for |
address5 | string | 5th line of the address to search for |
address6 | string | 6th line of the address to search for |
Barcode | string | Barcode of the address to search for |
BSP | string | BSP of the address to search for |
BSPState | string | BSPState of the address to search for |
DPID | string | DPID of the address to search for |
postcode | string | Postcode of the address to search for |
POBoxNo | integer | PoBox number of the address to search for |
POBoxprifix | integer | PoBox perifix of the address to search for |
poBoxsuffix | integer | PoBox suffix of the address to search for |
UnitNo | string | Number of the unit of the address to search for |
unitType | string | Type of the unit of the address to search for |
IsCorrectedAddress | boolean | Whether or not the address is corrected |
IsValidAddress | boolean | Whether or not the address is valid |
IsStreetAddress | boolean | Whether or not the address is an street address |
ScanAddress2
The ScanAddress2 function is the simpler version of ScanAddress, allows mode settings to be passed directly.
Input Parameters
Parameter Name | Value | Description |
sessionID | string | Has to set to the string returned by the setLogin function |
address1 | string | First line of the address to search for |
address2 | string | Second line of the address to search for |
address3 | string | Third line of the address to search for |
address4 | string | 4th line of the address to search for |
address5 | string | 5th line of the address to search for |
address6 | string | 6th line of the address to search for |
suburb | string | Suburb of the address to search for |
state | string | State of the address to search for |
postcode | string | Postcode of the address to search for |
mixedCase | boolean | Whether or not the search address can contain Mixed cases |
expandAbbreviations | boolean | Whether or not Postman engine expands the search address’s abbreviations |
Return Structure
The call to ScanAddress2 will return an XML packet with a table in it, POSTmanAddressRecord. The field structure for it is shown below.
Parameter Name | Value | Description |
address1 | string | First line of the address to search for |
address2 | string | Second line of the address to search for |
address3 | string | Third line of the address to search for |
address4 | string | 4th line of the address to search for |
address5 | string | 5th line of the address to search for |
address6 | string | 6th line of the address to search for |
Barcode | string | Barcode of the address to search for |
BSP | string | BSP of the address to search for |
BSPState | string | BSPState of the address to search for |
DPID | string | DPID of the address to search for |
postcode | string | Postcode of the address to search for |
POBoxNo | integer | PoBox number of the address to search for |
POBoxprifix | integer | PoBox perifix of the address to search for |
poBoxsuffix | integer | PoBox suffix of the address to search for |
UnitNo | string | Number of the unit of the address to search for |
unitType | string | Type of the unit of the address to search for |
IsCorrectedAddress | boolean | Whether or not the address is corrected |
IsValidAddress | boolean | Whether or not the address is valid |
IsStreetAddress | boolean | Whether or not the address is an street address |
NearestMatches
The NearestMatches function is the first call made to the Postman KEngine to return possible addresses near or similar to the one just scanned.
Input Parameters
Parameter Name | Value | Description |
sessionID | string | Has to set to the string returned by the setLogin function |
maxNumberOfMatches | integer | The maximum number of the returned recode of possible addresses near or similar to the one just scanned |
Value Description
Return Structure
The call to NearestMatches will return an XML packet with an array of the tables in it, an array of POSTmanAddressRecord. The field structure for each POSTmanAddressRecord is shown below
Parameter Name | Value | Description |
address1 | string | First line of the address to search for |
address2 | string | Second line of the address to search for |
address3 | string | Third line of the address to search for |
address4 | string | 4th line of the address to search for |
address5 | string | 5th line of the address to search for |
address6 | string | 6th line of the address to search for |
Barcode | string | Barcode of the address to search for |
BSP | string | BSP of the address to search for |
BSPState | string | BSPState of the address to search for |
DPID | string | DPID of the address to search for |
postcode | string | Postcode of the address to search for |
POBoxNo | integer | PoBox number of the address to search for |
POBoxprifix | integer | PoBox perifix of the address to search for |
poBoxsuffix | integer | PoBox suffix of the address to search for |
UnitNo | string | Number of the unit of the address to search for |
unitType | string | Type of the unit of the address to search for |
IsCorrectedAddress | boolean | Whether or not the address is corrected |
IsValidAddress | boolean | Whether or not the address is valid |
IsStreetAddress | boolean | Whether or not the address is an street address |
CurrentBalance
The CurrentBalance function is the first call made to the Postman KEngine to return the user current balance.
Input Parameters
Parameter Name | Value | Description |
sessionID | string | Has to set to the string returned by the setLogin function |
Return Structure
The call to CurrentBalance will return an XML packet with an integer value in it. This integer is your current balance which is decremented by 1 every time you use an address validation.