RHP_API

<back to all web services

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:
NameParameterData TypeRequiredDescription
SearchTextquerystringNoSubstring search text.
Latquerydouble?NoLat, Lon used to find location nearest co-ordinates.
Lonquerydouble?NoLat, Lon used to find location nearest co-ordinates.
IsSuburbOnlyqueryboolNo[DEPRECATED - replaced by SearchType] If true, only cities / towns / suburbs will be returned.
SearchTypequeryGetLocationSearchTypeNoIf 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 .csv suffix or ?format=csv

HTTP + CSV

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

{Unable to show example output for type 'IEnumerable`1' using the custom 'csv' filter}Cannot create an instance of an interface.