API

Methods

Objects

Address Extension Objects

IdentifiedAddressAu The result of an identified Australian Address.
IdentifiedAddressNz The result of an identified New Zealand Address.

IdentifiedAddressAu <<extends>> AddressAu

A IdentifiedAddressAu object extends a standard AddressAu object and is returned in the identify method response for Australian Sources of Truth.

See AddressAu for inherited attributes.

id

Type: String The Source of Truth ID for this address (i.e. 'DPID' or 'PID').

attributes

Type: Map A map of name/value pairs representing additional information from the Address in the Source of Truth (e.g. '[ "Longitude": "12.34", "Latitude": "12.34" ]).

JSON Representation


    {
        "id": "GANSW717811734",
        "attributes": {
            "GNAFConfidence": "0",
            "GNAFGroupPID": "NSW2845405",
            "GNAFLocalityPID": "NSW3749",
            "GNAFPID": "GANSW718616256",
            "GNAFPointPID": "GANSW718616256",
            "GNAFReliability": "2",
            "GeocodeLevel": "7",
            "Latitude": "-33.86307089",
            "Longitude": "151.20781474",
            "MeshblockId": "10743811000",
            "ParcelID": "1//DP75111"
        },
        "eid": "fGBUVVdCntAu6wgNVcv0ePuSac7kAbUP",
        "fullAddress": "L 2 SE 202 220 GEORGE STREET, SYDNEY NSW 2000",
        "country": null,
        "exception": null,
        "id": "GANSW718616256",
        "state": "NSW",
        "postcode": "2000",
        "locality": "SYDNEY",
        "street2": null,
        "street": "GEORGE STREET",
        "streetName": "GEORGE",
        "streetSuffix": "", 
        "streetType": "STREET",         
        "postal": "",
        "postalNumber": "",
        "postalType": "",        
        "streetNumber": "220",
        "buildingName": "",
        "subdwelling": "L 2 SE 202",
        "flatUnitNumber": "202",
        "flatUnitType": "SE",
        "floorLevelNumber": "2",
        "floorLevelType": "L",
        "lotNumber": ""           
    }

IdentifiedAddressNz <<extends>> AddressNz

A IdentifiedAddressNz object extends a standard AddressNz object and is returned in the identify method response for New Zealand addresses.

See AddressNz for inherited attributes.

id

Type: String The Source of Truth ID for this address (i.e. 'DPID').

attributes

Type: Map A map of name/value pairs representing additional information from the Address in the Source of Truth (e.g. '[ "Longitude": "12.34", "Latitude": "12.34" ]).

JSON Representation


    {
        "attributes": {
            "Latitude": "-41.284123",
            "Longitude": "174.776194",
            "MeshblockId": "2125700",
            "ParcelId": "4032109",
            "XCoordinate": "2658764",
            "XNztm": "1748740.49107",
            "YCoordinate": "5989893",
            "YNztm": "5428180.430423"        	
        },
        "fullAddress": "25 PANAMA STREET, WELLINGTON CENTRAL, WELLINGTON 6011",
        "country": null,
        "exception": null,
        "postcode": "6011",
        "street2": null,
        "street": "PANAMA STREET",
        "streetName": "PANAMA",
        "streetSuffix": "", 
        "streetType": "STREET",          
        "streetNumber": "25",
        "postal": "",
        "postalNumber": "",
        "postalType": "",         
        "buildingName": "",
        "subdwelling": "",
        "flatUnitNumber": "",
        "flatUnitType": "",
        "floorLevelNumber": "",
        "floorLevelType": "",
        "lotNumber": "",
        "rdNumber": null,         
        "eid": "aYn8PTaMevBL7jOBbUJ9KaIu/OHMVJuy",
        "id": "187826",
        "attributes": null,
        "suburb": "WELLINGTON CENTRAL",
        "townCity": "WELLINGTON"
    }