Harmony RightAddress JavaScript client API

Constants

Methods

Harmony.address(address, sourceOfTruth, callback)

Invokes the address service.

The following example performs a single-line address search for '1 abc street' in the AUPAF Source of Truth:

    Harmony.address({ fullAddress: "1 abc street" }, Harmony.AUPAF, 
            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.buildingName(address, sourceOfTruth, callback)

Invokes the buildingName service.

The following example performs a search for building names beginning with 'anz':

    Harmony.buildingName({ buildingName: "anz" }, Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

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.locality(address, sourceOfTruth, callback)

Invokes the locality service.

The following example performs a search for localities beginning with 'syd':

    Harmony.locality({ locality: "syd" }, Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.postal(address, sourceOfTruth, callback)

Invokes the postal service.

The following example performs a search for postal addresses in the 'Sydney' locality (postcode '2001') beginning with 'gpo box 1':

    Harmony.postal({ postcode: "2001", locality: "sydney", postal: "gpo box 1" }, 
            Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.postcode(address, sourceOfTruth, callback)

Invokes the postcode service.

The following example performs a search for locality/postcode combinations for the postcode '2000':

    Harmony.postcode({ postcode: "2000" }, Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.street(address, sourceOfTruth, callback)

Invokes the street service.

The following example performs a search for streets in the locality 'sydney' (with postcode '2000') beginning with 'geor':

    Harmony.street({ postcode: "2000", locality: "sydney", street: "geor" }, 
            Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.streetNumber(address, sourceOfTruth, callback)

Invokes the streetNumber service.

The following example performs a search for street numbers in the locality 'sydney' (with postcode '2000') on the street 'george st' beginning with '22':

    Harmony.streetNumber(
            { 
                postcode: "2000", 
                locality: "sydney", 
                street: "george st", 
                streetNumber: "22" 
            }, 
            Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.subdwelling(address, sourceOfTruth, callback)

Invokes the subdwelling service.

The following example performs a search for subdwellings in the locality 'sydney' (with postcode '2000') at number '220 on the street 'george st' beginning with '202':

    Harmony.subdwelling(
            { 
                postcode: "2000", 
                locality: "sydney", 
                street: "george st", 
                streetNumber: "220",
                subdwelling: "202" 
            }, 
            Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.suburb(address, sourceOfTruth, callback)

Invokes the suburb service.

The following example performs a search for suburbs beginning with 'wellin':

    Harmony.suburb({ suburb: "wellin" }, Harmony.NZPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.townCity(address, sourceOfTruth, callback)

Invokes the townCity service.

The following example performs a search for towns and cities beginning with 'wellin':

    Harmony.townCity({ townCity: "wellin" }, Harmony.NZPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.transaction()

Invokes the transaction service.

The following example invokes transaction with no callback:

    Harmony.transaction(Harmony.AUPAF);
    

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.Types.floorLevel(sourceOfTruth, callback)

Invokes the floorLevel types service.

The following example retrieves the floor level types:

    Harmony.Types.floorLevel(Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Types.postal(sourceOfTruth, callback)

Invokes the postal types service.

The following example retrieves the postal types:

    Harmony.Types.postal(Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Types.street(sourceOfTruth, callback)

Invokes the street types service.

The following example retrieves the street types:

    Harmony.Types.street(Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Types.streetSuffix(sourceOfTruth, callback)

Invokes the streetSuffix types service.

The following example retrieves the street suffix types:

    Harmony.Types.streetSuffix(Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Types.unitFlat(sourceOfTruth, callback)

Invokes the unitFlat types service.

The following example retrieves the unit/flat types:

    Harmony.Types.unitFlat(Harmony.AUPAF, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.Extensions.identify(address, callback)

Invokes the identify extension service.

The following example identifies the input address with EID 'wAcKtCUXx5glttrgaxxY1l6S5LEZrjIE':

    Harmony.Extensions.identify({ eid: "wAcKtCUXx5glttrgaxxY1l6S5LEZrjIE" }, 
            function(response) {
                
                // Perform any action with the response
                ...

            }
    );
    

Harmony.International.address(address, callback)

Invokes the international address lookup service.

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

    Harmony.International.address({ fullAddress: "1 abc street", country: "CA"}, 
            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.identify(address, callback)

Invokes the international address retrieve service.

The following example identifies the input address with id 'CA|CP|A|494524':

    Harmony.International.identify({ id: "CA|CP|A|494524"}, 
            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]);
                        ...
                    }
                    
                }
            }
    );