GET | /Location/Search |
---|
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length [{"Text":"String","Type":"Country","LocationID":"String","Lat":0,"Lon":0,"Distance":0}]