EMS : Resource Discovery Services

[ Whereis® API Home ] [ JSON API Home ] [ Services ]

The resource discovery services are a means of browsing the collections of resources, such as suburbs, regions and states.

Each of the resource services have means of accessing lists of location objects, individual location objects or an attribute of an individual location object for: states, regions and suburbs.

General List URL

HTTP GET to <ENDPOINT>/service/resources/<TYPE>/?<PARAMETERS>

General List Response

{
	"results": [<geocode>],
	"pagination": {
		"total": <int>,
		"start": <int>	
	}
}

General Item URL

HTTP GET to <ENDPOINT>/service/resources/<TYPE>/<ID>?<PARAMETERS>

General Item Response

All item responses are a <geocode> object. The <geocode> contains a centrePoint, bounds, ID and street address.

There are three resource discovery services.

Service Name	Description
State resources	Returns details about state resources. This allows access to all states, individual states and attributes: suburbs with a state, regions within a state, metadata about the breakdown of the number of the number of states, suburbs and regions broken down by starting letter and the capital city.
Region resources	Returns details about region resources. This allows access to all regions, individual regions and attributes: suburbs with a region and metadata about the breakdown of the number of the number of suburbs broken down by starting letter.
Postcode resources	Returns details about postcode resources. This allows access to all mappable postcodes, individual postcodes and attributes: suburbs within a postcode, metadata about the breakdown of the number of postcodes broken down by starting number..
Suburb resources	Returns details about suburb resources. This allows access to all suburbs, individual suburbs and attributes: streets within a suburb, metadata about the breakdown of the number of suburbs broken down by starting letter.

NOTES