...
The API locations discovery web service returns all the locations defined in Oceans 23.0 that meet a set of filter criteria.
A location is the parent of an Oceans 23.0 Tree Node from which you can get data. In the Oceans 23.0 Data Search GUI, a location is a Tree Node that contains device categories (Instruments by Location) or properties (Variables by Location) that can be selected to download data. From the Oceans 23.0 perspective, a location is a Search Tree Node that has one or more site devices and/or has one or more primary sensors. If there are multiple instruments of the same device category at a location, child locations or pseudo-nodes will exist and can be pulled from any one of them. Device Categories can be either at the location or at the child-level, whereas Properties (variables) can only be at the location level, due to the "Primary Sensor" concept, which stitches together data from multiple sensors over time at a location.
...
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
...
The getTree method returns a hierarchical representation of the ONC Search Tree Nodes. The Search Tree is used in Oceans 23.0 to organize Instruments and Variables by Location so that users can easily drill down by place name or mobile platform name to find the instruments or properties they are interested in.
Parameters
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 |
A valid locationCode is needed. One can be found by simply running the service without this parameter to get a list of all locations
- Code must match exactly, including case
| 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 |
Response
Response for request https://data.oceannetworks.ca/api/locations?method=getTree&token=YOUR_TOKEN_HERE&locationCode=BACCC
...
| Warning |
|---|
Please report all issues with the web services, documentation, samples and client libraries to the Oceans 23.0 Help Centre |