Cleanse methods (AU/NZ)

Cleanse methods validate the single line input address based on the required source of truth (e.g. GNAF, AUPAF, NZPAF).

address Cleanse the supplied single-line address into its component parts based on the supplied SOT.

address

The cleanse method takes a concatenated address String in the fullAddress field of an AddressAu or AddressNz parameter. It then attempts to validate it based on the supplied sourceOfTruth into component parts which are then returned in a populated AddressAu or AddressNz object with additional attributes. We support AUPAF, GNAF and NZPAF in this version, and we are continuing the development to support more validations. And for POST method it can allow to send a list of Addresses (maximum 100 per request) and then return a list of validated addresses.

Details of the processes for each available sourceOfTruth:

  • sourceOfTruth : GNAF (GNAFAddressStandardization + GNAFValidation)
  • sourceOfTruth : AUPAF (AMASAddressStandardization + AMASHAVE)
  • sourceOfTruth : NZPAF (NZAddressStandardiztion + NZPostcodeAllocation + NZHAVEGeoPAF)
  • Resource URL

    	
    	    GET    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/cleanse/address?
    	    	           sourceOfTruth=GNAF&fullAddress=220 GEORGE ST, SYDNEY
    	    
    	
    	
    	    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/cleanse/address
    	    
    	

    Request

    The request body is an AddressRestRequest object:

    	
    	    {
    	        "payload": [ { "fullAddress": "SE 202, 220 George Street, Syndey 2000" }, 
    	        		{"fullAddress":"3 Orara Street, waitara nsw"}, .... ],
    	        "sourceOfTruth": "AUPAF"
    	    }
    	    
    	

    Response

    The response body is an AddressRestResponse object:

    	
            {
                "status": "SUCCESS",
                "messages": [],
                "payload": [	            
                    {	
                        "fullAddress": "220 GEORGE STREET,SYDNEY NSW 2000",
                        "country": "",
                        "postcode": "2000",
                        "street2": "",
                        "street": "George Street",
                        "streetNumber": "220",
                        "postal": "",
                        "postalNumber": "",
                        "postalType": "",
                        "buildingName": "",
                        "subdwelling": "SE 202",
                        "eid": null,
                        "lotNumber": null,
                        "flatUnitNumber": "202",
                        "flatUnitType": "SE",
                        "floorLevelNumber": "",
                        "floorLevelType": "",
                        "streetSuffix": "",
                        "streetType": "Street",
                        "streetName": "George",
                        "careOf": "",
                        "exception": null,
                        "locality": "SYDNEY",
                        "state": "NSW",
                        "attributes": {
                            "GNAFPIDPosition": "ROOFTOP",
                            "GNAFConfidence": "0",
                            "ParcelID": "1//DP75111",	       	                	
                            "MeshblockId": "10743811000",
                            "Latitude": "-33.86307089",	       	                	
                            "Longitude": "151.20781474",
                            "GNAFReliability": "2",
                            "GNAFPID": "GANSW710276621",
                            "GNAFPointPID": "GANSW710276621",
                            "GNAFGroupPID": "NSW2845405",
                            "GNAFLocalityPID": "NSW3749",	       	                	
                            "GeocodeLevel": "7"
                        }
                    },
                    {   
                        "fullAddress": "3-11 ORARA STREET,WAITARA NSW 2077",
                        "country": "",
                        "postcode": "2077",
                        "street2": "",
                        "street": "Orara Street",
                        "streetNumber": "3-11",
                        "postal": "",
                        "postalNumber": "",
                        "postalType": "",					
                        "buildingName": "",
                        "subdwelling": "",
                        "eid": null,
                        "lotNumber": null,
                        "flatUnitNumber": "",
                        "flatUnitType": "",
                        "floorLevelNumber": "",
                        "floorLevelType": "",
                        "streetSuffix": "",
                        "streetType": "Street",
                        "streetName": "Orara",
                        "careOf": "",
                        "exception": null,
                        "locality": "waitara",
                        "state": "nsw",
                        "attributes": {
                            "GNAFPIDPosition": "ROOFTOP",
                            "GNAFConfidence": "1",
                            "ParcelID": "110//SP75046",
                            "GNAFPointPID": "GANSW716818114",
                            "MeshblockId": "11205293800",
                            "Latitude": "-33.70872612",
                            "GNAFPID": "GANSW716818114",
                            "Longitude": "151.10400679",
                            "GNAFReliability": "2",
                            "GNAFLocalityPID": "NSW4122",
                            "GNAFGroupPID": "NSW2895995",
                            "GeocodeLevel": "7"
                        }
                    },
                    .......
                ]
            }