...
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 |
locationCode | string | Return scalar data from a specific Location.
| locationCode=KVIP.C2 |
deviceCategoryCode | string | Return scalar data belonging to a specific Device Category Code.
| deviceCategoryCode=BPR |
Optional | |||
propertyCode | string | Return scalar data from device for a comma separated list of Properties.
| propertyCode=seawatertemperature,totalpressure |
sensorCategoryCodes | string | A comma separated list of sensor code names. If missing, the system will return all search scalar data within the location code, device category pair, and propertyCode (if given). | sensorCategoryCodes= pressure,borehole_pressure1,oxygen |
dateFrom | date | Return scalar data that has a timestamp 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 | date | Return scalar data that has a timestamp 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
|
metadata | string | There are two values:
The metadata is for the latest deployment overlapping the time range specified by dateFrom and dateTo. | metadata=Minimum |
rowLimit | integer | Limits the number of scalar data rows returned for each sensor code. If rowLimit is missing, is an invalid number, or is over 100,000, the maximum value of 100,000 will be used. | rowLimit=80000 |
outputFormat | string | There are two values:
| outputFormat=Object |
getLatest | boolean | Specifies whether or not the latest scalar data readings should be returned first. getLatest = false: default getLatest = true: readings are returned and pagination is done from latest to earliest. | getLatest=true |
qualityControl | string | accepted values:
The default value when no qualityControl has been provided is: qualityControl = clean. To get resampled data values: qualityControl = clean. | qualityControl=clean |
resampleType | string | accepted values:
The default value when no resampleType has been provided is: resampleType=avgMinMax.The resmapleType option requires that a samplePeriod has been addedresampleType option requires that a resamplePeriod has been added. If there is a resamplePeriod, but no resampleType, resampleType defaults to avgMinMax. | resampleType=avgMinMax |
resamplePeriod | integer | To resample clean scalar data the resample period is set in seconds. The resamplePeriod parameter is required for the resampleType parameter. accepted values:
'0' or 'none' are not accepted. To not resample the data, do not include this parameter. | resamplePeriod=3600 |
fillGaps | boolean | if true fills scalar data gaps with NaN. By default data gaps are filled. | fillGaps=true |
...