Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns a list of locations with values for Location Code, Location Name, Description, Device Data indicator, Property Data indicator, and Data Search Link URL, ordered by Location Code

 

[
   {"

   {
      "deployments": 50,
      "locationName": "Axis
(POD 1)
 ",
    "description":"Depth: 985 m Latitude: 48.3167 Longitude: -126.0501 Type: Stationary platform Description: Canyon axis: benthic processes, biodiversity, sediment dynamics.",
    "hasDeviceData":"true",
    "locationCode":"BACAX",
    "hasPropertyData":"true",
    "dataSearchURL":"http://dmas.uvic.

      "depth": 984.3076,
      "bbox": {
         "maxDepth": 987,
         "maxLat": 48.316837,
         "maxLon": -126.050125,
         "minDepth": 981,
         "minLat": 48.316517,
         "minLon": -126.05087
      },
      "description": "Depth: 985 m Latitude: 48.3167 Longitude: -126.0501 Type: Stationary platform Description: Canyon axis: benthic processes, biodiversity, sediment dynamics.",
      "hasDeviceData": "true",
      "lon": -126.05033,
      "locationCode": "BACAX",
      "hasPropertyData": "true",
      "lat": 48.31669,
      "dataSearchURL": "http://data.oceannetworks.ca/DataSearch?location=BACAX"
   }
]
Property
Type
Description
Example
locationNamestringThe name of the location
"locationName":"Axis (POD 1)"
locationCodestringThe locationCode for the location.
"locationCode":"BACAX"
descriptionstringThe description of the location
"description":"Depth: 985 m Latitude: 48.3167 Longitude: -126.0501 Type: Stationary platform Description: Canyon axis: benthic processes, biodiversity, sediment dynamics."

hasDeviceData

stringIndicates that data products can be requested using a device category code for the location
"hasDeviceData":"true
hasPropertyDatastringIndicates that data products can be requested using a property code for the location
"hasPropertyData":"true"
dataSearchURLstringThe location specific Data Search web page URL
"dataSearchURL":"http://dmas.uvic.ca/DataSearch?location=BACAX"

...

deployments
]
"dataSearchURL":"http://dmas.uvic.ca/DataSearch?location=BACAX"
integernumber of deployments"deployments" 10,
depthdoubleaverage depth of deployments"depth" 75,
latdouble

average latitude of deployments

"lat" 48.47672,
londoubleaverage longitude of deployments"lon" : -123.294902,
bboxObjectbounding box of site devices at location for device that pass filters
"bbox" : {
    "maxDepth" 100,
    "maxLat" 48.476740,
    "maxLon" : -123.294904,
    "minDepth" 50,
    "minLat" 48.47670,
    "minLon" : -123.294900
  }
Property
Type
Description
Example
locationNamestringThe name of the location
"locationName":"Axis (POD 1)"
locationCodestringThe locationCode for that location.
"locationCode":"BACAX"
descriptionstringThe description of the location
"description":"Depth: 985 m Latitude: 48.3167 Longitude: -126.0501 Type: Stationary platform Description: Canyon axis: benthic processes, biodiversity, sediment dynamics."

hasDeviceData

stringIndicates that data products can be requested using a device category code for the location
"hasDeviceData":"true
hasPropertyDatastringIndicates that data products can be requested using a property code for the location
"hasPropertyData":"true"
dataSearchURLstringThe location specific Data Search web page URL

Bad Request (HTTP 400)

errorCode
errorMessage
Description
23Invalid Time Range, Start Time is greater that End Time or start time is not provided

Occurs when the deploymentEnd is before the deploymentBegin date/time.

  • The name of both of the datetime filters will be included in the "parameter" property
127Invalid parameter value

Occurs when an invalid code is used in the filter. Most filters require an exact match, otherwise this error will occur.

  • The name of the filter parameter will be included in the "parameter" property
128Missing parameter

Occurs when multiple parameters are needed, but not all are present. Occurs when deploymentBegin is used without deploymentEnd

  • The names of the required filter parameters will be included in the "parameter" property separated by /
129Invalid parameter name

Occurs when a filter parameter is used, but is not supported.

...