Geocode Intl

Retrieves WGS84 geocode information for international address and locations.

Get Geocode methods

GET or POST methods

POST method it can allow to send a list of addresses (maximum 100 per request) and return the geocodes to each address.

For processing multiple addresses, it returns null for the address that encounters an exception.

Resource URL

POST    https://hosted.mastersoftgroup.com/harmony/rest/intl/address/geocode

GET     https://hosted.mastersoftgroup.com/harmony/rest/intl/address/geocode?country={country}&fullAddress={location}

Request

The request body is an AddressRestRequest object:

Name	Type	Example	Description
country*	country*	GB	ISO-2 or ISO-3 country
fullAddress*	string	Knowsley Industrial Park, LIVERPOOL, L33 7UY	The location to geocode. This can be a address, postal code or place name.

    {
        "payload":[
            { "fullAddress": "CA22 4SE", "country": "GB" },
            { "fullAddress": "20 Bond Street, Walker Flat SA 5238", "country": "AU" },
            { "fullAddress": "N6B 3L5", "country": "CA" },
            { "fullAddress": "Knowsley Industrial Park, LIVERPOOL, L33 7UY", "country": "GB" },
            { "fullAddress": "08550", "country": "US" },
            { "fullAddress": "19 Meado", "country": "IE" }
        ]
    }

Response

The response body is an AddressRestResponse object. With the enriched information being

Name	Type	Description
fullAddress	string	The name of the location found
attributes.Latitude	string	the Latitude of the full address in WSG84
attributes.Longitude	string	the Longitude of the full address in WSG84

Example

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "AddressIntl",
            "fullAddress": "22 Highlands Close, Finsbury Park, London, N4 4SE",
            "country": "GB",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "Latitude": "51.57366",
                "Longitude": "-0.12047"
            },
            "id": null,
            "district": null,
            "city": null,
            "province": null
        },
        {
            "_type": "AddressIntl",
            "fullAddress": "20 Bond Street, Walker Flat, South Australia, 5238",
            "country": "AU",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "Latitude": "-34.77875",
                "Longitude": "139.55431"
            },
            "id": null,
            "district": null,
            "city": null,
            "province": null
        },
        {
            "_type": "AddressIntl",
            "fullAddress": "Dundas Street, London ON N0M, N5V, N5W, N5X, N5Y, N5Z, N6A, N6B, N6C, N6E, N6G, N6H, N6J, N6K, N6M, N6P",
            "country": "CA",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "Latitude": "43.00336",
                "Longitude": "-81.18079"
            },
            "id": null,
            "district": null,
            "city": null,
            "province": null
        },
        {
            "_type": "AddressIntl",
            "fullAddress": "North Mersey Business Centre,Woodward Road, Knowsley Industrial Park, Liverpool",
            "country": "GB",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "Latitude": "53.4892",
                "Longitude": "-2.8515"
            },
            "id": null,
            "district": null,
            "city": null,
            "province": null
        },
        {
            "_type": "AddressIntl",
            "fullAddress": "Princeton Junction, NJ 08550",
            "country": "US",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "Latitude": "40.29213",
                "Longitude": "-74.61926"
            },
            "id": null,
            "district": null,
            "city": null,
            "province": null
        },
        {
            "_type": "AddressIntl",
            "fullAddress": "",
            "country": "IE",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "Latitude": "52.40025",
                "Longitude": "-9.286"
            },
            "id": null,
            "district": null,
            "city": null,
            "province": null
        }
    ]
}