New Feature

We’ve added a new a new include value to our APIs called all. If you’re usecase requires all the attributes of an address, building or something else, you can use all to easily return all attributes on a single call without the need to specify each individually.

Using Include

The structure of resources in this api is comparatively fine grained. If you need multiple resources this can require multiple “chatty” calls which is sometimes undesirable.

If you would like multiple resources and prefer a less “chatty” workflow multiple resources can be requested in one call by using the include parameter on the:

GET /addresses/{id}/ and GET /buildings/{id}/ resources.

The include parameter takes a comma separated list of “link identifiers”. Valid link identifiers are returned in the links object for all the available child resources. When a link identifier is populated in the include field, the output for those linked child resources is appended to the response.

Examples:

Buildings API

To request the roof materials and the maximum roof height of a building, set the include parameter to roofMaterial,maximumRoofHeight and the values for roofMaterial and maximumRoofHeight will be included in the response.

GET /buildings/BLDSA0001095169/?include=roofMaterial,maximumRoofHeight

{
    "buildingId": "BLDSA0001095169",
    "coverageType": "Urban",
    "links": {
        "area": "/v1/buildings/BLDSA0001095169/area/",
        "averageEaveHeight": "/v1/buildings/BLDSA0001095169/averageEaveHeight/",
        "centroid": "/v1/buildings/BLDSA0001095169/centroid/",
        "elevation": "/v1/buildings/BLDSA0001095169/elevation/",
        "estimatedLevels": "/v1/buildings/BLDSA0001095169/estimatedLevels/",
        "footprint2d": "/v1/buildings/BLDSA0001095169/footprint2d/",
        "footprint3d": "/v1/buildings/BLDSA0001095169/footprint3d/",
        "maximumRoofHeight": "/v1/buildings/BLDSA0001095169/maximumRoofHeight/",
        "overhangingTree": "/v1/buildings/BLDSA0001095169/overhangingTree/",
        "roofComplexity": "/v1/buildings/BLDSA0001095169/roofComplexity/",
        "roofMaterial": "/v1/buildings/BLDSA0001095169/roofMaterial/",
        "solarPanel": "/v1/buildings/BLDSA0001095169/solarPanel/",
        "swimmingPool": "/v1/buildings/BLDSA0001095169/swimmingPool/",
        "zonings": "/v1/buildings/BLDSA0001095169/zonings/"
    },
    "maximumRoofHeight": 5.9,
    "relatedAddressIds": [
        "GASA_425189365"
    ],
    "roofMaterial": "Tile"
}

Addresses API

To request the geospatial and detailed components of an address, set the include parameter to geo,addressDetails and the values for geo and addressDetails will be included in the response.

GET /addresses/GASA_425189365/?include=geo,addressDetails

{
    "addressDetails": {
        "cadastralIdentifier": "F174087/A186",
        "formattedAddress": "32 HANSON ST, FREELING SA 5372",
        "localityName": "FREELING",
        "postcode": "5372",
        "stateTerritory": "SA",
        "streetName": "HANSON",
        "streetNumber1": "32",
        "streetType": "ST"
    },
    "addressId": "GASA_425189365",
    "addressRecordType": "Primary",
    "buildingsRolloutStatus": "RELEASED",
    "geo": {
        "geoDatumCode": "GDA94",
        "geoFeature": "PROPERTY CENTROID",
        "geometry": {
            "coordinates": [
                138.81316313,
                -34.45459275
            ],
            "type": "Point"
        }
    },
    "links": {
        "addressDetails": "/v1/addresses/GASA_425189365/addressDetails/",
        "asgsMain": "/v1/addresses/GASA_425189365/asgsMain/",
        "asgsRemoteness": "/v1/addresses/GASA_425189365/asgsRemoteness/",
        "commonwealthElectorate": "/v1/addresses/GASA_425189365/commonwealthElectorate/",
        "geo": "/v1/addresses/GASA_425189365/geo/",
        "localGovernmentArea": "/v1/addresses/GASA_425189365/localGovernmentArea/",
        "primaryBuildingId": "/v1/addresses/GASA_425189365/primaryBuildingId/",
        "stateElectorate": "/v1/addresses/GASA_425189365/stateElectorate/"
    },
    "relatedBuildingIds": [
        "BLDSA0001095169",
        "BLDSA0000645403"
    ]
}

Addresses API all

To request alll attributes of an address, set the include parameter to all and all will be included in the response.

GET /addresses/GASA_425189365/?include=all

{
    "addressDetails": {
        "cadastralIdentifier": "F174087/A186",
        "formattedAddress": "32 HANSON ST, FREELING SA 5372",
        "localityName": "FREELING",
        "postcode": "5372",
        "stateTerritory": "SA",
        "streetName": "HANSON",
        "streetNumber1": "32",
        "streetType": "ST"
    },
    "addressId": "GASA_425189365",
    "addressRecordType": "Primary",
    "asgsMain": {
        "2011": {
            "mbId": "40065552000",
            "sa1Id": "40501111105",
            "sa2Id": "405011111",
            "sa2Name": "LIGHT",
            "sa3Id": "40501",
            "sa3Name": "BAROSSA",
            "sa4Id": "405",
            "sa4Name": "BAROSSA - YORKE - MID NORTH"
        },
        "2016": {
            "mbId": "40215057500",
            "sa1Id": "40501111105",
            "sa2Id": "405011111",
            "sa2Name": "LIGHT",
            "sa3Id": "40501",
            "sa3Name": "BAROSSA",
            "sa4Id": "405",
            "sa4Name": "BAROSSA - YORKE - MID NORTH"
        }
    },
    "asgsRemoteness": {
        "2011": {
            "categoryCode": "1",
            "categoryName": "Inner Regional Australia",
            "code": "41"
        },
        "2016": {
            "categoryCode": "1",
            "categoryName": "Inner Regional Australia",
            "code": "41"
        }
    },
    "buildingsRolloutStatus": "RELEASED",
    "commonwealthElectorate": {
        "commElectoralName": "BARKER",
        "commElectoralPid": "SA11"
    },
    "geo": {
        "geoDatumCode": "GDA94",
        "geoFeature": "PROPERTY CENTROID",
        "geometry": {
            "coordinates": [
                138.81316313,
                -34.45459275
            ],
            "type": "Point"
        }
    },
    "links": {
        "addressDetails": "/v1/addresses/GASA_425189365/addressDetails/",
        "asgsMain": "/v1/addresses/GASA_425189365/asgsMain/",
        "asgsRemoteness": "/v1/addresses/GASA_425189365/asgsRemoteness/",
        "commonwealthElectorate": "/v1/addresses/GASA_425189365/commonwealthElectorate/",
        "geo": "/v1/addresses/GASA_425189365/geo/",
        "localGovernmentArea": "/v1/addresses/GASA_425189365/localGovernmentArea/",
        "primaryBuildingId": "/v1/addresses/GASA_425189365/primaryBuildingId/",
        "stateElectorate": "/v1/addresses/GASA_425189365/stateElectorate/"
    },
    "localGovernmentArea": {
        "lgaName": "LIGHT REGIONAL COUNCIL",
        "lgaPid": "SA120"
    },
    "relatedBuildingIds": [
        "BLDSA0001095169",
        "BLDSA0000645403"
    ],
    "stateElectorate": [
        {
            "stateElectoralName": "SCHUBERT",
            "stateElectoralType": "LEGISLATIVE ASSEMBLY"
        }
    ]
}