Versions Compared

Old Version 18

changes.mady.by.user Ryan Ross

Saved on

compared with

New Version 19

changes.mady.by.user Allan Rempel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: remove link to "External Web Services", scrub token, add hasDeviceData, hasPropertyData

...

The primary purpose of this service, is to find the available properties of the data you want to access; the service provides the propertyCode that you can use to request a data product via the dataProductDelivery web service.

For a list of available property codes, along with names, descriptions and units of measure, see the Available Properties page.

See External Web Services for method and token usage and error messages.


URL

No Format
https://data.oceannetworks.ca/api/properties

...

Parameter
Type
Description
Example
Required   
tokenstringAll Web Services require a token. Once logged in at https://data.oceannetworks.ca/login, your token can be retrieved or generated at https://data.oceannetworks.ca/Profile . Click on the "Web Services" tab, then click "Generate Token".token=5ba514e8-1203-428c-8835-879c8173e387YOUR_TOKEN_HERE
Optional   
propertyCodestring

Return a single Property matching a specific Property Code

  • Property Code must be valid and match exactly, including case.
  • Run the service without this parameter to get a list of all devices.
propertyCode=beamposition
propertyNamestring

Return all Properties where the Property Name contains a keyword

  • Filter is not case sensitive, treating temp, Temp and TEMP as the same word.
  • Filter will find partial words. The filter propertyName=temp returns "Air Temperature", "Differential Temperature", "Internal Temperature", "Sea Ice Temperature", "Sea Water Temperature" and more.
propertyName=Temp
descriptionstring

Return all Properties where Description contains a keyword

  • Filter is not case sensitive and will find partial words. (See above)
description=water
locationCodestring

Return all Properties available at a specific Location

  • Location Code must be valid and match exactly, including case.
  • Specific Location Codes can be obtained using the locations service.
locationCode=BACAX
deviceCategoryCodestring

Return all Properties that have devices belonging to a specific Device Category

  • Device Category Code must be valid and match exactly, including case
  • Specific Device Category Codes can be obtained using the deviceCateogries service
deviceCategoryCode=CTD
deviceCode string

Return all Properties associated with or measured by a specific Device.

  • Device Code must be valid and match exactly, including case
  • Specific Device Codes can be obtained from the devices service
 deviceCode=AandOpt0581

...

Property
Type
Description
Example
descriptionstringReturns a description of the property.
"description":"Pressure"
hasDeviceDatastringReturns whether, among all properties that fit the query, any of them have a NEPTUNE-searchable sensor, device, and site"hasDeviceData":"true"
hasPropertyDatastringReturns whether, among all properties that fit the query, any of them have a NEPTUNE-searchable primary sensor and device"hasPropertyData":"false"
propertyCodestringReturns the property code.
"propertyCode":"pressure"
propertyNamestringReturns the property name.
"propertyName":"Pressure"
uomstringReturns the Unit Of Measure that the property measurements are in.
"uom":"decibar"
cvTermList

Returns a list of controlled vocabulary terms associated with the Property and the Unit of Measure associated with the Property if one exists. The controlled vocabulary terms associated with the Property are included in the "property" list and the terms associated with the Unit of Measure are included in the "uom" list.

Each vocabulary term is composed of:

  1. Key : "vocabulary" Value : "title of the vocabulary term belongs to".
  2. Key : "uri" Value : "URL of the vocabulary term".

 

"cvTerm": [{"property" : [{ "vocabulary": "NERC-??","uri": "http://vocab/..." }],

"uom": [{ "vocabulary" : "BODC data storage units", "uri" : "http://vocab.nerc.ac.uk/collection/P06/current/UVLT/
" }] }]

...

errorCode
errorMessage
Description
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 is included in the "parameter" property
129Invalid parameter name

Occurs when an unsupported a filter parameter is in the query but is not supported.

  • The name of the filter parameter is included in the "parameter" property

 

 URL Examples

  • Return a list of All Properties (no filters)

...