...
| No Format |
|---|
https://data.oceannetworks.ca/api/scalardata |
| Method | Description | Example |
|---|---|---|
| getByStation | returns scalar data by given station code and device category | method=getByStation |
| getByLocation | returns scalar data by given location code and device category code | method=getByStationgetByLocation |
| Anchor | ||||
|---|---|---|---|---|
|
...
| Parameter | Type | Description | Example |
|---|---|---|---|
| Required | |||
| token | string | credential token. | |
| station | string | the code of a station (For a list of stations see stations) | NCBC |
| deviceCategory | string | the code of a device category (For a list of device categories for stations see stations) | BPR |
| Optional | |||
| sensors | string | a comma separated list of sensor codes for a station and device category. If missing, the system will return all search scalar data within to station code and device category code pair. | pressure,temperature |
| dateFrom | date | inclusive start date in "yyyy-MM-ddTHH:mm:ss.SSSZ" format. If missing, the system will return last reading. | 2015-05-25T00:00:00.000Z |
| dateTo | date | exclusive end date in "yyyy-MM-ddTHH:mm:ss.SSSZ" format. If missing the system will use 1 day range. | 2015-05-26T00:00:00.000Z |
| metadata | String (case insensitive) | Minimum – default Full | Minimum |
| outputFormat | String (case insensitive) | Object – default Array | Object |
| rowLimit | integer | Maximum number of rows of scalar data returned for each sensor code. Default is 100,000. Maximum is 100,000. | 80000 |
...
| Code Block | ||
|---|---|---|
| ||
{
"serviceMetadata": {
"station": string,
"deviceCategory": string,
"sensors": string,
"dateFrom": string,
"dateTo": string,
"metadata": string,
"rowLimit": string,
"outputFormat": stirng,
"totalActualSamples": integer,
"nextDateFrom": string
},
"metadata": {
"stationName": string,
"deviceCategoryName": string,
"dateFrom": string,
"dateTo": string,
"longitude": double,
"latitude": double,
"depth": double,
"bbox": {
"minLon": double,
"maxLon": double,
"minLat": double,
"maxLat": double,
"minDepth": double,
"maxDepth": double
}
},
"sensorData": [
{
"sensor": string,
"sensorName": string,
"unitOfMeasure": string,
"actualSamples"" integer,
"data": [//outputFormat=object
{
"sampleTime": string,
"value": double,
"qaqcFlag": integer
},
...
"data": [//outputFormat=array
{
"sampleTimes": [array of strings],
"values": [array of doubles],
"qaqcFlags": [array of integers]
},
...
]
},
...
]
}
|
...
https://data.oceannetworks.ca/api/scalardata?method=getByStation&token=a3079716-7d07-4d4a-bb5d-e521ad60b784YOUR_TOKEN&station=SCHDW.O1&deviceCategory=OXYSENSOR&sensors=oxygen_corrected
...
| Code Block | ||
|---|---|---|
| ||
{
"sensorData": [{
"actualSamples": 1,
"data": [{
"qaqcFlag": 1,
"sampleTime": "2015-12-08T18:52:35.089Z",
"value": 2.42722139
}],
"sensor": "oxygen",
"sensorName": "Oxygen",
"unitOfMeasure": "ml/l"
}],
"serviceMetadata": {
"dateFrom": null,
"dateTo": null,
"deviceCategory": "OXYSENSOR",
"nextDateFrom": null,
"outputFormat": null,
"rowLimit": null,
"sensors": "oxygen",
"station": "SCHDW.O1",
"totalActualSamples": 1
}
} |
| Anchor | ||||
|---|---|---|---|---|
|
Returns scalar data in JSON format by given location code and device category code.
Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| Required | |||
| token | string | credential token in GUID format | ffffffff-ffff-ffff-ffff-ffffffffffff |
| locationCode | string | the code of a location | KVIP.C2 |
| deviceCategoryCode | string | the code of a device category | BPR |
| Optional | |||
| propertyCode | String | the code of a property | seawatertemperature |
| dateFrom | date | inclusive start date in "yyyy-MM-ddTHH:mm:ss.SSSZ" format. If missing, the system will return last reading. | 2015-05-25T00:00:00.000Z |
| dateTo | date | exclusive end date in "yyyy-MM-ddTHH:mm:ss.SSSZ" format. If missing the system will use 1 day range. | 2015-05-26T20:01:23.456Z |
| metadata | String | Minimum (default or if missing) (case insensitive) Full (case insensitive) metadata is for the latest deployment overlapping dateFrom and dateTo or, if no dates specified, the latest deployment overall | Minimum |
| rowLimit | integer | maximum row scalar data returns for each sensor code. For those data they are sorted by sample time. If missing or invalid number, the maximum 100,000 will be used. If given number is over 100,000, the maximum 100,000 will be used. | 80000 |
Response
Success
| Code Block | ||
|---|---|---|
| ||
{
"metadata": {
"boundingBox": {
"maxDepth":<Double>,
"maxLat":<Double>,
"maxLon":<Double>,
"minDepth":<Double>,
"minLat":<Double>,
"minLon":<Double>
},
"depth":<Double>,
"deviceCategoryCode":<String>,
"lat":<Double>,
"locationName":<String>,
"lon":<Double>
},
"next": {
"parameters": {
"metadata":<String>,
"method":"getByLocation",
"dateTo":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
"rowLimit":<String>,
"locationCode":<String>,
"deviceCategoryCode":<String>,
"dateFrom":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
"token":<String (GUID)>
},
"url": <String (URL)>
},
"queryUrl": <String (URL)>,
"sensorData": [
{
"data": {
"qaqcFlags": <Array of integers>,
"sampleTimes": <Array of String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
"values": <Array of doubles>
},
"sensorCode":<String>,
"sensorName":<String>,
"unitOfMeasure":<String>
},
...
]
} |
| Property | Type | Description | Example |
|---|---|---|---|
| next | Object | An object containing information on how to make a rawdata call if the current call was unable to return all the data as a limit was exceeded. This is null if there is no more data in the requested range. | |
| Object | An object containing the set of parameters making up the query to get the next set of data in the requested date range. The parameters will include all parameters passed into the original URL. | |
| String | As passed into the original call | "minimum" |
| String | getByLocation, as passed into the original call. | "getByLocation" |
| String | As passed into the original call | "2015-02-25T00:00:01.000Z" |
| String | As passed into the original call | "10" |
| String | As passed into the original call | "NC27" |
| String | As passed into the original call | "CORK" |
| String | This is set to 1 millisecond more than the date of the last reading sent in the current call. | "2015-02-25T00:00:01.189Z" |
| String | As passed into the original call | "ffffffff-ffff-ffff-ffff-ffffffffffff" |
| String | The complete URL that can be used to get the next set of data in the requested range. | "https://data.oceannetworks.ca/api/scalardata?method=getByLocation&dateTo=2015-02-25T00%3A00%3A01.000Z&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00%3A00%3A01.189Z&token=YOUR_TOKEN" |
| queryUrl | String | URL of current query | "https://data.oceannetworks.ca/api/scalardata?method=getByLocation&dateTo=2015-02-25T00%3A00%3A01.000Z&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00%3A00%3A00.000Z&token=YOUR_TOKEN" |
| sensorData | Array of objects | Data sets returned for all applicable sensors | |
| Object | Data sets returned for a single sensor | |
| Array of integers | QAQC test results of each data point–guidelines for what each number means:
| [1] |
| Array of strings | Sampling times of sensor data returned, formatted asyyyy-MM-dd'T'HH:mm:ss.SSS'Z' | ["2015-02-25T00:00:00.188Z"] |
| Array of doubles | Values of sensor data returned, units of measurement are given in sensorData.unitOfMeasure | [2706.1145305467917] |
| String | Code of sensor, can be null | "sigmaT" |
| String | Name that denotes what the sensor measures | "Uncompensated Borehole Pressure" |
| String | Unit of measurement or "NA" if none apply; temperature units of measure are "C" for degrees Celsius | "Gregorian days since 19700101T000000Z" |
| metadata | Object | Optional; only returned if the metadata parameter is set to full | |
| Object | Bounding limits statistics | |
| Double | Maximum depth in meters below water surface (negative numbers denote above) | 982.0 |
| Double | Maximum latitude in degrees north of the equator (negative numbers denote south) | 48.316583 |
| Double | Maximum longitude in degrees east of the prime meridian (negative numbers denote west) | -126.050796 |
| Double | Minimum depth in meters below water surface (negative numbers denote above) | 982.0 |
| Double | Minimum latitude in degrees north of the equator (negative numbers denote south) | 48.316583 |
| Double | Minimum longitude in degrees east of the prime meridian (negative numbers denote west) | -126.050796 |
| Double | Depth in meters below water surface (negative numbers denote above) | 2660.5 |
| String | Should be the same as next.parameters.deviceCategoryCode | "CORK" |
| Double | Latitude in degrees north of the equator (negative numbers denote south) | 47.7626 |
| String | Name of location | "ODP 1026" |
| Double | Longitude in degrees east of the prime meridian (negative numbers denote west) | -127.759212 |
Note: Not all the properties above may be included in the resulting JSON, especially parameters that were not in the original call.
Failure
Example
| Code Block |
|---|
{"next":{"parameters":{"method":"getByLocation","dateTo":"2015-02-25T00:00:01.000Z","locationCode":"NC27","deviceCategoryCode":"CORK","dateFrom":"2015-02-25T00:00:01.189Z","token":"YOUR_TOKEN"},"url":"https://data.oceannetworks.ca/api/scalardata?method=getByLocation&dateTo=2015-02-25T00%3A00%3A01.000Z&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00%3A00%3A01.189Z&token=YOUR_TOKEN"},"queryUrl":"https://data.oceannetworks.ca/api/scalardata?method=getByLocation&dateTo=2015-02-25T00%3A00%3A01.000Z&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00%3A00%3A00.000Z&token=c9ed940d-1c48-49ca-9bbd-1b126cb50917","sensorData":[{"data":{"qaqcFlags":[1],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[2705.9145624950315]},"sensorCode":null,"sensorName":"Uncompensated Borehole Pressure","unitOfMeasure":"decibar"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[15044.155636574074]},"sensorCode":null,"sensorName":"Instrument Clock","unitOfMeasure":"Gregorian days since 19700101T000000Z"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[15044.157647118056]},"sensorCode":null,"sensorName":"Corrected Instrument Clock","unitOfMeasure":"Gregorian days since 19700101T000000Z"},{"data":{"qaqcFlags":[1],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[0.0731633552918538]},"sensorCode":null,"sensorName":"DART Pressure Residual","unitOfMeasure":"decibar"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[0.12011008833997039]},"sensorCode":null,"sensorName":"Detider Peak Value","unitOfMeasure":"NA"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[0.0]},"sensorCode":null,"sensorName":"Direct Detider Weighted Threshold","unitOfMeasure":"NA"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[0.0]},"sensorCode":null,"sensorName":"Kurtosis Weighted Threshold","unitOfMeasure":"NA"},{"data":{"qaqcFlags":[1],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[2706.1145305467917]},"sensorCode":null,"sensorName":"Uncompensated Seafloor Pressure","unitOfMeasure":"decibar"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[-0.0021135619302466158]},"sensorCode":null,"sensorName":"Seismic Detector","unitOfMeasure":"NA"},{"data":{"qaqcFlags":[1],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[1.804350543379081]},"sensorCode":null,"sensorName":"Housing Temperature","unitOfMeasure":"C"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[3.0629564319830638]},"sensorCode":null,"sensorName":"WARN Kurtosis","unitOfMeasure":"NA"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[1.5]},"sensorCode":null,"sensorName":"WARN Watcher","unitOfMeasure":"NA"},{"data":{"qaqcFlags":[0],"sampleTimes":["2015-02-25T00:00:00.188Z"],"values":[1.0]},"sensorCode":null,"sensorName":"WARN Watcher Weighted Threshold","unitOfMeasure":"NA"}]} |