The API deviceCategories service returns all device categories defined in Oceans 2.0 that meet a filter criteria.
A Device Category represents an instrument type classification such as CTD (Conductivity, Temperature & Depth Instrument) or BPR (Bottom Pressure Recorder). Devices from a category can record data for one or more properties (variables).
The primary purpose of this service, is to find device categories that have the data you want to access; the service provides the deviceCategoryCode you can use when requesting a data product via the dataProductDelivery web service.
|get||Get a list of files for a given station, and filtered by others optional parameters.||method=get|
Get a list of device categories in Oceans 2.0.
|token||string||All 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=YOUR_TOKEN_HERE|
Return a single Device Category matching a specific Device Category Code
Return all of the Device Categories where the Device Category Name contains a keyword
Return all of the Device Categories where the Description contains a keyword.
Return all Device Categories that are represented at a specific Location.
Return all Device Categories associated specific Property.
Success (HTTP 200)
Returns a list of device categories with values for Device Category Code, Device Category Name, Description and Long Description, ordered by Device Category Code
|The unique code for the device category.|
|The name of the device category.|
|The short description of the device category.|
|hasDeviceData||string||Whether at least one device with this device category is NEPTUNE-searchable and has a NEPTUNE-searchable site.||"hasDeviceData":"true"|
|The long description of the device category.|
"longDescription":" Ice buoys are used in Arctic and Antarctic regions to track ice movement and collect environmental data.
Ice buoys can be geographically located with the Argos system or other satellite navigation receivers (e.g. GPS)."
The list of controlled vocabulary terms associated with the device category.
Each vocabulary term in the controlled vocabulary list contains two key-value pairs:
Bad Request (HTTP 400)
|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.
|129||Invalid parameter name|
Occurs when a filter parameter is used, but is not supported.
- Return a list of All Device Categories (no filters)
- Return the Device Category with Code 'ADCP1MHZ'
- Return a list of all Device Categories that have a Name which contains 'adcp'
- Return a list of all Device Categories that have a Description which contains 'doppler'
- Return a list of all Device Categories that are available at a location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')
- Return a list of all Device Categories which has devices with a specific Property Code of 'salinity'
The/apiproxy/deviceCategories URL 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 behaviour. In order to use the deviceCategories endpoint from code, you must use the url along with a valid token.
|Python Client Library||Ryan Ross||16-Aug-19|
|MATLAB Client Library||Ryan Ross||26-Apr-19|
|Discover Device Categories||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