...
No Format |
---|
http://data.oceannetworks.ca/api/scalardata |
Method | Description | Example |
---|---|---|
51085890getByLocation | Returns scalar data by given location code and device category | method=getByLocation |
51085890getByDevice | Returns scalar data by given device code. | method=getByDevice |
...
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 |
deviceCode | String | Return raw data of a specific Device Code.
| deviceCode=ASLZAP1006 |
Optional | |||
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 | String | Return raw 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=2017-06-08T00:00:00.000Z dateFrom=-P2Y11MT15H30M5S |
dateTo | String | 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=2017-06-08T01:00:00.000Z dateTo=P1Y2M10DT2H30M |
rowLimit | Integer | The limit on the number of scalar data readings to return. If not specified the row limit is 100,000. | rowLimit=300 |
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 added | 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:
| resamplePeriod=3600 |
fillGaps | boolean | if true fills scalar data gaps with NaN. By default data gaps are filled. | fillGaps=true |
...