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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostCodeAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.Model">
  <CountryID>0</CountryID>
  <Display>false</Display>
  <GoogleMapPlacesId>String</GoogleMapPlacesId>
  <Hide>false</Hide>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <MapzenGID>String</MapzenGID>
  <MapzenLabel>String</MapzenLabel>
  <PostCode>String</PostCode>
  <PostCodeAllID>0</PostCodeAllID>
  <StateID>0</StateID>
  <Suburb>String</Suburb>
</PostCodeAll>