This comprehensive guide is designed to help programmers effectively implement POSTMan web services.
Getting Started
Before you can start using POSTman Web Services, you must sign up for a subscription. DMS are happy to provide you with a trial subscription allowing limited usage to get you up and going or to evaluate POSTman Web services if you wish.
...
Once your registration is completed, you will be sent a username and password. This username and password is used to both sign-in to the https://postmanws.com site and also to utilize the Web Service itself.
Make sure you keep this username and password secure as any usage attributed to it will be taken from your account.
If you believe your login has been compromised, contact DMS to change your password immediately.
...
Finally, it is important that you monitor your usage from time to time, usage can be checked on the web service website or via a method call in POSTman Web Services itself. If you believe you are going to run out of usage in the current usage period and do not wish to risk having the service unavailable, then contact DMS immediately via support@dmsw.com.au or by phoning (07) 3510 9555 to top-up your web service usage in the current period or to adjust your subscription.
Interface Examples
POSTman Web Services can be integrated into virtually any web form or application where an address is captured.
...
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.
...
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.
...
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.
...
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 |
...
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.
...
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.
...