RHP_API

GetSuburbItem

The following routes are available for this service:
GET	/Location/Suburb/{SuburbID}

**GetSuburbItem** Parameters:
Name	Parameter	Data Type	Required	Description
SuburbID	path	int	No

**SuburbItem** Parameters:
Name	Parameter	Data Type	Required
PostCodeAllID	form	int	No
Suburb	form	string	No
PostCode	form	string	No
StateID	form	int	No
StateName	form	string	No
StateNameAbbr	form	string	No
CountryID	form	int	No
CountryName	form	string	No
CountryCode	form	string	No
GoogleMapPlacesId	form	string	No
Type	form	string	No

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/{SuburbID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SuburbItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <CountryCode>String</CountryCode>
  <CountryID>0</CountryID>
  <CountryName>String</CountryName>
  <GoogleMapPlacesId>String</GoogleMapPlacesId>
  <PostCode>String</PostCode>
  <PostCodeAllID>0</PostCodeAllID>
  <StateID>0</StateID>
  <StateName>String</StateName>
  <StateNameAbbr>String</StateNameAbbr>
  <Suburb>String</Suburb>
  <Type>String</Type>
</SuburbItem>