Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
{
	"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"
	}, {
		"actualSamples": 1,
		"data": {
			"counts": [600],
			"max": [0.0],
			"min": [0.0],
			"qaqcFlags": [7],
			"sampleTimes": ["2019-11-23T23:50:00.000Z"],
			"values": [0.0]
		},
		"sensorCategoryCode": "warn_watcher",
		"sensorCode": "WARN_Watcher",
		"sensorName": "WARN Watcher",
		"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": "warn_watcher_weighted_threshold",
		"sensorCode": "WARN_Watcher_Weighted_Threshold",
		"sensorName": "WARN Watcher Weighted Threshold",
		"unitOfMeasure": "NA"
	}]
}

...

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

Parameters

...

YOUR_TOKEN_HERE

...

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

...

Object (default or if missing)  (case insensitive)

...

Array  (case insensitive)
data will be out put as three arrays for a given sensor. Array of sampleTime, array of values, array of qaqcFlags

...

Response

Success

Code Block
languagejavascript
titleSample <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
	}
}

...

double

...

double

...

double

...

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": 0,
			"sampleTime": "2015-08-20T17:30:53.058Z",
			"value": 23.4859
		}],
		"sensor": "Temperature",
		"sensorName": "Temperature",
		"unitOfMeasure": "C"
	}, {
		"actualSamples": 1,
		"data": [{
			"qaqcFlag": 1,
			"sampleTime": "2015-08-20T17:30:53.058Z",
			"value": 4.417862252
		}],
		"sensor": "oxygen",
		"sensorName": "Oxygen",
		"unitOfMeasure": "ml/l"
	}],
	"serviceMetadata": {
		"dateFrom": null,
		"dateTo": null,
		"deviceCategory": "OXYSENSOR",
		"nextDateFrom": null,
		"outputFormat": null,
		"rowLimit": null,
		"sensors": null,
		"station": "SCHDW.O1",
		"totalActualSamples": 2
	}
}