...
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 | |||
locationCode | string | Return a single Location matching a specific Location Code.
| locationCode=BACAX |
deviceCategoryCode | string | Return all Locations that have devices with a specific Device Category Code.
| deviceCategoryCode=CTD |
propertyCode | string | Return all Locations that have devices with a sensor with a specific Property Code.
| propertyCode=differentialtemperature |
dataProductCode | string | Return all of the Locations that support a specific Data Product Code.
| dataProductCode=CPID |
dateFrom | datetime | Return all of the Locations 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 Locations 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
|
locationName | string | Return all of the Locations where the Location Name contains a keyword.
| locationName=mill |
deviceCode | string | Return all of the Locations where a specific device with that Device Code has been deployed.
| deviceCode=AandOpt0581 |
includeChildren | bool | Include all of the children of a Location in the resultsReturn all Devices that are deployed at a specific Location and sub-tree Locations.
| includeChildren=true |
Response
...