API

Methods

Objects

Back to current API

Combined International address lookup methods

International address lookup methods take complete or partial address information as an input and perform a search against a given country including Australia and New Zealand, returning address information that matches the search parameters.

The API Specification, also available on each method below - it requires valid username and password.

lookup Lookup international addresses using a single-line input address.
retrieve Retrieve international address details using the result from international address lookup.

lookup

Lookup international addresses from a given country including Australia/New Zealand using a single-line input address. Please try this demo for a list of supported countries other than Australia/New Zealand.

Resource URL


    POST    https://hosted.mastersoftgroup.com/harmony/rest/address/lookup
Or if using GET: 

    GET    https://hosted.mastersoftgroup.com/harmony/rest/address/lookup

Request (POST)

The request body is an AddressRestRequest object:

  • The fullAddress attribute is required
  • The country attribute is required; its value should be an ISO 3166-1 alpha-2 country code.
  • The sourceOfTruth attribute is optional

    {
        "payload": [ { "fullAddress": "10 Downing Street", "country": "GB" } ]
    }

For AU and NZ:

    
    {
        "payload": [ { "fullAddress": "20 bond Street", "country": "AU" } ],
        "sourceOfTruth": "AUPAF"
    }

Request Parameters (GET)

  • The fullAddress parameter is required
  • The country parameter is required; its value should be an ISO 3166-1 alpha-2 country code.
  • The sourceOfTruth attribute is optional

Response

The response body is an AddressRestResponse object, which looks like below:


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "10 Downing Street SomeCity, B63 3TA",
                "country": null,
                "postcode": null,
                "street2": null,
                "street": null,
                "streetNumber": null,
                "postal": null,
                "postalType": null,
                "postalNumber": null,
                "buildingName": null,
                "subdwelling": null,
                "attributes": null,
                "id": "GB|RM|A|123456",
                "district": null,
                "city": null,
                "province": null
            }
        ]
    }

For AU and NZ:

    
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "220 GEORGE ST, SomeCity NSW 2150",
                "country": null,
                "postcode": "2150",
                "street2": null,
                "street": "GEORGE ST",
                "streetNumber": "220",
                "postal": "",
                "postalType": "",
                "postalNumber": "",
                "buildingName": "",
                "subdwelling": "",
                "eid": "982407C8CC957CD0BE3984B913436F51508889391D6493DE",
                "lotNumber": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "streetSuffix": "",
                "streetType": "ST",
                "streetName": "GEORGE",
                "attributes": null,
                "id": "40591980",
                "exception": null,
                "state": "NSW",
                "locality": "SomeCity"
            }
        ]
    }

retrieve

Retrieve international address details using the address id returned from the international address lookup.

Resource URL


    POST    https://hosted.mastersoftgroup.com/harmony/rest/address/retrieve
Or if using GET 

    GET    https://hosted.mastersoftgroup.com/harmony/rest/address/retrieve

Request (POST)

The request body is an AddressRestRequest object:

  • The id attribute is required
  • The country parameter is required; its value should be an ISO 3166-1 alpha-2 country code.
  • The sourceOfTruth attribute is optional

    {
        "payload": [ { "id": "GB|RM|A|123456", "country": "GB" } ]
    }

For AU and NZ:

    
    {
        "payload": [ { "id": "40591980", "country": "AU" } ],
        "sourceOfTruth": "AUPAF"
    }

Request Parameter (GET)

  • The id parameter is required
  • The country parameter is required; its value should be an ISO 3166-1 alpha-2 country code.
  • The sourceOfTruth attribute is optional

Response

The response body is an AddressRestResponse object:


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "Prime Minister & First Lord of the Treasury, 10 Downing Street, LONDON, SW1A 2AA, UNITED KINGDOM",
                "country": "United Kingdom",
                "postcode": "SW1A 2AA",
                "street2": "",
                "street": "Downing Street",
                "streetNumber": "10",
                "postal": "",
                "postalType": "",
                "postalNumber": null,
                "buildingName": "",
                "subdwelling": "",
                "attributes": {
                    ...
                },
                "id": "GB|RM|A|12345678",
                "district": "",
                "city": "London",
                "province": ""
            }
        ]
    }

For AU and NZ:

    
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullAddress": "220 GEORGE ST, PARRAMATTA NSW 2150",
                "country": null,
                "postcode": "2150",
                "street2": null,
                "street": "GEORGE ST",
                "streetNumber": "220",
                "postal": "",
                "postalType": "",
                "postalNumber": "",
                "buildingName": "",
                "subdwelling": "",
                "eid": null,
                "lotNumber": "",
                "flatUnitNumber": "",
                "flatUnitType": "",
                "floorLevelNumber": "",
                "floorLevelType": "",
                "streetSuffix": "",
                "streetType": "ST",
                "streetName": "GEORGE",
                "attributes": {
                	"Barcode": "1301011100123001302200331112310103013",
                	"DPID": "40591980",
                	"PAFPosition": "ROOFTOP"
                },
                "id": "40591980",
                "exception": null,
                "state": "NSW",
                "locality": "PARRAMATTA"
            }
        ]
    }