Harmony RightAddress JavaScript client API

Constants

Methods

Harmony.v2.find(address, sourceOfTruth, callback)

Invokes the find service.

The following example performs a single-line address search for '1 abc street' in Canada:

	Harmony.v2.find({ fullAddress: "1 abc street", country: "CA"}, null,
		function(response) {
			if (response.status == Harmony.SUCCESS) {
			
				// Do something with the response payload.
				for (var i = 0; i < response.payload.length; i++) {
					var address = response.payload[i];
					...
				}
				
			} else {
			
				// Show any error messages.
				for (var i = 0; i < response.messages.length; i++) {
					alert(response.messages[i]);
					...
				}
				
			}
		}
	);
	

Harmony.v2.retrieve(address, callback)

Invokes the retrieve service.

The following example identifies the input address with id of the address from the above find API.

	Harmony.v2.retrieve({ id: "xx|xx|xxx"},
		function(response) {
			if (response.status == Harmony.SUCCESS) {
			
				// Do something with the response payload.
				var result = response.payload[0];
				...
			} else {
			
				// Show any error messages.
				for (var i = 0; i < response.messages.length; i++) {
					alert(response.messages[i]);
					...
				}
				
			}
		}
	);
	

Harmony.reverseGeocode(address, sourceOfTruth, callback)

Invokes the combined reverseGeo service to get addresses with input latitude and longitude

The following example performs a combined reverseGeocode lookup:

	Harmony.reverseGeocode({"latitude": "xxx", "longitude": "xxx"}, null, 
		function(response) {
			if (response.status == Harmony.SUCCESS) {
			
				// Do something with the response payload.
				for (var i = 0; i < response.payload.length; i++) {
					var address = response.payload[i];
					...
				}
				
			} else {
			
				// Show any error messages.
				for (var i = 0; i < response.messages.length; i++) {
					alert(response.messages[i]);
					...
				}
				
			}
		}
	);
	

Harmony.init(username, password, locale)

Initialises the client.

The following example initialises the Harmony client with the credentials 'bob'/'password' and the Australian locale:

    Harmony.init("bob", "password", Harmony.AUSTRALIA);
    

Harmony.useEnv(environment)

Specifies the non-production service environment to be used for the requests. The default environment is Production.

The following example configures the Harmony client to use the PREVIEW environment:

    Harmony.useEnv(Harmony.ENV_PREVIEW);
    

Harmony.useProtocol(protocol)

Specifies the protocol to be used for the service requests. The default protocol is Cross-Origin Resource Sharing (CORS).

The following example configures the Harmony client to use the JSONP protocol over GET requests:

    Harmony.useProtocol(Harmony.JSONP);
    

Harmony.useFeatureOptions(featureOptions)

Specifies the FeatureOptions value when invoking the address lookup REST service methods.

The following example configures feature options for address lookup service methods:(Only need to specify the option value if want a different value from system default)

    Harmony.useFeatureOptions({singleLineHitNumber:'10', displayGnafLot: 1, 
    		exposeAttributes:'1', exposePhantom:'0'});
    

Harmony.Parse.address(address, callback)

Invokes the address parse service.

The following example parses the input address '220 george street, sydney 2000' as a String:

    Harmony.Parse.address("220 george street, sydney 2000", 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

The following example parses the input address '220 george street, sydney 2000' in an Address object (only available for harmony.min.js since version 1.6.0):

    Harmony.Parse.address({ fullAddress: "220 george street, sydney 2000" }, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.International.reverseGeocode(address, callback)

Invokes the international reverseGeo service to get addresses with input latitude and longitude

The following example performs the international reverseGeocode lookup:

	Harmony.reverseGeocode({"latitude": "xxx", "longitude": "xxx"},
		function(response) {
			if (response.status == Harmony.SUCCESS) {
			
				// Do something with the response payload.
				for (var i = 0; i < response.payload.length; i++) {
					var address = response.payload[i];
					...
				}
				
			} else {
			
				// Show any error messages.
				for (var i = 0; i < response.messages.length; i++) {
					alert(response.messages[i]);
					...
				}
				
			}
		}
	);
	

Harmony.International.getGeocode(address, callback)

Invokes the internationalGeocode service.

The following example get geocode information for an Australia Address:

	Harmony.International.getGeocode({"fullAddress":"28 station st E,Harris park nsw 2150",  "country":"Australia"},
		function(response) {
			if (response.status == Harmony.SUCCESS) {
				// Do something with the response payload.
				var resultGeocode = response.payload[0];
				...
				
			} else {
			
				// Show any error messages.
				for (var i = 0; i < response.messages.length; i++) {
					alert(response.messages[i]);
					...
				}
				
			}
		}
	);
	

Harmony.Validate.email(emailAddress, sourceOfTruth, callback)

Invokes the email validate service.

The following example performs a validation on the email address 'bob@example.org' as a String in VE_ALL Source of Truth:

    Harmony.Validate.email("bob@example.org", "VE_ALL",
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

The following example performs a validation on the email address 'bob@example.org' in an EmailAddress object in VE_ALL Source of Truth (only available for harmony.min.js since version 1.6.0.):

    Harmony.Validate.email( {address: "bob@example.org" }, "VE_ALL",
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Validate.phone(phone, callback)

Invokes the phone validate service.

The following example performs a validation on the mobile phone number '0412341234' for Australia:

    Harmony.Validate.phone({ fullPhone: "0412341234", country: "AU" }, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Company.abn(company, apiName, optionalConfig, guid, callback)

Invokes the Company Lookup/Validate service. The following are the explanations of the parameters used. Please refer to CompanyRestRequest for more details.

The following example performs a lookup on the company name 'mastersoft':

    Harmony.Company.abn("mastersoft", "", "", "", 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );