Page History

Table of Contents

Description

The API properties service returns all the properties defined in DMAS Oceans 3.0 that meet a filter criteria.

Properties are observable phenomenon phenomena (aka, variables) and are the common names given to sensor types (iei.e., oxygen, pressure, temperature, etc)

The primary purpose of the properties this service, is to find the available properties of the data you are interested in and use the propertyCode when requesting want to access; the service provides the propertyCode that you can use to request a data product using 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 the External Web Services for method and token usage and error messages.

URL

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

Method	Description	Example
get	Retrieve a list Property codes and descriptions	`method=get`

get

The get method retrieves a list of property codes and descriptions

Parameters

Parameter	Type	Description	Example
Required


token	string	All Web Services require a token

. This can be generated at http

. Once logged in at https://data.oceannetworks.ca/login, your token can be retrieved or generated at https://

dmas

data.

uvic

oceannetworks.ca/Profile . Click on the "Web Services" tab

and

, then click "Generate Token".

token=

5ba514e8-1203-428c-8835-879c8173e387

Optional
YOUR_TOKEN_HERE


propertyCode	string	Return a single Property matching a specific Property Code

Device Category

Property Code must be valid

and match exactly, including caseSpecific Device Catgory Codes can be found by simply running

. Run the service without this parameter to get a list of all devices.	propertyCode=beamposition
propertyName	string	Return all

of the

Properties where the Property Name contains a keyword

Not

Filter is not case sensitive

Contains

, 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
description	string	Return all

of the

Properties where

the

Description contains a keyword

Not case sensitive

Contains

Filter is not case sensitive and will find partial words. (See above)	description=water
locationCode	string	Return all

of the

Properties

that are

available at a specific Location

Property

Location Code must be valid

and match exactly, including case

. Specific Location Codes can be obtained using the locations service.	locationCode=BACAX
deviceCategoryCode	string	Return all

of the

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

of the Properties available on

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

Response

Example for request: httphttps://data.oceannetworks.ca/api/devicesproperties?method=get&token=[YOUR_TOKEN_HERE]&propertyCode=seawatertemperature

Success (HTTP 200)

Returns a list of properties with values for Description, Property Code, Property Name, Description and Units of Measure (UOM) and controlled vocabulary terms, ordered alphabetically by Property Code

[

 {
    "description":"Time: Gregorian days since 19700101T000000Z",
    "propertyCode":"gregoriantime",
    "propertyName":"Gregorian Time",
    "uom":"Gregorian days since 19700101T000000Z"
 },
 {
    "description":"Magnetic Heading",
    "propertyCode":"magneticheading",
    "propertyName":"Magnetic Heading",
    "uom":"deg",
    "cvTerm": [{  "uom": [{ "vocabulary": "BODC data storage units",    "uri": "http://vocab.nerc.ac.uk/collection/P06/current/UAAA/"   }]  }]
 },
 {
    "description":"Pitch",
    "propertyCode":"pitch",
    "propertyName":"Pitch",
    "uom":"deg",
    "cvTerm": [{  "uom": [{ "vocabulary": "BODC data storage units",    "uri": "http://vocab.nerc.ac.uk/collection/P06/current/UAAA/"   }]  }]
 },
 {
    "description":"Pressure",
    "propertyCode":"pressure",
    "propertyName":"Pressure",
    "uom":"decibar",
    "cvTerm": [{  "uom": [{ "vocabulary": "BODC data storage units",    "uri": "http://vocab.nerc.ac.uk/collection/P06/current/UPDB/"   }]  }]
 },
 {
    "description":"Roll",
    "propertyCode":"roll",
 "propertyName":"Roll",
 "uom":"deg"},
 {
 "description":"Temperature: sea water",
 "propertyCode":"seawatertemperature",
 "propertyName":"Sea Water Temperature",
 "uom":"C"
 },
 {
 "description":"Sound Speed: sound velocity sensor",
 "propertyCode":"soundspeed",
 "propertyName":"Sound Speed",
 "uom":"m/s"
 },
 {
 "description":"Voltage: voltage sensor",
 "propertyCode":"voltage",
 "propertyName":"Voltage",
 "uom":"V", 
 "cvTerm": [{  "uom": [{ "vocabulary": "BODC data storage units",    "uri": "http://vocab.nerc.ac.uk/collection/P06/current/UVLT/"   }]  }] 
 }
]

Property	Type	Description	Example
description	string	Returns a description of the property.	"description":"Pressure"
hasDeviceData	string	Returns whether, among all properties that fit the query, any of them have a NEPTUNE-searchable sensor, device, and site	"hasDeviceData":"true"
hasPropertyData	string	Returns whether, among all properties that fit the query, any of them have a NEPTUNE-searchable primary sensor and device	"hasPropertyData":"false"
propertyCode	string	Returns the property code.	"propertyCode":"pressure"
propertyName	string	Returns the property name.	"propertyName":"Pressure"
uom	string	Returns the Unit Of Measure that the property measurements are in.	"uom":"decibar"
cvTerm	List	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: Key : "vocabulary" Value : "title of the vocabulary term belongs to". 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/ " }] }]

Bad Request (HTTP 400)

errorCode

errorMessage

Description

127

Invalid 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

is included in the "parameter" property
129	Invalid parameter name	Occurs when a filter parameter is

used,

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 of the Properties Properties (no filters)

httphttps://data.oceannetworks.ca/api/properties?method=get&token=[YOUR_TOKEN_HERE]

Return the Property with a the Property Code of 'seawatertemperature'

httphttps://data.oceannetworks.ca/api/properties?method=get&token=[YOUR_TOKEN_HERE]&propertyCode=seawatertemperature

Return a list of all of the Properties that have with a Name which contains containing 'pressure'

httphttps://data.oceannetworks.ca/api/properties?method=get&token=[YOUR_TOKEN_HERE]&propertyName=pressure

Return a list of all of the Properties that are Properties available at a location with a the Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')

httphttps://data.oceannetworks.ca/api/properties?method=get&token=[YOUR_TOKEN_HERE]&locationCode=BACAX

Return a list of all of the Properties that are available for a device with a the Device Code of 'NORTEKAQDPRO8398'

httphttps://data.oceannetworks.ca/api/properties?method=get&token=[YOUR_TOKEN_HERE]&deviceCode=NORTEKAQDPRO8398

Return a list of all of the Properties that are available for instruments with a the Device Category of 'ADCP2MHZ'

httphttps://data.oceannetworks.ca/api/properties?method=get&token=[YOUR_TOKEN_HERE]&deviceCategoryCode=ADCP2MHZ

API Proxy

*NOTE: The httphttps://dmasdata.uvicoceannetworks.ca/apiproxy/properties url used URL link in the above examples can be used in a browser for sharing or testing purposes; however, it can not be used accessed from code, as it redirects . Calls to the apiproxy server are redirected to a login screen to capture your user id. In . Accessing the apiproxy URL from code will return html in the payload, which may cause errors or unexpected behaviour. In order to use the properties endpoint from code, you must use the httphttps://data.oceannetworks.ca/api/properties url properties url along with a valid token. Attempting to use the apiproxy url from code will result html returned in the payload which may cause errors or unexpected behavior.

Code Examples

Content Report Table

blueprintModuleCompleteKey	com.atlassian.confluence.plugins.confluence-knowledge-base:kb-how-to-article-blueprint
contentBlueprintId	5fdbc098-f47d-4b1d-bd32-eb876051b73b
analyticsKey	kb-how-to-article
blankDescription	Provide step-by-step guidance for completing a task.
blankTitle	How-to article
spaces	O2A
createButtonLabel	Add how-to article
labels	sample-code-properties

Warning
Please report all issues with the web services, documentation, samples and client libraries to the Oceans 3.0 Help Centre

Page tree

Versions Compared

Old Version 10

New Version Current

Key

Description

URL

get

Parameters

Response

Success (HTTP 200)

Bad Request (HTTP 400)

URL Examples

API Proxy

Code Examples