The API devices returns all the devices defined in Oceans 2.0 that meet a set of filter criteria.
Devices are instruments 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 the devices service is to find devices that have the data you are interested in and use the deviceCode when requesting a data product using the dataProductDelivery web service.
Retrieve a list of all devices
The get method retrieves a list of devices with deviceId, deviceCode, and deviceName.
|token||string||All Web Services require a token. This can be generated at https://data.oceannetworks.ca/Profile. Click on the "Web Services" tab and click "Generate Token".||token=YOUR_TOKEN_HERE|
Return a single Device matching a specific Device Code.
Return a single Device matching a specific Device ID.
Return all Devices belonging to a specific Device Category Code.
Return all Devices that have a sensor for a specific Property Code.
Return all of the Devices where the Device Name contains a keyword.
Return all Devices that are deployed at a specific Location.
Return all Devices that are deployed at a specific Location and sub-tree Locations.
Return all Devices that have the ability to return a specific Data Product Code.
Return all of the Devices that have a Deployment Beginning on or after a specific date/time.
Accepted DateTime formats:
If not specified, the default value is the beginning of time.
Return all of the Devices that have a Deployment Ending before a specific date/time.
Accepted DateTime formats:
If not specified, the default value is the end of time.
Success (HTTP 200)
Returns a list of devices with values for Device Code, Device Id, Device Name and Device Link URL, ordered by Device Code
|deviceCode||string||Returns the device code|
|deviceId||integer||Returns the device id|
|deviceCategoryCode||string||Returns the device category code||"deviceCategoryCode:"HYDROPHONE"|
|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|
Returns a list of data ratings and date from for each device–this list may be empty
Each data rating is made up of:
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:
|hasDeviceData||boolean||hasDeviceData flag for devices with searchable device and siteDevice|
Bad Request (HTTP 400)
|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.
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.
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.
- Return a list of All of the Devices (no filters)
- 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'
- 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
- Return a list of all of the devices that have been deployed at a location with a Location Code of 'BACCC' ('Barkely Canyon Coral Cliff') and children locations
The/apiproxy/devicesURL link in the above examples can be used in a browser for sharing or testing purposes; however, it can not be accessed from code. Calls to the apiproxy server are redirected to a login screen to capture your user id. Accessing the apiproxy URL from code will return html in the payload, which may cause errors or unexpected behavior. In order to use the deployments endpoint from code, you must use the url along with a valid token.
|Discover Devices||Ryan Ross||23-Apr-18|
Please report all issues with the web services, documentation, samples and client libraries to the Oceans 2.0 Help Centre