| GET | /Location/Suburb/{SuburbID} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuburbID | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"PostCodeAllID":0,"Suburb":"String","PostCode":"String","StateID":0,"StateName":"String","StateNameAbbr":"String","CountryID":0,"CountryName":"String","CountryCode":"String","GoogleMapPlacesId":"String","Type":"String"}