RHP_API

<back to all web services

GetGeoCodeTest

The following routes are available for this service:
GET/Location/Suburb/Lookup
GetGeoCodeTest Parameters:
NameParameterData TypeRequiredDescription
SuburbquerystringNo
StatequerystringNo
CountryquerystringNo
PostCodeAll Parameters:
NameParameterData TypeRequiredDescription
PostCodeAllIDformintNo
StateIDformintNo
CountryIDformintNo
SuburbformstringNo
PostCodeformstringNo
DisplayformboolNo
MapzenGIDformstringNo
MapzenLabelformstringNo
GoogleMapPlacesIdformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
HideformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Location/Suburb/Lookup HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PostCodeAllID: 0,
	StateID: 0,
	CountryID: 0,
	Suburb: String,
	PostCode: String,
	Display: False,
	MapzenGID: String,
	MapzenLabel: String,
	GoogleMapPlacesId: String,
	Latitude: 0,
	Longitude: 0,
	Hide: False
}