...
Parameter | Type | Description | Example |
---|---|---|---|
Required | |||
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 |
Optional | |||
deviceCode | string | Return a single Device matching a specific Device Code.
| deviceCode=FSINXIC1622 |
deviceId | integer | Return a single Device matching a specific Device ID.
| deviceId=10301 |
deviceCategoryCode | string | Return all Devices belonging to a specific Device Category Code.
| deviceCategoryCode=CTD |
propertyCode | string | Return all Devices that have a sensor for a specific Property Code.
| propertyCode=pressure |
deviceName | string | Return all of the Devices where the Device Name contains a keyword.
| deviceName=meter |
locationCode | string | Return all Devices that are deployed at a specific Location.
| locationCode=BACAX |
includeChildren | boolean | Include all of the children of a location in the results
| includeChildren=true |
dataProductCode | string | Return all Devices that have the ability to return a specific Data Product Code.
| dataProductCode=jpgfile |
dateFrom | datetime | 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.
| dateFrom=2010-07-27T00:00:00.000Z dateFrom=2010-07-27 dateFrom=-P1DT1H
|
dateTo | datetime | 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.
| dateTo=2016-08-01T00:00:00.000Z dateTo=2016-08-01 dateTo=PT12H30M
|
...