RHP_API

GetLocationSearch

Returns a list of location suggestions base on the supplied criteria. To authenticate user the user token or the anonymous access token.

The following routes are available for this service:
GET	/Location/Search

**GetLocationSearch** Parameters:
Name	Parameter	Data Type	Required	Description
SearchText	query	string	No	Substring search text.
Lat	query	double?	No	Lat, Lon used to find location nearest co-ordinates.
Lon	query	double?	No	Lat, Lon used to find location nearest co-ordinates.
IsSuburbOnly	query	bool	No	[DEPRECATED - replaced by SearchType] If true, only cities / towns / suburbs will be returned.
SearchType	query	GetLocationSearchType	No	If search type is specified (any other value than NotApplicable) it will override IsSuburbOnly.

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

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

<ArrayOfLocationSearchItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.Model">
  <LocationSearchItem>
    <Distance>0</Distance>
    <Lat>0</Lat>
    <LocationID>String</LocationID>
    <Lon>0</Lon>
    <Text>String</Text>
    <Type>Country</Type>
  </LocationSearchItem>
</ArrayOfLocationSearchItem>