This reference documents version 1.0 (a retired version) of the MapData Services Context API. This version of the API is now retired and is no longer available for use.
What is Context?
This service provides relevant contextual information for a specific location. The context API can take either a coordinate, an address or a property ID and returns meaningful data about that location.
This service supports Basic Authentication.
Requests to the Context service can by made either by Address components, Coordinate or property ID.
By Address Parts
An Address Context request supports the following parameters:
street- The street portion of the address, e.g. 110 Pacific Highway.
locality- The locality portion of the address, e.g. Greenwich.
postcode- The postcode portion of the address, e.g. 2065.
region- The region portion of the address, e.g. NSW.
country- The country portion of the address, e.g. Australia.
A Coordinate Context request supports the following parameters (in decimal degrees):
latitude- The latitude portion of the coordinate, e.g. -33.825071.
longitude- The longitude portion of the coordinate, e.g. 151.1904.
By Property Id
A Property Id Geocode request supports the following parameters:
Property Id- The property id of the property parcel e.g. GANSU705290690
The format of a Context response can be controlled by setting the accepts header. Currently the only supported type is XML.
In this example a request is made for contextual information about 110 Pacific Highway, Greenwich 2065 NSW, Australia.
The returned XML is shown below.
<context> <copyright>Copyright © 2019 MapData Services and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from MapData Services.</copyright> <status>OK</status> <results> <result> <address> <formattedaddress>110 Pacific Highway, Greenwich 2065 NSW, Australia</formattedaddress> <streetnumber>110</streetnumber> <route>Pacific Highway</route> <locality>Greenwich</locality> <postcode>2065</postcode> <region>NSW</region> <country>Australia</country> </address> <geometry> <location> <lat>-33.825071</lat> <lng>151.1904</lng> </location> <location_type>ROOFTOP</location_type> </geometry> ..contexts... </result> </results> </context>
status field within the response describes the type of response.
status field will contain one of the following values:
OKindicates that no errors occured. The address or coordinate was successfully parsed and at least one geocode was returned.
The service response contains an array of
A typical result is made up of the following:
formattedaddress- The formatted address
streetnumber- The building number.
route- The name of the street.
locality- The locality.
postcode- The postcode.
region- The region.
country- The country.
contexts- This is where contextual information will appear.
Risk Frontiers - Address Risk Ratings
A national address database with natural peril risk rating information for flood, hailstorm, earthquake and cyclone; plus other relevant characteristics such as aspect, elevation above sea level and distance to shoreline. For more information on the risk rating values see Address Risk Ratings
risktype - Describes the risk data, this can be Building match, Street
or Locality aggregration. The Street/Locality aggregation responses provide the
minium, maximum and average value for each risk rating for that level.
<riskfrontiers> <risktype>BUILDING</risktype> <elevation>102</elevation> <aspect>171</aspect> <bushfire>1</bushfire> <flood waterDepth="-9.9">0</flood> <earthquake peakGroundAcceleration="0.05" soilZone="2">1</earthquake> <hailstorm>4</hailstorm> <cyclone distanceToCoast="1">1</cyclone> </riskfrontiers>
<riskfrontiers> <risktype>STREET or LOCALITY</risktype> <elevation elevationMin="0" elevationMax="105">67</elevation> <aspect aspectMin="0" aspectMax="99">211</aspect> <bushfire bushfireMin="1" bushfireMax="1">1</bushfire> <flood floodMin="0" floodMax="0">0</flood> <earthquake earthquakeMin="1" earthquakeMax="1">1</earthquake> <hailstorm hailstormMin="4" hailstormMax="4">4</hailstorm> <cyclone cycloneMin="1" cycloneMax="1">1</cyclone> </riskfrontiers>
NFID - National Flood Information Database
A national address database with flood risk rating information for flood; plus other relevant characteristics such as elevation above sea level, flood depth and confidence.
Describes the risk data, this can be Building match.
<nationalfloodindex> <risktype>BUILDING</risktype> <elevation>433</elevation> <flooddepth20>0</flooddepth20> <flooddepth50>0.3</flooddepth50> <flooddepth100>0.4</flooddepth100> <flooddepthextreme>1</flooddepthextreme> <floodarigl>26</floodarigl> <floodarigl1m>1952</floodarigl1m> <floodarigl2m>10001</floodarigl2m> <confidencelevel>1</confidencelevel> </nationalfloodindex>