...
The API devices returns all the devices defined in Oceans 2.0 which DMAS that meet a set of filter criteria.
Devices are instruments with that have one or more sensors that observe a property or phenomenon with a goal of producing an estimate of the value of a property. Devices are uniquely identified by a device code and can be deployed at multiple locations during their lifespan.
The primary purpose of this the devices service is to find devices that have the data you want to access; the service provides the deviceCode that can be used to request are interested in and use the deviceCode when requesting a data product via using the dataProductDelivery web service.
For a list of available device codes, along with names, ids and device links, see the Available Devices page.
See External Web See the External Web Services for method, token, and token responseType usage and error messages.
URL
...
https://data.oceannetworks.ca/api/devices
Method | Description | Example |
---|---|---|
get | Retrieve a list of all devices |
|
get
The get method retrieves a list of devices with deviceId, deviceCode, and deviceName
Parameters
Parameter | Type | Description | Example | ||
---|---|---|---|---|---|
Required | |||||
token | string | All Web Services require a token. Once logged in at https://data.oceannetworks.ca/login, your tokenThis can be retrieved or generated at https://data.oceannetworks.ca/Profile . Click Click on the "Web Services" tab , then and click "Generate Token". | token=5ba514e8-1203-428c-8835-879c8173e387 | ||
Optional | |||||
deviceCode | string | Return a single Device matching a specific Device Code
| deviceCode=FSINXIC1622 | ||
deviceNamedeviceId | stringinteger | Return all of the Devices where the Device Name contains a keyword
| deviceName=meter | a single Device matching a specific Device ID
| deviceId= 10301 |
deviceCategoryCode | string | Return all Devices belonging to a specific Device Category Code
| deviceCategoryCode=CTD | ||
propertyCodelocationCode | string | Return all Devices that are deployed at have a sensor for a specific LocationProperty Code
| propertyCode=pressure | ||
deviceName | string | Return all of the Devices where the Device Name contains a keyword
| deviceName=meter | ||
locationCode | locationCode=BACAX | deviceCategoryCode | string | Return all Devices belonging to that are deployed at a specific Device CategoryLocation
| deviceCategoryCodelocationCode=CTD |
propertyCode | string | Return all Devices that have a sensor for a specific Property
| propertyCode=pressure | ||
BACAX | |||||
dataProductCode | string | Return all Devices that have the ability to return a specific Data Product Code
| dataProductCode=jpgfile | ||
deploymentBegindateFrom | datetime | Return all of the Devices that have a Deployment Beginning on or after a specific date/time
Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
| deploymentBegindateFrom=2010-07-27T00:00:00.000Z | ||
deploymentEnddateTo | datetime | Return all of the Devices that have a Deployment Ending on or before a specific date/time
Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
| deploymentEnddateTo=2016-08-01T00:00:00.000Z |
...
Response
Example for request: https://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]&deviceCategoryCode=ADCP2MHZ
Success (HTTP 200)
Success (HTTP 200)
Returns a list Returns a list of devices with values for Device Code, Device Id, Device Name and Device Link URL, ordered by Device Code
...
|
...
|
...
|
...
|
...
...
...
|
...
|
...
|
...
|
...
|
...
|
...
...
...
},
{
"deviceCode"
:
"NortekADCP1504"
,
"deviceId"
:22666,
"deviceLink"
:
"https://data.oceannetworks.ca/DeviceListing?DeviceId=22666"
,
"deviceName"
:
"Nortek Aquadopp Profiler AQD 1504 on Crawler"
,
"dataRating"
: [{
"samplePeriod"
:60.0,
"dateFrom"
,
"2010-08-01 00:00:00"
}],
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
},
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
...
},
{
"deviceCode"
:
"NORTEKAQDPRO2751"
,
"deviceId"
:23164,
"deviceLink"
:
"https://data.oceannetworks.ca/DeviceListing?DeviceId=23164"
,
"deviceName"
:
"Nortek Aquadopp Profiler AQD 2751"
,
"dataRating"
: [{
"samplePeriod"
:300.0,
"dateFrom"
,
"2013-05-14 00:00:00"
}],
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
},
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
},
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
},
...
|
Property | Type | Description | Example |
---|---|---|---|
deviceCode | string | Returns the device code | "deviceCode":"BC_POD1_AD2M" |
deviceId | integer | Returns the device id | "deviceId":11302 |
deviceName | string | Returns the device name | "deviceName":"Nortek Aquadopp HR-Profiler 2965" |
deviceLink | url | Returns the a URL link to Device Listing page for the specific device | "deviceLink":"https://data.oceannetworks.ca/DeviceListing?DeviceId= |
...
11302" | |||
dataRating | list | Returns a list of data ratings and date from for each device–this list may be empty Each data rating is made up of:
| "dataRating": [ |
cvTerm | object | The list of controlled vocabulary terms associated with the device and any device groups the device belongs to. Each vocabulary term is made up of:
| "cvTerm": { |
hasDeviceData | boolean | hasDeviceData flag for devices with searchable device and siteDevice | "hasDeviceData":true |
Bad Request (HTTP 400)
errorCode | errorMessage | Description |
---|---|---|
23 | Invalid Time Range, Start Time is greater that End Time or start time is not provided | Occurs when the dateTo is before the dateFrom date/time.
|
25 | Invalid Time Range, Start Time is in the future. | Occurs when the dateFrom is in the future.
|
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.
|
128 | Missing parameter | Occurs when multiple parameters are needed, but not all are present. Occurs when dateFrom is used without dateTo or vice versa
|
129 | Invalid parameter name | Occurs when a filter parameter is in the query but is not supported.
|
Examples
- Return a list of All of the Devices (no filters)
"dataRating"
: [{
"samplePeriod"
:1200.0,
"dateFrom"
,
"2013-02-06 00:00:00"
},{
"samplePeriod"
:600.0,
"dateFrom"
,
"2014-04-17 17:00:00"
}],
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
},
{
"deviceCode"
:
"NORTEKAQDPRO8455"
,
"deviceId"
:23117,
"deviceLink"
:
"https://data.oceannetworks.ca/DeviceListing?DeviceId=23117"
,
"deviceName"
:
"Nortek Aquadopp Profiler AQD 8455"
,
"dataRating"
: [{
"samplePeriod"
:900.0,
"dateFrom"
,
"2013-04-18 00:00:00"
},{
"samplePeriod"
:600.0,
"dateFrom"
,
"2014-05-13 00:00:00"
}],
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
},
{
"deviceCode"
:
"NTAquadoppHRCP2973"
,
"deviceId"
:11203,
"deviceLink"
:
"https://data.oceannetworks.ca/DeviceListing?DeviceId=11203"
,
"deviceName"
:
"Nortek Aquadopp HR-Profiler 2973"
,
"dataRating"
: [{
"samplePeriod"
:120.0,
"dateFrom"
,
"2008-11-01 00:00:00"
},{
"samplePeriod"
:1.0,
"dateFrom"
,
"2010-05-13 23:17:54"
},{
"samplePeriod"
:10.0,
"dateFrom"
,
"2010-05-27 19:22:39"
}],
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
},
...
https://data.oceannetworks.ca/api/
...
...
method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53
- Return the Device with a Device Code of 'NORTEKADCP9917'
- Return a list of all of the Devices that have a Device Name which contains 'JASCO'
- Return a list of all of the devices that have been deployed at a location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')
- Return a list of all of the Devices with a Device Category of 'ADCP2MHZ'
- Return a list of all of the Devices with a Property Code of 'oxygen'
- Return a list of all of the Devices with a Device Category of 'CTD' and Property Code of 'pressure'
"dataRating"
: [{
"samplePeriod"
:1.0,
"dateFrom"
,
"2008-11-01 00:00:00"
},{
"samplePeriod"
:120.0,
"dateFrom"
,
"2008-03-01 00:00:00"
},{
"samplePeriod"
:1.0,
"dateFrom"
,
"2010-05-13 23:18:34"
},{
"samplePeriod"
:10.0,
"dateFrom"
,
"2010-05-27 19:32:41"
}],
"cvTerm"
: [{
"device"
: [{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
"uri"
:
"http://vocab.nerc.ac.uk/collection/L22/current/TOOL0888/"
}] }]
}]
...
...
...
...
...
"deviceCode":"BC_POD1_AD2M"
...
"deviceId":11302
...
https://data.oceannetworks.ca/api/
...
...
Returns a list of data ratings and date from for each device
Each data rating is made up of:
- Key : "samplePeriod", Value : sample period in seconds
- Key : "dateFrom", Value : "dateFrom of sample period"
...
"dataRating"
: [
{
"samplePeriod"
:
1.0
,
"dateFrom"
:
"2013-08-01 00:00:00"
}
]
...
The list of controlled vocabulary terms associated with the device and any device groups the device belongs to.
Each vocabulary term is made up of:
- Key : "vocabulary" Value : "title of the vocabulary term belongs to"
- Key : "uri" Value : "URL of the vocabulary term"
...
"cvTerm"
: [
{
"device"
: [
{
"vocabulary"
:
"SeaVoX Device Catalogue"
,
}
]
}
Bad Request (HTTP 400)
errorCode | errorMessage | Description |
---|---|---|
23 | Invalid Time Range, Start Time is greater than End Time or start time is not provided | Occurs when the deploymentEnd is before the deploymentBegin date/time
|
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
|
128 | Missing parameter | Occurs when multiple parameters are needed, but not all are present. Occurs when deploymentBegin is used without deploymentEnd
|
129 | Invalid parameter name | Occurs when a filter parameter is used, but is not supported |
URL Examples
- Return a list of All Devices (no filters)
https://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]
- Return the Device with a Device Code of 'NORTEKADCP9917'
- Return a list of all Devices that have a Device Name which contains 'JASCO'
https://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]&deviceName=JASCO
- Return a list of all Devices that have been deployed at a location with Location Code 'BACAX' ('Barkely Canyon Axis (POD1)')
https://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]&locationCode=BACAX
- Return a list of all Devices with a Device Category of 'ADCP2MHZ'
- Return a list of all Devices with a Property Code of 'oxygen'
https://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]&propertyCode=oxygen
- Return a list of all Devices with a Device Category of 'CTD' and Property Code of 'pressure'
- Return a list of all Devices that support the Data Product Code of 'IBPP' ('Ice Buoy Profile Plots')
https://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]&dataProductCode=IBPP
- Return a list of all of the Devices that were Deployed Between 1 July 2010 and 30 June 2012
- Return a list of all of the Devices Deployed Between 1 July 2010 and 30 June 2011, at a location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')
- Return a list of all of the Devices which have a Property Code of 'seawatertemperature', at a location with Location Code 'BACAX' ('Barkely Canyon Axis (POD1)'), Deployed Between 1 July 2010 and 30 June 2011
API Proxy
...
method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53&deviceCategoryCode=CTD&propertyCode=pressure
- Return a list of all of the Devices that support the Data Product Code of 'IBPP' ('Ice Buoy Profile Plots')
- Return a list of all of the Devices that were Deployed Between July 1st 2010 and June 30th 2012
- Return a list of all of the Devices Deployed Between July 1st 2010 and June 30th 2011, at a location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')
- Return a list of all of the Devices which have a Property Code of 'seawatertemperature', at a location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)'), Deployed Between July 1st 2010 and June 30th 2011
https://data.oceannetworks.ca/api/devices
...
Code Examples
Content Report Table | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...