Page History

...

Returns scalar data in JSON format by given location code and device category code.

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

locationCode

string

Return scalar data from a specific Location.

Location Code must be valid

and match exactly, including case

.
Specific Location Codes can be obtained using the locations service.

locationCode=KVIP.C2

deviceCategoryCode

string

Return scalar data belonging to a specific Device Category Code.

Device Category Code must be valid

and match exactly, including case

. Specific Device Category Codes can be obtained using the deviceCategories service.	deviceCategoryCode=BPR
Optional
propertyCode	string	Return scalar data from

devices with a sensor

device for a

specific Property.

Property Code must be valid and match exactly, including case.

comma separated list of Properties.

Specific propertyCode

Specific Property Codes

can be obtained using

the

the properties service. propertyCode must be valid exact match is case sensistive	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). To discover the sensorCategoryCodes, poll this service with returnOptions=excludeScalarData and check the sensorData response.	sensorCategoryCodes= pressure,borehole_pressure1,oxygen
dateFrom	date	Return scalar data that has a timestamp on or after a specific date/time. Accepted DateTime formats: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended) yyyy-MM-dd (ISO 8601 Extended) PnYnMnDTnHnMnS (ISO 8601 Duration) If not specified, the default value is the beginning of time. DateTime is represented in Coordinated Universal Time (UTC). ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z). Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.	dateFrom=2010-07-27T00:00:00.000Z dateFrom=2010-07-27 dateFrom=-P1DT1H Previous 1 day and 1 hour, relative to the dateTo. Note the '-' before the P.
dateTo	date	Return scalar data that has a timestamp before a specific date/time. Accepted DateTime formats: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended) yyyy-MM-dd (ISO 8601 Extended) PnYnMnDTnHnMnS (ISO 8601 Duration) If not specified, the default value is the end of time. DateTime is represented in Coordinated Universal Time (UTC). ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z). Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.	dateTo=2016-08-01T00:00:00.000Z dateTo=2016-08-01 dateTo=PT12H30M Next 12 hours and 30 minutes, relative to the dateFrom.
metadata	string	There are two values: Minimum (default) (case insensitive) provides only basic property information Full (case insensitive) provides all property information 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: Array (default) (case insensitive) Data is output as three arrays for a given sensor: a sampleTime array, a values array, and a qaqcFlags array. Object (case insensitive) Data is output as a list of objects for a given sensor. Inside each data object, there are sampleTime, value, and qaqcFlag lists.	outputFormat=Object
getLatest	boolean	Specifies whether or not the latest scalar data readings should be returned first.

This is false by default. When set to true,

getLatest = false: default

getLatest = true: readings are returned and pagination is done from latest to earliest.

getLatest=true

...

Success

Code Block

language	js

{
	"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>,
			"sensorCategoryCodes":<String>,
		 	"dateFrom":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
			"outputFormat" : <String>,
            "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>
		},
		...
	]
}

...


qualityControl	string	accepted values: raw returns raw scalar data clean returns clean scalar data 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: avg gets the average value in each resamplePeriod avgMinMax gets the average, minimum, and maximum values in each resample period minMax gets the minimum and maximum values in each resample period The resampleType option requires that a resamplePeriod has been added. If there is a resamplePeriod, but no resampleType, resampleType defaults to avgMinMax. The value of 'none' is not accepted, however that is the effective default when both the resampleType and resamplePeriod parameters are left off / not included.	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: 1 (1 Second) 5 (5 Seconds) 10 (10 Seconds) 15 (15 Seconds) 30 (30 Seconds) 60 (1 Minute) 300 (5 Minutes) 600 (10 Minutes) 900 (15 Minutes) 1800 (30 Minutes) 3600 (1 Hour) 7200 (2 Hours) 14400 (4 Hours) 21600 (6 Hours) 43200 (12 Hours) 86400 (1 Day) 172800 (2 Days) 259200 (3 Days) 604800 (1 Week) 1209600 (2 Weeks) 2592000 (30 Days) '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
sensorsToInclude	string	accepted values: original returns scalar data from original sensors externallyDerived returns scalar data from externally derived sensors The default value when no sensorsToInclude have been provided is: sensorsToInclude=original. The sensorsToInclude=externallyDerived option requires that qualityControl either not be set or be set to qualityControl=clean	sensorsToInclude=original
returnOptions	string	accepted values: excludeScalarData When set to excludeScalarData the service response will not contain the sensordata.data field. This is useful for users interested in discovering sensorCategoryCodes and other metadata without having to wait for / handle data.	returnOptions=excludeScalarData

Response

Success

Code Block

language	js

{
    "metadata": {
        "boundingBox": {
            "maxDepth":<Double>,
            "maxLat":<Double>,
            "maxLon":<Double>,
            "minDepth":<Double>,
            "minLat":<Double>,
            "minLon":<Double>
        },
        "depth":<Double>,
        "deviceCategoryCode":<String>,
        "lat":<Double>,
        "locationName":<String>,
        "lon":<Double>
    },
    "parameters": {
            "metadata":<String>,
            "method":"getByLocation",
            "dateTo":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
            "rowLimit":<String>,
            "locationCode":<String>,
            "deviceCategoryCode":<String>,
            "sensorCategoryCodes":<String>,
            "dateFrom":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
            "outputFormat" : <String>,
            "token":<String (GUID)>,
            "resamplePeriod": <String>,
            "resampleType": <String>,
            "qualityControl": <String>,
            "fillGaps": <Boolean>,
            "sensorsToInclude": <String>
        },
    "next": {
        "parameters": {
            "metadata":<String>,
            "method":"getByLocation",
            "dateTo":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
            "rowLimit":<String>,
            "locationCode":<String>,
            "deviceCategoryCode":<String>,
            "sensorCategoryCodes":<String>,
           "dateFrom":<String (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')>,
            "outputFormat" : <String>,
            "token":<String (GUID)>,
            "resamplePeriod": <String>,
            "resanmpleType": <String>,
            "qualityControl": <String>,
            "fillGaps": <Boolean>
            "sensorsToInclude": <String>
        },
        "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>

...

next.parameters

...

- next.parameters.metadata

...

- next.parameters.method

...

- next.parameters.dateTo

...

"2015-02-25T00:00:01.000Z"

...

- next.parameters.rowLimit

...

- next.parameters.locationCode

...

- next.parameters.deviceCategoryCode

...

- next.parameters.sensorCategoryCodes

...

- next.parameters.dateFrom

...

"2015-02-25T00:00:01.189Z"

...

- next.parameters.outputFormat

...

- next.parameters.token

...

next.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_HERE"

...

"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_HERE"

...

sensorData.data

...

- sensorData.data.qaqcFlags

...

QAQC test results of each data point–guidelines for what each number means:

0 No quality control on data
1 Data passed all tests
2 Data probably good
3 Data probably bad. Failed minor tests
4 Data bad. Failed major tests
7 Averaged value
8 Interpolated value
9 Missing data

...

- sensorData.data.sampleTimes

...

yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

...

- sensorData.data.values

...

sensorData.sensorCode

...

sensorData.sensorName

...

"Uncompensated Borehole Pressure"

...

sensorData.unitOfMeasure

...

"Gregorian days since 19700101T000000Z"

...

metadata.boundingBox

...

- metadata.boundingBox.maxDepth

...

- metadata.boundingBox.maxLat

...

- metadata.boundingBox.maxLon

...

- metadata.boundingBox.minDepth

...

- metadata.boundingBox.minLat

...

- metadata.boundingBox.minLon

...

metadata.depth

...

metadata.deviceCategoryCode

...

metadata.lat

...

metadata.locationName

...

metadata.lon

...

Note: Not all the properties above may be included in the resulting JSON, especially parameters that were not in the original call.

Example

https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=YOUR_TOKEN_HERE&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:01.000Z&propertyCode=totalpressure&sensorCategoryCodes=pressure

Code Block

{ 
   "next":{ 
      "parameters":{ 
         "propertyCode":"totalpressure",
         "method":"getByLocation",
       "min": <Array of doubles>,
                "sensorCategoryCodesmax":"pressure,borehole_pressure1" <Array of doubles>,
         "dateTo":"2015-02-25T00:00:01.000Z",
         "locationCodecounts":"NC27", <Array of integers>
         "deviceCategoryCode":"CORK"   },
            "dateFromsensorCategoryCode":"2015-02-25T00:00:01.189Z"<String>,
            "tokensensorCode":"YOUR_TOKEN_HERE"<String>,
      },
      "urlsensorName":"https://data.oceannetworks.ca/api/scalardata?propertyCode=totalpressure&sensorCategoryCodes=pressure,borehole_pressure1&method=getByLocation&dateTo=2015-02-25T00%3A00%3A01.000Z&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00%3A00%3A01.189Z&token=YOUR_TOKEN_HERE"
<String>,
            "unitOfMeasure":<String>
            "actualSamples":<Integer>
        },
        "queryUrl":"https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=YOUR_TOKEN_HERE&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=...
    ]
}

Property	Type	Description	Example
parameters	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.
parameters.metadata	String	As passed into the original call	"minimum"
parameters.method	String	getByLocation, as passed into the original call.	"getByLocation"
parameters.dateTo	String	As passed into the original call	"2015-02-25T00:00:

...

01.000Z"
parameters.rowLimit	String	As passed into the original call	"10"
parameters.locationCode	String	As passed into the original call	"NC27"
parameters.deviceCategoryCode	String	As passed into the original call	"CORK"
parameters.sensorCategoryCodes	String	As passed into the original call	"pressure"
parameters.dateFrom	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"
parameters.outputFormat	String	As passed into the original call	"object"
parameters.token	String	As passed into the original call	"ffffffff-ffff-ffff-ffff-ffffffffffff"
parameters.resamplePeriod	String	As passed into the original call	15
parameters.resampleType	String	As passed into the original call	avg
parameters.qualityControl	String	As passed into the original call	clean
parameters.dataGaps	Boolean	As passed into the original call	false
parameters.sensorsToInclude	String	As passed into the original call	original
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.
next.parameters	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.
next.parameters.metadata	String	As passed into the original call	"minimum"
next.parameters.method	String	getByLocation, as passed into the original call.	"getByLocation"
next.parameters.dateTo	String	As passed into the original call	"2015-02-25T00:00:01.000Z"
next.parameters.rowLimit	String	As passed into the original call	"10"
next.parameters.locationCode	String	As passed into the original call	"NC27"
next.parameters.deviceCategoryCode	String	As passed into the original call	"CORK"
next.parameters.sensorCategoryCodes	String	As passed into the original call	"pressure"
next.parameters.dateFrom	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"
next.parameters.outputFormat	String	As passed into the original call	"object"
next.parameters.token	String	As passed into the original call	"YOUR_TOKEN_HERE"
next.parameters.sensorsToInclude	String	As passed into the original call	"original"
next.url	String	The complete URL that can be used to get the next set of data in the requested range.	"https:/

Example with outputFormat option

...

/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_HERE"
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_HERE"
sensorData	Array of objects	Data sets returned for all applicable sensors
sensorData.data	Object	Data sets returned for a single sensor
sensorData.data.qaqcFlags	Array of integers	QAQC test results of each data point–guidelines for what each number means: 0 No quality control on data 1 Data passed all tests 2 Data probably good 3 Data probably bad. Failed minor tests 4 Data bad. Failed major tests 7 Averaged value 8 Interpolated value 9 Missing data	[1]
sensorData.data.sampleTimes	Array of strings	Sampling times of sensor data returned, formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'	["2015-02-25T00:00:00.188Z"]
sensorData.data.values	Array of doubles	Values of sensor data returned, units of measurement are given in sensorData.unitOfMeasure	[2706.1145305467917]
sensorData.data.min	Array of doubles	only in the response if min values are part of the resampleType. The array contains the minimum scalar data value in each resample period. Units of measurement are given in sensorData.unitOfMeasure.	[2706.1145305467917]
sensorData.data.max	Array of doubles	only in the response if max values are part of the resampleType. The array contains the maximum scalar data value in each resample period. Units of measurement are given in sensorData.unitOfMeasure.	[2706.1145305467917]
sensorData.data.counts	Array of Integers	only in the response if a resample period is selected. contains the count of samples in each period	[3600]
sensorData.actualSamples	String	the number of scalar data values returned excluding any NaN values	48
sensorData.sensorCode	String	Code of sensor, can be null	"sigmaT"
sensorData.sensorName	String	Name that denotes what the sensor measures	"Uncompensated Borehole Pressure"
sensorData.unitOfMeasure	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
metadata.boundingBox	Object	Bounding limits statistics
metadata.boundingBox.maxDepth	Double	Maximum depth in meters below water surface (negative numbers denote above)	982.0
metadata.boundingBox.maxLat	Double	Maximum latitude in degrees north of the equator (negative numbers denote south)	48.316583
metadata.boundingBox.maxLon	Double	Maximum longitude in degrees east of the prime meridian (negative numbers denote west)	-126.050796
metadata.boundingBox.minDepth	Double	Minimum depth in meters below water surface (negative numbers denote above)	982.0
metadata.boundingBox.minLat	Double	Minimum latitude in degrees north of the equator (negative numbers denote south)	48.316583
metadata.boundingBox.minLon	Double	Minimum longitude in degrees east of the prime meridian (negative numbers denote west)	-126.050796
metadata.depth	Double	Depth in meters below water surface (negative numbers denote above)	2660.5
metadata.deviceCategoryCode	String	Should be the same as next.parameters.deviceCategoryCode	"CORK"
metadata.lat	Double	Latitude in degrees north of the equator (negative numbers denote south)	47.7626
metadata.locationName	String	Name of location	"ODP 1026"
metadata.lon	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.

Example

https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=YOUR_TOKEN_HERE&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:01.000Z&propertyCode=totalpressure&sensorCategoryCodes=pressure

Code Block
{ "next": null, "parameters": { "dateFrom":

...

Code Block

{  
   "next":{  
      "parameters":{  
         "propertyCode":"totalpressure",
         "method":"getByLocation",
         "dateTo":"2015-02-25T00:00:01.000Z",
         "locationCode":"NC27",
         "deviceCategoryCode":"CORK",
         "dateFrom":"2015-02-25T00:00:01.189Z",
         "outputFormat":"object",
         "token":"YOUR_TOKEN_HERE"
      },
      "url":"https://data.oceannetworks.ca/api/scalardata?propertyCode=totalpressure&method=getByLocation&dateTo=2015-02-25T00%3A00%3A01.000Z&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00%3A00%3A01.189Z&outputFormat=object&token=YOUR_TOKEN_HERE"
   },
   "queryUrl":"https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=YOUR_TOKEN_HERE&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:01.000Z&propertyCode=totalpressure&outputFormat=object",
   "sensorData":[  
      {  
         "data":[  
            {  
               "qaqcFlag":1,
               "sampleTime":"2015-02-25T00:00:00.188Z",
               "value":2706.1145305467917
            }
         ],
         "sensorCode":"Pressure",
         "sensorName":"Uncompensated Seafloor Pressure",
         "unitOfMeasure":"decibar"
      },
      {  
         "data":[  
            {  
               "qaqcFlag":1,
               "sampleTime":"2015-02-25T00:00:00.188Z000Z",
               "value":2705.9145624950315
            }
         ],
         "sensorCode":"borehole_pressure1",
         "sensorName":"Uncompensated Borehole Pressure",
         "unitOfMeasure":"decibar"
      }
   ]
}

...

Returns scalar data in JSON format by given device code.

Parameters

...

		"dateTo": "2015-02-25T00:00:01.000Z",
		"deviceCategoryCode": "CORK",
		"fillGaps": true,
		"getLatest": false,
		"locationCode": "NC27",
		"metaData": "Minimum",
		"method": "getByLocation",
		"outputFormat": "Array",
		"propertyCode": ["totalpressure"],
		"qualityControl": "clean",
		"resamplePeriod": null,
		"resampleType": null,
		"rowLimit": 100000,
		"sensorCategoryCodes": "pressure",
        "sensorsToInclude": "original",
		"token": "TOKEN"
	},
	"queryUrl": "https://data.oceannetworks.ca

...

Return raw data of a specific Device Code.

Device Code must be valid and match exactly, including case.
Specific Device Codes can be found by simply running the service without this parameter to get a list of all devices.

...

Return raw data that has a timestamp on or after a specific date/time.

Accepted DateTime formats:

yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended)
yyyy-MM-dd (ISO 8601 Extended)
PnYnMnDTnHnMnS (ISO 8601 Duration)

If not specified, the default value is the beginning of time.

DateTime is represented in Coordinated Universal Time (UTC).
ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.

...

dateFrom=2017-06-08T00:00:00.000Z

dateFrom=-P2Y11MT15H30M5S

...

Return scalar data that has a timestamp before a specific date/time.

Accepted DateTime formats:

yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended)
yyyy-MM-dd (ISO 8601 Extended)
PnYnMnDTnHnMnS (ISO 8601 Duration)

If not specified, the default value is the end of time.

DateTime is represented in Coordinated Universal Time (UTC).
ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.

...

dateTo=2017-06-08T01:00:00.000Z

dateTo=P1Y2M10DT2H30M

...

There are two values:

Array (default or if missing) (case insensitive)
- Data will be output as three arrays for a given device: a lineTypes array, a readings array, and a times array.
Object (case insensitive)
- Data will be output as a list of objects for a given device. Inside each data object, there are lineType, scalarData, and sampleTime lists.

...

/api/scalardata?method=getByLocation&token=TOKEN&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:01.000Z&propertyCode=totalpressure&sensorCategoryCodes=pressure",
	"sensorData": [{
		"actualSamples": 1,
		"data": {
			"qaqcFlags": [1],
			"sampleTimes": ["2015-02-25T00:00:00.968Z"],
			"values": [2707.312585039748]
		},
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Uncompensated Seafloor Pressure",
		"unitOfMeasure": "decibar"
	}]
}

Example with outputFormat option

https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=YOUR_TOKEN_HERE&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:02.000Z&propertyCode=totalpressure&outputFormat=object

Code Block

{
	"next": null,
	"parameters": {
		"dateFrom": "2015-02-25T00:00:00.000Z",
		"dateTo": "2015-02-25T00:00:02.000Z",
		"deviceCategoryCode": "CORK",
		"fillGaps": true,
		"getLatest": false,
		"locationCode": "NC27",
		"metaData": "Minimum",
		"method": "getByLocation",
		"outputFormat": "object",
		"propertyCode": ["totalpressure"],
		"qualityControl": "clean",
		"resamplePeriod": null,
		"resampleType": null,
		"rowLimit": 100000,
		"sensorCategoryCodes": null,
        "sensorsToInclude": "original",
		"token": "TOKEN"
	},
	"queryUrl": "https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=TOKEN&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:02.000Z&propertyCode=totalpressure&outputFormat=object",
	"sensorData": [{
		"actualSamples": 2,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2015-02-25T00:00:00.968Z",
			"value": 2706.2404888151023
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2015-02-25T00:00:01.969Z",
			"value": 2706.238440580094
		}],
		"sensorCategoryCode": "borehole_pressure1",
		"sensorCode": "borehole_pressure1",
		"sensorName": "Uncompensated Borehole Pressure",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 2,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2015-02-25T00:00:00.968Z",
			"value": 2707.312585039748
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2015-02-25T00:00:01.969Z",
			"value": 2707.3135371260782
		}],
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Uncompensated Seafloor Pressure",
		"unitOfMeasure": "decibar"
	}]
}

Example with resamplePeriod option

https://data.oceannetworks.ca/api/scalardata?locationCode=NCBC&deviceCategoryCode=BPR&dateFrom=2019-11-23T23%3A15%3A51.109Z&dateTo=2019-11-23T23%3A45%3A51.109Z&sensorCategoryCodes=pressure&method=getByLocation&token=YOUR_TOKEN_HERE&resamplePeriod=600&fillGaps=false&resampleType=avgminmax

Code Block

{
	"next": null,
	"parameters": {
		"dateFrom": "2019-11-23T23:15:51.109Z",
		"dateTo": "2019-11-23T23:45:51.109Z",
		"deviceCategoryCode": "BPR",
		"fillGaps": false,
		"getLatest": false,
		"locationCode": "NCBC",
		"metaData": "Minimum",
		"method": "getByLocation",
		"outputFormat": "Array",
		"propertyCode": null,
		"qualityControl": "clean",
		"resamplePeriod": 600,
		"resampleType": "avgminmax",
		"rowLimit": 100000,
		"sensorCategoryCodes": "pressure

Response

Success (outputFormat = Array)

Code Block

language	js
title	Sample Response

{
  "next": {
    "parameters": {
      "method": "getByDevice",
      "dateTo": "2019-02-16T02:00:00.010Z",
      "deviceCode": "SBECTD19p7027",
      "rowLimit": "2",
      "dateFrom": "2019-02-16T00:40:39.319Z",
      "token": "ffffffff-ffff-ffff-ffff-ffffffffffff"
    },
    "url": "http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&dateTo=2019-02-16T02%3A00%3A00.010Z&deviceCode=SBECTD19p7027&rowLimit=2&dateFrom=2019-02-16T00%3A40%3A39.319Z&token=ffffffff-ffff-ffff-ffff-ffffffffffff"
  },
  "queryURL": "http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&token=ffffffff-ffff-ffff-ffff-ffffffffffff&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:06:26.028Z&dateTo=2019-02-16T02:00:00.010Z&rowLimit=2",
  "sensorData": [
    {
      "data": {
        "qaqcFlags": [
          1,
          1
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          3.15891,
          3.15889
        ]
      },
      "sensorCategoryCode": "conductivity",
      "sensorCode": "cond",
      "sensorName": "Conductivity",
      "unitOfMeasure": "S/m"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
         "sensorsToInclude": "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          1033.216417644338,
          1033.216285819126
        ]
      },
      "sensorCategoryCode": "density",
      "sensorCode": "density",
      "sensorName": "Density",
      "unitOfMeasure": "kg/m3"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          1271.617,
          1271.62
        ]
      },
      "sensorCategoryCode": "pressure",
      "sensorCode": "Pressure",
      "sensorName": "Pressure",
      "unitOfMeasure": "decibar"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4
        ]original",
		"token": "TOKEN"
	},
	"queryUrl": "https://data.oceannetworks.ca/api/scalardata?locationCode=NCBC&deviceCategoryCode=BPR&dateFrom=2019-11-23T23%3A15%3A51.109Z&dateTo=2019-11-23T23%3A45%3A51.109Z&sensorCategoryCodes=pressure&method=getByLocation&token=TOKEN&resamplePeriod=600&fillGaps=false&resampleType=avgminmax",
	"sensorData": [{
		"actualSamples": 2,
		"data": {
			"counts": [600, 600],
			"max": [410.2151224819547, 410.17906942902374],
			"min": [410.1460181119412, 410.1308777147202],
			"qaqcFlags": [7, 7],
			"sampleTimes": ["2019-11-23T23:20:00.000Z", "2019-11-23T23:30:00.000Z"],
			"values": [410.18493704546466, 410.15440282136035]
		},
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Seafloor Pressure",
		"unitOfMeasure": "decibar"
	}]
}

Example with multiple property codes option

https://data.oceannetworks.ca/api/scalardata?locationCode=NCBC&deviceCategoryCode=BPR&dateFrom=2019-11-23T23%3A59%3A51.109Z&dateTo=2019-11-23T23%3A59%3A55.109Z&method=getByLocation&token=TOKEN_HERE&propertyCode=totalpressure,seawatertemperature

Code Block

{
	"next": null,
	"parameters": {
		"dateFrom": "2019-11-23T23:59:51.109Z",
		"dateTo": "2019-11-23T23:59:55.109Z",
		"deviceCategoryCode": "BPR",
		"fillGaps": true,
		"getLatest": false,
		"locationCode": "NCBC",
		"metaData": "Minimum",
		"method": "getByLocation",
		"outputFormat": "Array",
		"propertyCode": ["totalpressure", "seawatertemperature"],
		"qualityControl": "clean",
		"resamplePeriod": null,
		"resampleType": null,
		"rowLimit": 100000,
		"sensorCategoryCodes": null,
        "sampleTimessensorsToInclude": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          34.303,
          34.3028
        ]
      },
      "sensorCategoryCode": "salinity",
      "sensorCode": "salinity",
      "sensorName": "Practical Salinity",
      "unitOfMeasure": "psu"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          27.334823592291514,
          27.33467289103237
        ]
      },
      "sensorCategoryCode": "sigma_t",
      "sensorCode": "sigmaT",
      "sensorName": "Sigma-t",
      "unitOfMeasure": "kg/m3"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          27.342687544595037,
          27.342536578750924
        ]
      },
      "sensorCategoryCode": "sigma_theta",
      "sensorCode": "SIGMA_THETA",
      "sensorName": "Sigma-theta (0 dbar)",
      "unitOfMeasure": "kg/m3"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          1482.157,
          1482.157
        ]
      },
      "sensorCategoryCode": "sound_speed",
      "sensorCode": "Sound_Speed",
      "sensorName": "Sound Speed",
      "unitOfMeasure": "m/s"
    },
    {
      "data": {
        "qaqcFlags": [
          1,
          1
        ],
        "sampleTimes": [
          "2019-02-16T00:40:37.316Z",
          "2019-02-16T00:40:38.323Z"
        ],
        "values": [
          2.932,
          2.9319
        ]
      },
      "sensorCategoryCode": "temperature",
      "sensorCode": "Temperature",
      "sensorName": "Temperature",
      "unitOfMeasure": "C"
    }
  ]
}

...

next.parameters

...

next.parameters.method

...

next.parameters.dateTo

...

"2019-02-16T02:00:00.010Z"

...

next.parameters.deviceCode

...

next.parameters.rowLimit

...

next.parameters.dateFrom

...

"2019-02-16T00:40:39.319Z"

...

next.parameters.token

...

next.url

...

"http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&dateTo=2019-02-16T02%3A00%3A00.010Z&deviceCode=SBECTD19p7027&rowLimit=2&dateFrom=2019-02-16T00%3A40%3A39.319Z&token=ffffffff-ffff-ffff-ffff-ffffffffffff"

...

"http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&token=ffffffff-ffff-ffff-ffff-ffffffffffff&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:06:26.028Z&dateTo=2019-02-16T02:00:00.010Z&rowLimit=2"

...

sensorData.data

...

sensorData.data.qaqcFlags

...

QAQC test results of each data point–guidelines for what each number means:

0 No quality control on data
1 Data passed all tests
2 Data probably good
3 Data probably bad. Failed minor tests
4 Data bad. Failed major tests
7 Averaged value
8 Interpolated value
9 Missing data

...

[1,1]

...

sensorData.data.sampleTimes

...

yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

...

"2019-02-16T00:40:37.316Z","2019-02-16T00:40:38.323Z"]

...

sensorData.data.values

...

[3.15891,3.15889]

...

sensorData.sensorCategoryCode

...

sensorData.sensorCode

...

Code of sensor, can be null

deprecated in favour of sensorCategoryCode

...

sensorData.sensorName

...

"Conductivity"

...

sensorData.unitOfMeasure

...

"S/m"

"original",
		"token": "TOKEN_HERE"
	},
	"queryUrl": "https://data.oceannetworks.ca/api/scalardata?locationCode=NCBC&deviceCategoryCode=BPR&dateFrom=2019-11-23T23%3A59%3A51.109Z&dateTo=2019-11-23T23%3A59%3A55.109Z&method=getByLocation&token=TOKEN_HERE&propertyCode=totalpressure,seawatertemperature",
	"sensorData": [{
		"actualSamples": 4,
		"data": {
			"qaqcFlags": [1, 1, 1, 1],
			"sampleTimes": ["2019-11-23T23:59:51.446Z", "2019-11-23T23:59:52.446Z", "2019-11-23T23:59:53.446Z", "2019-11-23T23:59:54.447Z"],
			"values": [410.1160345002942, 410.1155502316816, 410.12320424260855, 410.1133151942577]
		},
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Seafloor Pressure",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 4,
		"data": {
			"qaqcFlags": [1, 1, 1, 1],
			"sampleTimes": ["2019-11-23T23:59:51.446Z", "2019-11-23T23:59:52.446Z", "2019-11-23T23:59:53.446Z", "2019-11-23T23:59:54.447Z"],
			"values": [5.7701782267100015, 5.770633494259997, 5.770480759340003, 5.770225222070003]
		},
		"sensorCategoryCode": "temperature",
		"sensorCode": "Temperature",
		"sensorName": "Housing Temperature",
		"unitOfMeasure": "C"
	}, {
		"actualSamples": 4,
		"data": {
			"qaqcFlags": [1, 1, 1, 1],
			"sampleTimes": ["2019-11-23T23:59:51.446Z", "2019-11-23T23:59:52.446Z", "2019-11-23T23:59:53.446Z", "2019-11-23T23:59:54.447Z"],
			"values": [5.8714500185348575, 5.871427558955646, 5.871432050871547, 5.8714500185348575]
		},
		"sensorCategoryCode": "temperature2",
		"sensorCode": "temperature2",
		"sensorName": "P-Sensor Temperature",
		"unitOfMeasure": "C"
	}]
}

Anchor
getByDevice
getByDevice
getByDevice

Returns scalar data in JSON format by given device code.

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
deviceCode	String	Return raw data of a specific Device Code. Device Code must be valid. Specific Device Codes can be found by simply running the service without this parameter to get a list of all devices.	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). To discover the sensorCategoryCodes available, poll this service with returnOptions=excludeScalarData and check the sensorData response.	sensorCategoryCodes= pressure,borehole_pressure1,oxygen
dateFrom	String	Return raw data that has a timestamp on or after a specific date/time. Accepted DateTime formats: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended) yyyy-MM-dd (ISO 8601 Extended) PnYnMnDTnHnMnS (ISO 8601 Duration) If not specified, the default value is the beginning of time. DateTime is represented in Coordinated Universal Time (UTC). ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z). Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.	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: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended) yyyy-MM-dd (ISO 8601 Extended) PnYnMnDTnHnMnS (ISO 8601 Duration) If not specified, the default value is the end of time. DateTime is represented in Coordinated Universal Time (UTC). ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z). Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.	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: Array (default or if missing) (case insensitive) Data will be output as three arrays for a given device: a lineTypes array, a readings array, and a times array. Object (case insensitive) Data will be output as a list of objects for a given device. Inside each data object, there are lineType, scalarData, and sampleTime lists.	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: raw returns raw scalar data clean returns clean scalar data 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: avg gets the average value in each resamplePeriod avgMinMax gets the average, minimum, and maximum values in each resample period minMax gets the minimum and maximum values in each resample period 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: 1 (1 Second) 5 (5 Seconds) 10 (10 Seconds) 15 (15 Seconds) 30 (30 Seconds) 60 (1 Minute) 300 (5 Minutes) 600 (10 Minutes) 900 (15 Minutes) 1800 (30 Minutes) 3600 (1 Hour) 7200 (2 Hours) 14400 (4 Hours) 21600 (6 Hours) 43200 (12 Hours) 86400 (1 Day) 172800 (2 Days) 259200 (3 Days) 604800 (1 Week) 1209600 (2 Weeks) 2592000 (30 Days) '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
sensorsToInclude	string	accepted values: original returns scalar data from original sensors externallyDerived returns scalar data from externally derived sensors The default value when no sensorsToInclude have been provided is: sensorsToInclude=original. The sensorsToInclude=externallyDerived option requires that qualityControl either not be set or be set to qualityControl=clean, also the device supplied in with the deviceCode parameter must have externally derived sensors.	sensorsToInclude=original
returnOptions	string	accepted values: excludeScalarData When set to excludeScalarData the service response will not contain the sensordata.data field. This is useful for users interested in discovering sensorCategoryCodes and other metadata without having to wait for / handle data.	returnOptions=excludeScalarData

Response

Success (outputFormat = Array)

Code Block

language	js
title	Sample Response

{
	"next": {
		"parameters": {
			"method": "getByDevice",
			"dateTo": "2019-02-16T02:00:00.010Z",
			"deviceCode": "SBECTD19p7027",
			"rowLimit": "2",
			"dateFrom": "2019-02-16T00:40:41.643Z",
			"token": "TOKEN"
		},
		"url": "https://data.oceannetworks.ca/api/scalardata?method=getByDevice&dateTo=2019-02-16T02%3A00%3A00.010Z&deviceCode=SBECTD19p7027&rowLimit=2&dateFrom=2019-02-16T00%3A40%3A41.643Z&token=TOKEN"
	},
	"parameters": {
		"dateFrom": "2019-02-16T00:40:39.319Z",
		"dateTo": "2019-02-16T02:00:00.010Z",
		"deviceCode": "SBECTD19p7027",
		"fillGaps": true,
		"getLatest": false,
		"metaData": "Minimum",
		"method": "getByDevice",
		"outputFormat": "Array",
		"qualityControl": "clean",
		"resamplePeriod": null,
		"resampleType": null,
		"rowLimit": 2,
        "sensorsToInclude": "original",
		"token": "TOKEN"
	},
	"queryURL": "https://data.oceannetworks.ca/api/scalardata?method=getByDevice&dateTo=2019-02-16T02%3A00%3A00.010Z&deviceCode=SBECTD19p7027&rowLimit=2&dateFrom=2019-02-16T00%3A40%3A39.319Z&token=TOKEN",
	"sensorData": [{
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [3.28515, 3.28523]
		},
		"sensorCategoryCode": "conductivity",
		"sensorCode": "cond",
		"sensorName": "Conductivity",
		"unitOfMeasure": "S/m"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [1030.0017535948343, 1030.0013900365639]
		},
		"sensorCategoryCode": "density",
		"sensorCode": "density",
		"sensorName": "Density",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [649.54, 649.543]
		},
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Pressure",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [34.1337, 34.1334]
		},
		"sensorCategoryCode": "salinity",
		"sensorCode": "salinity",
		"sensorName": "Practical Salinity",
		"unitOfMeasure": "psu"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [27.00702584186911, 27.006664020993867]
		},
		"sensorCategoryCode": "sigma_t",
		"sensorCode": "sigmaT",
		"sensorName": "Sigma-t",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [27.01278012868579, 27.012419543747]
		},
		"sensorCategoryCode": "sigma_theta",
		"sensorCode": "SIGMA_THETA",
		"sensorName": "Sigma-theta (0 dbar)",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [1479.624, 1479.628]
		},
		"sensorCategoryCode": "sound_speed",
		"sensorCode": "Sound_Speed",
		"sensorName": "Sound Speed",
		"unitOfMeasure": "m/s"
	}, {
		"actualSamples": 3,
		"data": {
			"qaqcFlags": [1, 1],
			"sampleTimes": ["2019-02-16T00:40:39.644Z", "2019-02-16T00:40:40.643Z"],
			"values": [4.8362, 4.8373]
		},
		"sensorCategoryCode": "temperature",
		"sensorCode": "Temperature",
		"sensorName": "Temperature",
		"unitOfMeasure": "C"
	}]
}

Property	Type	Description	Example
parameters	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.
parameters.metadata	String	As passed into the original call	"minimum"
parameters.method	String	getByLocation, as passed into the original call.	"getByDevice"
parameters.dateTo	String	As passed into the original call	"2015-02-25T00:00:01.000Z"
parameters.rowLimit	String	As passed into the original call	"10"
parameters.locationCode	String	As passed into the original call	"NC27"
parameters.deviceCategoryCode	String	As passed into the original call	"CORK"
parameters.sensorCategoryCodes	String	As passed into the original call	"pressure"
parameters.dateFrom	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"
parameters.outputFormat	String	As passed into the original call	"object"
parameters.token	String	As passed into the original call	"ffffffff-ffff-ffff-ffff-ffffffffffff"
parameters.resamplePeriod	String	As passed into the original call	15
parameters.resampleType	String	As passed into the original call	avg
parameters.qualityControl	String	As passed into the original call	clean
parameters.dataGaps	Boolean	As passed into the original call	false
parameters.sensorsToInclude	String	As passed into the original call	original
next	Object	An object containing information on how to make a scalardata 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.
next.parameters	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.
next.parameters.method	String	getByDevice, as passed into the original call.	`"getByDevice"`
next.parameters.dateTo	String	As passed into the original call	"`2019-02-16T02:00:00.010Z`"
next.parameters.deviceCode	String	As passed into the original call	`"SBECTD19p7027`"
next.parameters.rowLimit	String	As passed into the original call	"`2`"
next.parameters.dateFrom	String	This is set to 1 millisecond more than the date of the last reading sent in the current call.	`"2019-02-16T00:40:39.319Z"`
next.parameters.token	String	As passed into the original call	"ffffffff-ffff-ffff-ffff-ffffffffffff"
next.parameters.sensorsToInclude	String	As passed into the original call	original
next.url	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=getByDevice&dateTo=2019-02-16T02%3A00%3A00.010Z&deviceCode=SBECTD19p7027&rowLimit=2&dateFrom=2019-02-16T00%3A40%3A39.319Z&token=ffffffff-ffff-ffff-ffff-ffffffffffff"`
queryUrl	String	URL of current query	`"https://data.oceannetworks.ca/api/scalardata?method=getByDevice&token=ffffffff-ffff-ffff-ffff-ffffffffffff&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:06:26.028Z&dateTo=2019-02-16T02:00:00.010Z&rowLimit=2"`
sensorData	Array of objects	Data sets returned for all applicable sensors
sensorData.data	Object	Data sets returned for a single sensor
sensorData.data.qaqcFlags	Array of integers	QAQC test results of each data point–guidelines for what each number means: 0 No quality control on data 1 Data passed all tests 2 Data probably good 3 Data probably bad. Failed minor tests 4 Data bad. Failed major tests 7 Averaged value 8 Interpolated value 9 Missing data	`[1,1]`
sensorData.data.sampleTimes	Array of strings	Sampling times of sensor data returned, formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'	`"2019-02-16T00:40:37.316Z","2019-02-16T00:40:38.323Z"]`
sensorData.data.values	Array of doubles	Values of sensor data returned, units of measurement are given in sensorData.unitOfMeasure	`[3.15891,3.15889]`
sensorData.data.min	Array of doubles	only in the response if min values are part of the resampleType. The array contains the minimum scalar data value in each resample period. Units of measurement are given in sensorData.unitOfMeasure.	[2706.1145305467917]
sensorData.data.max	Array of doubles	only in the response if max values are part of the resampleType. The array contains the maximum scalar data value in each resample period. Units of measurement are given in sensorData.unitOfMeasure.	[2706.1145305467917]
sensorData.data.counts	Array of Integers	only in the response if a resample period is selected. contains the count of samples in each period	[3600]
sensorData.actualSamples	String	the number of scalar data values returned excluding any NaN values	48
sensorData.sensorCategoryCode	String	Code of sensor, can be null	`"conductivity"`
sensorData.sensorCode	String	Code of sensor, can be null deprecated in favour of sensorCategoryCode	`"cond"`
sensorData.sensorName	String	Name that denotes what the sensor measures	`"Conductivity"`
sensorData.unitOfMeasure	String	Unit of measurement or "NA" if none apply; temperature units of measure are "C" for degrees Celsius	`"S/m"`

Failure

See External Web Services Standards: Error Messaging.

Example (outputFormat object)

https://data.oceannetworks.ca/api/scalardata?method=getByDevice&token=TOKEN&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:05:26.028Z&dateTo=2019-02-16T00:05:29.010Z&outputFormat=object

Code Block

language	js

{
	"next": null,
	"parameters": {
		"dateFrom": "2019-02-16T00:05:26.028Z",
		"dateTo": "2019-02-16T00:05:29.010Z",
		"deviceCode": "SBECTD19p7027",
		"fillGaps": true,
		"getLatest": false,
		"metaData": "Minimum",
		"method": "getByDevice",
		"outputFormat": "object",
		"qualityControl": "clean",
		"resamplePeriod": null,
		"resampleType": null,
		"rowLimit": 100000,
        "sensorsToInclude": "original",
		"token": "TOKEN"
	},
	"queryURL": "https://data.oceannetworks.ca/api/scalardata?method=getByDevice&token=TOKEN&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:05:26.028Z&dateTo=2019-02-16T00:05:29.010Z&outputFormat=object",
	"sensorData": [{
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 3.28074
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 3.28092
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 3.28085
		}],
		"sensorCategoryCode": "conductivity",
		"sensorCode": "cond",
		"sensorName": "Conductivity",
		"unitOfMeasure": "S/m"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 1030.0199905691406
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 1030.0181011515497
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 1030.0167458438395
		}],
		"sensorCategoryCode": "density",
		"sensorCode": "density",
		"sensorName": "Density",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 649.402
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 649.405
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 649.404
		}],
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Pressure",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 34.1474
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 34.1456
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 34.144
		}],
		"sensorCategoryCode": "salinity",
		"sensorCode": "salinity",
		"sensorName": "Practical Salinity",
		"unitOfMeasure": "psu"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 27.02498738577401
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 27.02313407261704
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 27.021786323347214
		}],
		"sensorCategoryCode": "sigma_t",
		"sensorCode": "sigmaT",
		"sensorName": "Sigma-t",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 27.03067026862732
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 27.02882094005463
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 27.027473586958195
		}],
		"sensorCategoryCode": "sigma_theta",
		"sensorCode": "SIGMA_THETA",
		"sensorName": "Sigma-theta (0 dbar)",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 1479.38
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 1479.393
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 1479.394
		}],
		"sensorCategoryCode": "sound_speed",
		"sensorCode": "Sound_Speed",
		"sensorName": "Sound Speed",
		"unitOfMeasure": "m/s"
	}, {
		"actualSamples": 3,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:26.610Z",
			"value": 4.773
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:27.616Z",
			"value": 4.7768
		}, {
			"qaqcFlag": 1,
			"sampleTime": "2019-02-16T00:05:28.611Z",
			"value": 4.7775
		}],
		"sensorCategoryCode": "temperature",
		"sensorCode": "Temperature",
		"sensorName": "Temperature",
		"unitOfMeasure": "C"
	}]
}

Example (getLatest)

Code Block

language	js

{
	"next": {
		"parameters": {
			"getLatest": "true",
			"method": "getByDevice",
			"dateTo": "2019-02-16T00:06:26.612Z",
			"deviceCode": "SBECTD19p7027",
			"rowLimit": "5",
			"dateFrom": "2019-02-16T00:06:26.028Z",
			"token": "TOKEN"
		},
		"url": "https://data.oceannetworks.ca/api/scalardata?getLatest=true&method=getByDevice&dateTo=2019-02-16T00%3A06%3A26.612Z&deviceCode=SBECTD19p7027&rowLimit=5&dateFrom=2019-02-16T00%3A06%3A26.028Z&token=TOKEN"
	},
	"parameters": {
		"dateFrom": "2019-02-16T00:06:26.028Z",
		"dateTo": "2019-02-16T00:59:54.321Z",
		"deviceCode": "SBECTD19p7027",
		"fillGaps": true,
		"getLatest": true,
		"metaData": "Minimum",
		"method": "getByDevice",
		"outputFormat": "Array",
		"qualityControl": "clean",
		"resamplePeriod": null,
		"resampleType": null,
		"rowLimit": 5,
        "sensorsToInclude": "original",
		"token": "TOKEN"
	},
	"queryURL": "https://data.oceannetworks.ca/api/scalardata?getLatest=true&method=getByDevice&dateTo=2019-02-16T00%3A59%3A54.321Z&deviceCode=SBECTD19p7027&rowLimit=5&dateFrom=2019-02-16T00%3A06%3A26.028Z&token=TOKEN",
	"sensorData": [{
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [3.28094, 3.28063, 3.28071, 3.2808, 3.2809]
		},
		"sensorCategoryCode": "conductivity",
		"sensorCode": "cond",
		"sensorName": "Conductivity",
		"unitOfMeasure": "S/m"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [1030.0203515299559, 1030.0177887041705, 1030.0175815192931, 1030.0170878468855, 1030.0174763727805]
		},
		"sensorCategoryCode": "density",
		"sensorCode": "density",
		"sensorName": "Density",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [649.402, 649.405, 649.402, 649.402, 649.403]
		},
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Pressure",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [34.1481, 34.1448, 34.1447, 34.1443, 34.1449]
		},
		"sensorCategoryCode": "salinity",
		"sensorCode": "salinity",
		"sensorName": "Practical Salinity",
		"unitOfMeasure": "psu"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [27.025374920940294, 27.022779129870287, 27.02259908664587, 27.022125064394686, 27.022522746984805]
		},
		"sensorCategoryCode": "sigma_t",
		"sensorCode": "sigmaT",
		"sensorName": "Sigma-t",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [27.03105972530443, 27.028462887967407, 27.028283837275467, 27.0278113399836, 27.02820999845312]
		},
		"sensorCategoryCode": "sigma_theta",
		"sensorCode": "SIGMA_THETA",
		"sensorName": "Sigma-theta (0 dbar)",
		"unitOfMeasure": "kg/m3"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [1479.387, 1479.382, 1479.386, 1479.391, 1479.395]
		},
		"sensorCategoryCode": "sound_speed",
		"sensorCode": "Sound_Speed",
		"sensorName": "Sound Speed",
		"unitOfMeasure": "m/s"
	}, {
		"actualSamples": 6,
		"data": {
			"qaqcFlags": [1, 1, 1, 1, 1],
			"sampleTimes": ["2019-02-16T00:06:31.611Z", "2019-02-16T00:06:30.611Z", "2019-02-16T00:06:29.611Z", "2019-02-16T00:06:28.616Z", "2019-02-16T00:06:27.611Z"],
			"values": [4.7745, 4.7743, 4.7752, 4.7766, 4.7773]
		},
		"sensorCategoryCode": "temperature",
		"sensorCode": "Temperature",
		"sensorName": "Temperature",
		"unitOfMeasure": "C"
	}]
}

Example (resamplePeriod)

Code Block

language	js

{
	"next": null,
	"parameters": {
		"dateFrom": "2019-11-23T23:50:00.000Z",
		"dateTo": "2019-11-24T00:00:00.109Z",
		"deviceCode": "BPR-Folger-59",
		"fillGaps": true,
		"getLatest": false,
		"metaData": "Minimum",
		"method": "getByDevice",
		"outputFormat": "Array",
		"qualityControl": "clean",
		"resamplePeriod": 600,
		"resampleType": "avgMinMax",
		"rowLimit": 100000,
        "sensorsToInclude": "original",
		"token": "TOKEN"
	},
	"queryURL": "https://data.oceannetworks.ca/api/scalardata?deviceCode=BPR-Folger-59&dateFrom=2019-11-23T23%3A50%3A00.000Z&dateTo=2019-11-24T00%3A00%3A00.109Z&method=getByDevice&token=TOKEN&resamplePeriod=600",
	"sensorData": [{
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [18224.00060185185],
			"min": [18223.993668981482],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [18223.99713541667]
		},
		"sensorCategoryCode": "clock",
		"sensorCode": "clock",
		"sensorName": "Instrument Clock",
		"unitOfMeasure": "Gregorian days since 19700101T000000Z"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.016661775226793907],
			"min": [-0.018115118449031797],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [7.484659961238549E-4]
		},
		"sensorCategoryCode": "dart_pressure_residual",
		"sensorCode": "dart_pressure_residual",
		"sensorName": "DART Pressure Residual",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.0],
			"min": [0.0],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [0.0]
		},
		"sensorCategoryCode": "direct_detider_weighted_threshold",
		"sensorCode": "Direct_Detider_Weighted_Threshold",
		"sensorName": "Direct Detider Weighted Threshold",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.0],
			"min": [0.0],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [0.0]
		},
		"sensorCategoryCode": "kurtosis_weighted_threshold",
		"sensorCode": "Kurtosis_Weighted_Threshold",
		"sensorName": "Kurtosis Weighted Threshold",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [410.1353110066574],
			"min": [410.1012234744143],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [410.1182347632783]
		},
		"sensorCategoryCode": "pressure",
		"sensorCode": "Pressure",
		"sensorName": "Seafloor Pressure",
		"unitOfMeasure": "decibar"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.004869102302980243],
			"min": [-0.006169526778020364],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [-5.749410881530408E-7]
		},
		"sensorCategoryCode": "rayleigh_detector",
		"sensorCode": "Rayleigh_Detector",
		"sensorName": "Seismic Detector",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [1.2691588039586816],
			"min": [0.8568423943177923],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [1.0578961478264164]
		},
		"sensorCategoryCode": "rayleigh_signal_to_noise_ratio",
		"sensorCode": "Rayleigh_Signal_To_Noise_Ratio",
		"sensorName": "Seismic Signal to Noise Ratio",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.0],
			"min": [0.0],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [0.0]
		},
		"sensorCategoryCode": "rayleigh_weighted_threshold",
		"sensorCode": "Rayleigh_Weighted_Threshold",
		"sensorName": "Seismic Threshold",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [1.0617238224810472],
			"min": [0.7387132597606645],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [0.8750975631784089]
		},
		"sensorCategoryCode": "sta_lta_ratio",
		"sensorCode": "STA_LTA_Ratio",
		"sensorName": "Signal to Noise Ratio",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.0],
			"min": [0.0],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [0.0]
		},
		"sensorCategoryCode": "sta_lta_ratio_weighted_threshold",
		"sensorCode": "STA_LTA_Ratio_Weighted_Threshold",
		"sensorName": "Signal to Noise Ratio Weighted Threshold",
		"unitOfMeasure": "NA"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [5.772419317939999],
			"min": [5.769990245270002],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [5.771207405512597]
		},
		"sensorCategoryCode": "temperature",
		"sensorCode": "Temperature",
		"sensorName": "Housing Temperature",
		"unitOfMeasure": "C"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [5.872855986721493],
			"min": [5.871409591291745],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [5.872147522737963]
		},
		"sensorCategoryCode": "temperature2",
		"sensorCode": "temperature2",
		"sensorName": "P-Sensor Temperature",
		"unitOfMeasure": "C"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [3.1184035054379855],
			"min": [2.9657060692477186],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [3.0259129890276735]
		},
		"sensorCategoryCode": "warn_kurtosis",
		"sensorCode": "WARN_Kurtosis",
		"sensorName": "WARN Kurtosis",
		"unitOfMeasure": "NA"
	},

Failure

See External Web Services Standards: Error Messaging.

Example (outputFormat object)

http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&token=ffffffff-ffff-ffff-ffffffffffff&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:05:26.028Z&dateTo=2019-02-16T01:00:00.010Z&outputFormat=object

Code Block

language	js

{
   "next": null,
   "queryURL": "http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&token=ffffffff-ffff-ffff-ffff-ffffffffffff&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:05:26.028Z&dateTo=2019-02-17T00:00:00.010Z&outputFormat=object",
   "sensorData": [
       {
         "data": [
            {
               "qaqcFlag": 1,
               "sampleTime": "2019-02-16T00:40:37.316Z",
                "value": 3.15891
           },
          {
             "qaqcFlag": 1,
             "sampleTime": "2019-02-16T00:40:38.323Z",
             "value": 3.15889
          },
         {
             "qaqcFlag": 1,
             "sampleTime": "2019-02-16T00:40:39.319Z",
             "value": 3.15891
         },

         ],
        "sensorCategoryCode": "temperature",
        "sensorCode": "Temperature",
        "sensorName": "Temperature",
        "unitOfMeasure": "C"

      }

  ]

}

Example (getLatest)

Code Block

language	js

{
  "next": {
    "parameters": {
      "getLatest": "true",
      "method": "getByDevice",
      "dateTo": "2019-02-16T00:59:54.321Z",
      "deviceCode": "SBECTD19p7027",
      "rowLimit": "5",
      "dateFrom": "2019-02-16T00:06:26.028Z",
      "token": "ffffffff-ffff-ffff-ffff-ffffffffffff"
    },
    "url": "http://127.0.0.1:8080/dmas/api/scalardata?getLatest=true&method=getByDevice&dateTo=2019-02-16T00%3A59%3A54.321Z&deviceCode=SBECTD19p7027&rowLimit=5&dateFrom=2019-02-16T00%3A06%3A26.028Z&token=ffffffff-ffff-ffff-ffff-ffffffffffff"
  },
  "queryURL": "http://127.0.0.1:8080/dmas/api/scalardata?method=getByDevice&token=ffffffff-ffff-ffff-ffff-ffffffffffff&deviceCode=SBECTD19p7027&dateFrom=2019-02-16T00:06:26.028Z&dateTo=2019-02-16T01:00:00.010Z&getLatest=true&rowLimit=5",
  "sensorData": [
    {
      "data": {
        "qaqcFlags": [
          1,
          1,
          1,
          1,
          1
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          3.15887,
          3.15889,
          3.15887,
          3.15887,
          3.15887
        ]
      },
      "sensorCategoryCode": "conductivity",
      "sensorCode": "cond",
      "sensorName": "Conductivity",
      "unitOfMeasure": "S/m"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4,
          4,
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          1033.216109844531,
          1033.2163281809346,
          1033.2162239082807,
          1033.2161554700383,
          1033.2160189481963
        ]
      },
      "sensorCategoryCode": "density",
      "sensorCode": "density",
      "sensorName": "Density",
      "unitOfMeasure": "kg/m3"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4,
          4,
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          1271.616,
          1271.612,
          1271.641,
          1271.626,
          1271.636
        ]
      },
      "sensorCategoryCode": "pressure",
      "sensorCode": "Pressure",
      "sensorName": "Pressure",
      "unitOfMeasure": "decibar"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4,
          4,
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          34.3026,
          34.3029,
          34.3026,
          34.3026,
          34.3024
        ]
      },
      "sensorCategoryCode": "salinity",
      "sensorCode": "salinity",
      "sensorName": "Practical Salinity",
      "unitOfMeasure": "psu"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4,
          4,
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          27.334513191219912,
          27.334752740942577,
          27.334513191219912,
          27.334513191219912,
          27.334335494507968
        ]
      },
      "sensorCategoryCode": "sigma_t",
      "sensorCode": "sigmaT",
      "sensorName": "Sigma-t",
      "unitOfMeasure": "kg/m3"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4,
          4,
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          27.342376762326467,
          27.342616416723104,
          27.342376937935114,
          27.342376832569926,
          27.34219951187515
        ]
      },
      "sensorCategoryCode": "sigma_theta",
      "sensorCode": "SIGMA_THETA",
      "sensorName": "Sigma-theta (0 dbar)",
      "unitOfMeasure": "kg/m3"
    },
    {
      "data": {
        "qaqcFlags": [
          4,
          4,
          4,
          4,
          4
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          1482.157,
          1482.157,
          1482.157,
          1482.157,
          1482.157
        ]
      },
      "sensorCategoryCode": "sound_speed",
      "sensorCode": "Sound_Speed",
      "sensorName": "Sound Speed",
      "unitOfMeasure": "m/s"
    },
    {
      "data": {
        "qaqcFlags": [
          1,
          1,
          1,
          1,
          1
        ],
        "sampleTimes": [
          "2019-02-16T00:59:59.329Z",
          "2019-02-16T00:59:58.317Z",
          "2019-02-16T00:59:57.318Z",
          "2019-02-16T00:59:56.320Z",
          "2019-02-16T00:59:55.322Z"
        ],
        "values": [
          2.9319,
          2.9319,
          2.9319,
          2.9319,
          2.9321
        ]
      },
      "sensorCategoryCode": "temperature",
      "sensorCode": "Temperature",
      "sensorName": "Temperature",
      "unitOfMeasure": "C"
    }
  ]
}

...

Response

Success

Expand
Returns scalar data in JSON format by given station code and device category code. Parameters
Parameter	Type	Description	Example
Required
token	string	credential token in GUID format	YOUR_TOKEN_HERE
station	string	the code of a station	NCBC
deviceCategory	string	the code of a device category	BPR
Optional
sensors	string	a comma separated list of sensor code name. If missing, the system will return all search scalar data within the station code and device category 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 a 24-hour range.	2015-05-26T00:00:00.000Z
metadata	String	Minimum (default or if missing) (case insensitive) provides only basic property information Full (case insensitive) provides all property information metadata is for the latest deployment overlapping dateFrom and dateTo or, if no dates specified, the latest deployment overall	Minimum
outputFormat	String	Object (default or if missing) (case insensitive) data will be output as a list of objects for a given sensor. Inside each data object, there are sampleTime, value, and qaqcFlag Array (case insensitive) data will be out put as three arrays for a given sensor. Array of sampleTime, array of values, array of qaqcFlags	Object
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

Code Block

language	javascript
title	Sample <responseType> Response

{
    "metadata": {
        "bbox": {
			"maxDepth": double,
			"maxLat": double,
			"maxLon": double,
			"minDepth": double,
			"minLat": double,
			"minLon": double
		},
        "dateFrom": string,
        "dateTo": string,
        "depth": double,
        "deviceCategoryName": string,
        "latitude": double,
        "longitude": double,
        "stationName": string
	},
	"sensorData": [
		{
			"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]
	 			},
				...
			],
			"sensor": string,
            "sensorName": string,
            "unitOfMeasure": string
		},
		...
	],
	"serviceMetadata": {
		"dateFrom": string,
        "dateTo": string,
        "deviceCategory": string,
        "metadata": string,
		"nextDateFrom": string,
		"outputFormat": string,
        "rowLimit": string,
		"sensors": string,
    	"station": string,
		"totalActualSamples": integer
	}
}

PropertyTypeDescriptionOptionNotesserviceMetadatajson objectmeta data information of the web service request.metadata=minimumserviceMetadata.stationstringrequested station codemetadata=minimumserviceMetadata.deviceCategorystringrequested device category codemetadata=minimumserviceMetadata.sensorsstringCSV searchable sensor code namesmetadata=minimumserviceMetadata.dateFromstringrequested date from in yyyy-MM-ddTHH:mm:ss.SSSZ formatmetadata=minimumserviceMetadata.dateTostringrequested date to in yyyy-MM-ddTHH:mm:ss.SSSZ formatmetadata=minimumserviceMetadata.metadatastringrequested metadata optionmetadata=minimumserviceMetadata.rowLimitintegerrequested row limit per sensor code namemetadata=minimumserviceMetadata.outputFormatstringthe requested data output formatmetadata=minimumserviceMetadata.totalActualSamplesintegerhow many scalar data expected in total for all the sensorsmetadata=minimumserviceMetadata.nextDateFromstringthe date from for next reading in yyyy-MM-ddTHH:mm:ss.SSSZ formatmetadata=minimummetadatajson objectmetadata station and device informationmetadata=fullmetadata.stationNamestringstation name for the given station codemetadata=fullmetadata.deviceCategoryNamestringdevice category name for the given category codemetadata=fullmetadata.dateFromstringthe date from for a given deployment in yyyy-MM-ddTHH:mm:ss.SSSZ formatmetadata=fullmetadata.dateTostringthe date to for a given deployment in yyyy-MM-ddTHH:mm:ss.SSSZ formatmetadata=fullmetadata.longitude

double

the aggregate (mean) longitude of the station.metadata=fullmetadata.latitude

double

the aggregate (mean) latitude of the station.metadata=fullmetadata.depth

double

the aggregate (mean) depth of the station.metadata=fullmetadata.bboxjson objectthe boundary of the station boxmetadata=fullmetadata.bbox.minLondoublethe minimum longitude of the station.metadata=fullmetadata.bbox.maxLondoublethe maximum longitude of the station.metadata=fullmetadata.bbox.minLatdoublethe minimum latitude of the station.metadata=fullmetadata.bbox.maxLatdoublethe maximum latitude of the station.metadata=fullmetadata.bbox.minDepthdoublethe minimum depth of the station.metadata=fullmetadata.bbox.maxDepthdoublethe maximum depth of the station.metadata=fullsensorDataarrayall available scalar data for given time range within the row limitmetadata=minimumsensorData.sensorstringsensor code name for a given sensormetadata=minimumsensorData.sensorNamestringsensor full name for a given sensormetadata=minimumsensorData.unitOfMeasurestringunit of measure name for the scalar readingmetadata=minimumsensorData.actualSamplesintegernumber of samples for that sensorDatametadata=minimumsensorData.dataarraysensor data for a given sensoroutputFormat=objectsensorData.data.sampleTimestringtime stamp of the reading in yyyy-MM-ddTHH:mm:ss.SSSZ formatoutputFormat=objectsensorData.data.valuedoublescalar reading after calibration, derivation and unit conversionoutputFormat=objectsensordata.data.qaqcFlagintegerQAQC flagoutputFormat=objectsensorData.datajson objectsensor data for a given sensoroutputFormat=arraysensorData.data.sampleTimesarrayan array of time stamp of the reading in yyyy-MM-ddTHH:mm:ss.SSSZ formatoutputFormat=arraysensorData.data.valuesarrayan array of scalar reading after calibration, derivation and unit conversionoutputFormat=arraysensorData.data.qaqcFlagsarrayan array of QAQC flagsoutputFormat=array

Note: If the value is null, this may be displayed in the resulting JSON as a null.

Example

https://data.oceannetworks.ca/api/scalardata?method=getByStation&token=YOUR_TOKEN_HERE&station=SCHDW.O1&deviceCategory=OXYSENSOR

Code Block{ "sensorData": [

{
		"actualSamples": 1,
		"data":

[

{
			"

qaqcFlag

counts":

0

[600],
			"

sampleTime

max":

"2015-08-20T17:30:53.058Z"

[0.0],
			"

value

min":

23.4859 }

[0.0],
			"

sensor

qaqcFlags":

"Temperature"

[7],
			"

sensorName

sampleTimes":

"Temperature"

["2019-11-23T23:50:00.000Z"],
			"

unitOfMeasure

values":

"C"

[0.0]
		},

{

actualSamples

sensorCategoryCode":

1

"warn_watcher",
		"

data

sensorCode":

[{ "qaqcFlag": 1

"WARN_Watcher",

sampleTime

sensorName": "

2015-08-20T17:30:53.058Z

WARN Watcher",

value

unitOfMeasure":

4.417862252

"NA"
	}

]

, {
		"

sensor

actualSamples":

"oxygen"

1,
		"

sensorName

data":

"Oxygen",

{
			"

unitOfMeasure

counts":

"ml/l" }

[600],
			"

serviceMetadata

max":

{

[0.0],
			"

dateFrom

min":

null

[0.0],
			"

dateTo

qaqcFlags":

null

[7],
			"

deviceCategory

sampleTimes":

"OXYSENSOR"

["2019-11-23T23:50:00.000Z"],
			"

nextDateFrom

values":

null,

[0.0]

"outputFormat": null

},
		"

rowLimit

sensorCategoryCode":

null

"warn_watcher_weighted_threshold",
		"

sensors

sensorCode":

null

"WARN_Watcher_Weighted_Threshold",
		"

station

sensorName": "

SCHDW.O1

WARN Watcher Weighted Threshold",
		"

totalActualSamples

unitOfMeasure":

2

"NA"
	}]
}

Page tree

Versions Compared

Old Version 26

New Version Current

Key

Parameters

Success

Response

Success

Example

Example with outputFormat option

Example

Parameters

Example with outputFormat option

Example with resamplePeriod option

Response

Success (outputFormat = Array)

Example with multiple property codes option

Anchor
getByDevice
getByDevice
getByDevice

Parameters

Response

Success (outputFormat = Array)

Failure

Example (outputFormat object)

Example (getLatest)

Example (resamplePeriod)

Failure

Example (outputFormat object)

Example (getLatest)

Response

Success

Parameters

Example

Page tree

Page History

Versions Compared

Old Version 26

New Version Current

Key

Parameters

Success

Response

Success

Example

Example with outputFormat option

Example

Parameters

Example with outputFormat option

Example with resamplePeriod option

Response

Success (outputFormat = Array)

Example with multiple property codes option

AnchorgetByDevicegetByDevicegetByDevice

Parameters

Response

Success (outputFormat = Array)

Failure

Example (outputFormat object)

Example (getLatest)

Example (resamplePeriod)

Failure

Example (outputFormat object)

Example (getLatest)

Parameters

Response

Success

Example

Anchor
getByDevice
getByDevice
getByDevice