Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

Getting Started

Before you can start using POSTman Web Services (PWS for short), you need to The setup process is as follows:

  1. purchase PWS credits.

...

To sign up, please email support@posimente.com.

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 POSTman Web Services site and utilise the product.

Ensure to keep your username and password secure as any usage attributed to it will be taken from your account.

If you believe your login has been compromised, please contact Posimente to change your password immediately.

In order to modify your account details or check your account’s current usage, please visit the POSTman Web Services site.

...

The next step is to integrate POSTman Web Services into your website. To do this, first review the interface examples in the Interface Examples section of this document for ideas on how to implement POSTman Web Services. Next, review the Reference Manual section to familiarise yourself with POSTman Web Services and its methods. Finally, refer to the Program Examples section to see source code examples in C#, Java, PHP and other languages.

POSTman Web Services itself is available from; https://webservice.dmsw.com.au/postman/

To login into the web service, utilize the username and password that DMS has provided.

...

  1. Please refer to our FAQ section on how credit use works.

  2. review your welcome email from our team which includes your username and password

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

  4. 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 on the web service website via the PWS Dashboard 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.

Integrating POSTman Web Services

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.

...

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

...

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.

...

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.

...