Coastal Features

Information:

The CoastalFeatures Data format contains details of the coastal areas around Western Australia, beaches, their names which local government they belong to, and where the data was sourced from.

 

API

http://api.fish.wa.gov.au/webapi/v1/CoastalFeatures

 

Data Dictionary

Download Here

List All Coastal Features

Returns a list of Coastal Features objects sorted by DisplayName in Descending Order by default.



 

GET /webapi/v1/CoastalFeatures

Request Example using cURL:
$ curl http://api.fish.wa.gov.au/webapi/v1/CoastalFeatures

Response Example:
HTTP/1.1 200 OK
Content Type: application/json;charset=UTF 8
[
  {
    "CoastalFeatureID": 5234,
    "CoastalFeatureDOFID": "wa1169",
    "CoastalFeatureFullName": "Zuytdorp Wreck (S 1)",
    "CoastalFeatureDisplayName": "Zuytdorp Wreck Beach",
    "CoastalFeatureFeatureType": "Beach",
    "CoastalFeatureInshoreLatitude": -27.1702,
    "CoastalFeatureInshoreLongitude": 113.9278,
    "CoastalFeatureOffshoreLatitude": -27.174,
    "CoastalFeatureOffshoreLongitude": 113.9181,
    "CoastalFeatureLGAName": "SHARK BAY, SHIRE OF",
    "CoastalFeatureSource": "SLSWA",
    "CoastalFeatureTownProximityOLD": "north of Kalbarri",
    "CoastalFeatureTownProximityNEW": "Kalbarri",
    "CoastalFeatureInshore_Offshore": "Separate inshore and offshore locations",
    "CoastalFeatureLookup_Table": "Zuytdorp Wreck Beach [Beach], north of Kalbarri",
    "CoastalFeatureTweet_Text": "Zuytdorp Wreck Beach, north of Kalbarri",
    "CoastalFeatureResponse_Region": "WEST, STATE",
    "CoastalFeatureSource1": null,
    "CoastalFeatureTweet_Text_Len": 39
  },
  {
    "CoastalFeatureID": 3130,
    "CoastalFeatureDOFID": "100136369",
    "CoastalFeatureFullName": "Zuytdorp Cliffs",
    "CoastalFeatureDisplayName": "Zuytdorp Cliffs",
    "CoastalFeatureFeatureType": "Cliff",
    "CoastalFeatureInshoreLatitude": -26.6465,
    "CoastalFeatureInshoreLongitude": 113.5609,
    "CoastalFeatureOffshoreLatitude": -26.6523,
    "CoastalFeatureOffshoreLongitude": 113.5517,
    "CoastalFeatureLGAName": "SHARK BAY, SHIRE OF",
    "CoastalFeatureSource": "Landgate",
    "CoastalFeatureTownProximityOLD": "near Denham",
    "CoastalFeatureTownProximityNEW": "Denham",
    "CoastalFeatureInshore_Offshore": "Separate inshore and offshore locations",
    "CoastalFeatureLookup_Table": "Zuytdorp Cliffs [Cliff], near Denham",
    "CoastalFeatureTweet_Text": "Zuytdorp Cliffs, near Denham",
    "CoastalFeatureResponse_Region": "WEST, STATE",
    "CoastalFeatureSource1": null,
    "CoastalFeatureTweet_Text_Len": 28
  },
  ....
  ,,,,
]

 


optional parameters

pageNumber (default null) a value which determins which page to retrieve.
pageSize (default 10) when a page number is set is used to determine the number of records to return each page.
sortOrder (default desc) a string which will order the results based on DisplayName in either ascending (asc) or descending (desc).

When paging, the results return a page object which contains metadata with details of the result set and links to the next and previous page if available.



 

GET /webapi/v1/CoastalFeatures?pageNumber={pageNumber}&pageSize=10&sortOrder=desc

Example Request
$cURL http://api.fish.gov.au/webapi/v1/CoastalFeatures?pageNumber=2&pageSize=2

Example Response
HTTP/1.1 200 OK
Content Type: application/json;charset=UTF 8
{
  "MetaData": {
    "TotalItems": 5828,
    "CurrentPage": 2,
    "TotalPages": 2914,
    "NextPageLink": "http://api.fish.gov.au/webapi/v1/CoastalFeatures?pageNumber=3&pageSize=2&sortOrder=desc",
    "PrevPageLink": "http://api.fish.gov.au/webapi/v1/CoastalFeatures?pageNumber=1&pageSize=2&sortOrder=desc"
  },
  "PagedItems": [
    {
      "CoastalFeatureID": 2670,
      "CoastalFeatureDOFID": "100130248",
      "CoastalFeatureFullName": "Zeewijk Wreck",
      "CoastalFeatureDisplayName": "Zeewijk Wreck",
      "CoastalFeatureFeatureType": "Wreck",
      "CoastalFeatureInshoreLatitude": -28.8913,
      "CoastalFeatureInshoreLongitude": 113.8273,
      "CoastalFeatureOffshoreLatitude": -28.8908,
      "CoastalFeatureOffshoreLongitude": 113.8171,
      "CoastalFeatureLGAName": "NORTHAMPTON, SHIRE OF",
      "CoastalFeatureSource": "Landgate",
      "CoastalFeatureTownProximityOLD": "Abrolhos Islands",
      "CoastalFeatureTownProximityNEW": "Abrolhos Islands",
      "CoastalFeatureInshore_Offshore": "Separate inshore and offshore locations",
      "CoastalFeatureLookup_Table": "Zeewijk Wreck [Wreck], Abrolhos Islands",
      "CoastalFeatureTweet_Text": "Zeewijk Wreck, Abrolhos Islands",
      "CoastalFeatureResponse_Region": "WEST, STATE",
      "CoastalFeatureSource1": null,
      "CoastalFeatureTweet_Text_Len": 31
    },
    {
      "CoastalFeatureID": 2669,
      "CoastalFeatureDOFID": "100130228",
      "CoastalFeatureFullName": "Zeewijk Channel",
      "CoastalFeatureDisplayName": "Zeewijk Channel",
      "CoastalFeatureFeatureType": "Channel",
      "CoastalFeatureInshoreLatitude": -28.8252,
      "CoastalFeatureInshoreLongitude": 113.7989,
      "CoastalFeatureOffshoreLatitude": -28.8252,
      "CoastalFeatureOffshoreLongitude": 113.7989,
      "CoastalFeatureLGAName": "NORTHAMPTON, SHIRE OF",
      "CoastalFeatureSource": "Landgate",
      "CoastalFeatureTownProximityOLD": "Abrolhos Islands",
      "CoastalFeatureTownProximityNEW": "Abrolhos Islands",
      "CoastalFeatureInshore_Offshore": "Inshore and offshore locations same",
      "CoastalFeatureLookup_Table": "Zeewijk Channel [Channel], Abrolhos Islands",
      "CoastalFeatureTweet_Text": "Zeewijk Channel, Abrolhos Islands",
      "CoastalFeatureResponse_Region": "WEST, STATE",
      "CoastalFeatureSource1": null,
      "CoastalFeatureTweet_Text_Len": 33
    }
  ]
}



 

ERRORS

Attempting to access a page outside of the range based on page size will return an Error.  Currently the error number, link will remain empty.

Example Error Response
HTTP/1.1 400 Bad Request
{
  "DeveloperMessage": "The maximum page number that can be provided is 2914 you have provided 3500 this will be treated as an error",
  "ClientMessage": "Unfortunately something went wrong with the paging of the request please contact your application support team.",
  "StackTrace": null,
  "ErrorNumber": "0",
  "ErrorLink": null
}
 

Get a Single Item of CoastalFeature

Retreives a single Item from the CoastalFeatures based on the featureID
 

GET /webapi/v1/CoastalFeatures/{featureID}

Example Request
$cURL http://api.fish.wa.gov.au/webapi/v1/CoastalFeatures/2669

Example Response
HTTP/1.1 200 OK
Content Type: application/json;charset=UTF 8
{
  "CoastalFeatureID": 2669,
  "CoastalFeatureDOFID": "100130228",
  "CoastalFeatureFullName": "Zeewijk Channel",
  "CoastalFeatureDisplayName": "Zeewijk Channel",
  "CoastalFeatureFeatureType": "Channel",
  "CoastalFeatureInshoreLatitude": -28.8252,
  "CoastalFeatureInshoreLongitude": 113.7989,
  "CoastalFeatureOffshoreLatitude": -28.8252,
  "CoastalFeatureOffshoreLongitude": 113.7989,
  "CoastalFeatureLGAName": "NORTHAMPTON, SHIRE OF",
  "CoastalFeatureSource": "Landgate",
  "CoastalFeatureTownProximityOLD": "Abrolhos Islands",
  "CoastalFeatureTownProximityNEW": "Abrolhos Islands",
  "CoastalFeatureInshore_Offshore": "Inshore and offshore locations same",
  "CoastalFeatureLookup_Table": "Zeewijk Channel [Channel], Abrolhos Islands",
  "CoastalFeatureTweet_Text": "Zeewijk Channel, Abrolhos Islands",
  "CoastalFeatureResponse_Region": "WEST, STATE",
  "CoastalFeatureSource1": null,
  "CoastalFeatureTweet_Text_Len": 33
}



 
 

ERRORS

Attempting to access an item outside of the available featureIds will result in an error message.


Example Error Response
HTTP/1.1 404 Bad Request
{
  "DeveloperMessage": "No such ID found in CoastalFeatures Table",
  "ClientMessage": "Unfortunately the item you are looking for is no longer available.",
  "StackTrace": null,
  "ErrorNumber": "0",
  "ErrorLink": null
}

List Coastal Features based on Lat/Long

This searches Coastal Features based on a latitude and longitude with a default range of 10000m, this is the radius.
The Fields
Latitude & Longitude 
These fields provide the centre point for searching from.
SearchStyle This field defaults to InRadius, however can be changed to Nearest, InRadius will return a list of objects while Nearest will return the first item that is nearest as the crow flies.
PageNumber this is by default null to return the complete dataset.


Part of the terms of use for any of the shark data provided is that the Coastal Features dataset data dictionary must be read in full prior to any use of the geographical information. In addition, any use of the latitude and longitude search, and nearest function should consider the coastal features data set document, and specifically the way the location X and Y have been developed to ensure relevant information is captured.

GET /webapi/v1/CoastalFeatures?latitude={latitude}&longitude={longitude}&rangeInM=10000&searchStyle=InRadius&pageNumber={pageNumber}&pageSize=10&sortOrder=desc

 

Example Request
$cURL http://api.fish.wa.gov.au/webapi/v1/CoastalFeatures/?latitude=-31.646&longitude=115.7444&searchStyle=InRadius

 

Example Response

HTTP/1.1 200 OK
Content Type: application/json;charset=UTF 8
[
  {
    "CoastalFeatureID": 2330,
    "CoastalFeatureDOFID": "100045091",
    "CoastalFeatureFullName": "Jindalee",
    "CoastalFeatureDisplayName": "Jindalee",
    "CoastalFeatureFeatureType": "Suburb",
    "CoastalFeatureInshoreLatitude": -31.6418,
    "CoastalFeatureInshoreLongitude": 115.6881,
    "CoastalFeatureOffshoreLatitude": -31.6485,
    "CoastalFeatureOffshoreLongitude": 115.6881,
    "CoastalFeatureLGAName": "WANNEROO, CITY OF",
    "CoastalFeatureSource": "Landgate",
    "CoastalFeatureTownProximityOLD": "Perth Metro",
    "CoastalFeatureTownProximityNEW": "Perth Metro",
    "CoastalFeatureInshore_Offshore": "Separate inshore and offshore locations",
    "CoastalFeatureLookup_Table": "Jindalee [Suburb], Perth Metro",
    "CoastalFeatureTweet_Text": "Jindalee, Perth Metro",
    "CoastalFeatureResponse_Region": "METRO, STATE",
    "CoastalFeatureSource1": "Additional Point 20150115",
    "CoastalFeatureTweet_Text_Len": 21
  },
  {
    "CoastalFeatureID": 4498,
    "CoastalFeatureDOFID": "SLSC18",
    "CoastalFeatureFullName": "Quinns Mindarie SLSC",
    "CoastalFeatureDisplayName": "Quinns Mindarie SLSC",
    "CoastalFeatureFeatureType": "Surf Life Saving Club",
    "CoastalFeatureInshoreLatitude": -31.6783,
    "CoastalFeatureInshoreLongitude": 115.6958,
    "CoastalFeatureOffshoreLatitude": -31.685,
    "CoastalFeatureOffshoreLongitude": 115.6873,
    "CoastalFeatureLGAName": "WANNEROO, CITY OF",
    "CoastalFeatureSource": "SLSWA",
    "CoastalFeatureTownProximityOLD": "Perth Metro",
    "CoastalFeatureTownProximityNEW": "Perth Metro",
    "CoastalFeatureInshore_Offshore": "Separate inshore and offshore locations",
    "CoastalFeatureLookup_Table": "Quinns Mindarie SLSC [Surf Life Saving Club], Perth Metro",
    "CoastalFeatureTweet_Text": "Quinns Mindarie SLSC, Perth Metro",
    "CoastalFeatureResponse_Region": "METRO, STATE",
    "CoastalFeatureSource1": "Additional Points 20141022",
    "CoastalFeatureTweet_Text_Len": 33
  },
  ....
  ....
]