Page History

Table of Contents

Description

The API dataProducts service returns all the data products defined in DMAS Oceans 3.0 that meet a filter criteria.

Data Products are downloadable representations of ONC observation observational data, provided in formats that can be easily ingested by analytical or visualization software.

The primary purpose of this service is to identify which Data Products and Formats (file extensions) are available for the Locations, Devices, Device Categories or Properties of interest and use . Use the dataProductCode and extension when requesting a data product using via the dataProductDelivery web service.

See the External Web Services for method, token, and responseType usage and error messages.

URL

No Format
httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts

Method	Description	Example
get	Retrieve a list Data Products codes	`method=get`

get

The get method retrieves a list of Data Product codes

Parameters

Parameter	Type	Description	Example
Required


token	string

All

ll Web Services require a token

. This can be generated at http

. Once logged in at https://data.oceannetworks.ca/login, your token can be retrieved or generated at https://

dmas

data.

uvic

oceannetworks.ca/Profile .

Click

Click on the "Web Services" tab

and

, then click "Generate Token".

token=

5ba514e8-1203-428c-8835-879c8173e387

Optional
YOUR_TOKEN_HERE


dataProductCode	string	Return all

of the

Data Product Extensions matching a specific Data Product Code.

Data Product Code must be valid

and match exactly, including case

.	dataProductCode=annotationfile
extension	string	Return all

of the

Data Products that have a

specific

specific File Extension.

Extension must be valid and match exactly, including case.

extension=csv

dataProductName

string

Return all

of the

Data Products where the Data Product Name contains a keyword.

Data Product Name

Filter is

Not

not case sensitive

Contains

, treating time, Time and TIME as the same word.
Filter will find partial words. The filter dataProductName=time returns "Time Series Scalar Data", "Time Series Scalar Profile Plot", "Nortek Time Series", "ASL Acoustic Profiler Time Series" and more.

dataProductName=

Annotation

time
locationCode	string	Return all

of the

Data Products

that are

available for a specific Location.

Location Code must be valid

and match exactly, including case

. Specific Location Codes can be obtained using the locations service.	locationCode=BACAX
deviceCategoryCode	string	Return all

of the

Data Products

that are

available for devices belonging to a specific Device Category.

Device Category Code must be valid

and match exactly, including case

. Specific Device Category Codes can be obtained using the deviceCateogries service.	deviceCategoryCode=ADCP2MHZ
deviceCode	string	Return all Data Products

that are

available for a specific Device.

Device Code must be valid

and match exactly, including case

. Specific Device Codes can be obtained from the devices service.	deviceCode=AandOpt0581
propertyCode	string	Return all

of the

Data Products

that are

available for a specific Property.

Property Code must be valid

and match exactly, including case

.
Specific Property Codes can be obtained using the properties service.

propertyCode=airdensity

Response

Example for request httprequest https://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53&deviceCategoryCode=CTD&locationCode=BACAX[YOUR_TOKEN_HERE]&dataProductCode=HSD&extension=png

Success (HTTP 200)

Returns a list of data product extensions with values for Data Product Code, Data Product Name, Extension and Help Document URL, ordered alphabetically by Data Product Code

...

[
{
"dataProductCode": "

AF

HSD",
"dataProductName": "

Annotation File","extension":"an","helpDocument":

Hydrophone Spectral Data",
"dataProductOptions": [
{
"allowableRange": null,
"allowableValues": [
"All",
"LF",
"HF"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

89"}, {"dataProductCode":"LF","dataProductName":"Log File","extension":"txt","helpDocument":

Hydrophone+Data+Acquisition+and+Diversion+Mode"
],
"option": "dpo_hydrophoneAcquisitionMode",
"suboptions": null
},
{
"allowableRange": null,
"allowableValues": [
"All",
"H1",
"H2",
"H3"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

4"}

Hydrophone+Channel"
],

{

"

dataProductCode

option": "

MSQAQCR

dpo_hydrophoneChannel",
"

dataProductName

suboptions":

"Manual Scalar QAQC Results","extension":"qaqc","helpDocument":

null
},
{
"allowableRange": null,
"allowableValues": [
"All",
"LPF",
"OD",
"HPF"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

106"

Hydrophone+Data+Acquisition+and+Diversion+Mode"
],
"option": "dpo_hydrophoneDataDiversionMode",
"suboptions": null
},
{
"allowableRange": {

"dataProductCode":"SBCTDRF","dataProductName":"Sea-Bird CTD Raw Files","extension":"hex","helpDocument":

"lowerBound": "-160",
"onlyIntegers": false,
"unitOfMeasure": null,
"upperBound": "140"
},
"allowableValues": [
"-1000"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

78"

Spectrogram+Plot+Options"
],
"option": "dpo_lowerColourLimit",
"suboptions": null
},
{

"dataProductCode":"TSSCP","dataProductName":"Time Series Staircase Plot","extension":"pdf","helpDocument":

"allowableRange": null,
"allowableValues": [
"0",
"1",
"2",
"3",
"4",
"5"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

21"}

Spectrogram+Plot+Options"
],

{

"

dataProductCode

option": "

TSSCP

dpo_spectrogramColourPalette",
"

dataProductName

suboptions":

"Time Series Staircase Plot","extension":"png","helpDocument":

null
},
{
"allowableRange": null,
"allowableValues": [
"Adjacent",
"Daily",
"Weekly",
"None"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

21"},

{"dataProductCode":"TSSD","dataProductName":"Time Series Scalar Data","extension":"json","helpDocument":"https://wiki.oceannetworks.ca/display/DP/1"},

{"dataProductCode":"TSSD","dataProductName":"Time Series Scalar Data","extension":"csv","helpDocument":

Spectrogram+Concatenation"
],
"option": "dpo_spectrogramConcatenation",
"suboptions": null
},
{
"allowableRange": {
"lowerBound": "100",
"onlyIntegers": true,
"unitOfMeasure": "Hz",
"upperBound": "500000"
},
"allowableValues": [
"-1",
"1000",
"10000"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

1"}

Spectrogram+Plot+Options"
],

{

"

dataProductCode

option": "

TSSD

dpo_spectrogramFrequencyUpperLimit",
"

dataProductName

suboptions":

"Time Series Scalar Data","extension":"mat","helpDocument":

null
},
{
"allowableRange": null,
"allowableValues": [
"WAVFLAC",
"FFT",
"MIX"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

1"}

Spectrogram+Source"
],

{

"

dataProductCode

option": "

TSSD

dpo_spectrogramSource",
"

dataProductName

suboptions":

"Time Series Scalar Data","extension":"txt","helpDocument":"https://wiki.oceannetworks.ca/display/DP/1"}, {"dataProductCode":"TSSP","dataProductName":"Time Series Scalar Plot","extension":"pdf","helpDocument":

null
},
{
"allowableRange": {
"lowerBound": "-160",
"onlyIntegers": false,
"unitOfMeasure": null,
"upperBound": "140"
},
"allowableValues": [
"-1000"
],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/

2"}, {"dataProductCode":"TSSP","dataProductName":"Time Series Scalar Plot","extension":"png",

Spectrogram+Plot+Options"
],
"option": "dpo_upperColourLimit",
"suboptions": null
}
],
"extension": "png",
"hasDeviceData": true,
"hasPropertyData": false,
"helpDocument": "https://wiki.oceannetworks.ca/display/DP/

2

45"
}
]

Property	Type	Description	Example
dataProductCode	string	Returns the data product code.	"dataProductCode":"

TSSD

HSD"
dataProductName	string	Returns the name of the data product.	"dataProductName":"

Time

Hydrophone

Series Scalar

Spectral Data"
extension	string	Returns the file extension for

that

the data product.

"extension":

"json"

"png"
hasDeviceData	boolean	Returns whether at least one device and/or sensor with this data product is NEPTUNE searchable	"hasDeviceData":true
hasPropertyData	boolean	Returns whether at least one sensor with this data product is a NEPTUNE-searchable primary sensor	"hasPropertyData":false
helpDocument	string	Returns a Link URL to the

ONC

Oceans 3.0 Help documentation for the specific

Data Product

data product.

"helpDocument":"https://wiki.oceannetworks.ca/display/DP/45"

dataProductOptions

array of objects

Array of all the data product options that can be applied to the specific data product

dataProductOptions.AllowableRange

object

object describing the range of values for the specific data product option

dataProductOptions.AllowableRange.lowerBound

String

The lower bound for the data product option

"lowerBound": "100"

dataProductOptions.AllowableRange.onlyIntegers

boolean

false if the number can be floating point

"onlyIntegers": true

dataProductOptions.AllowableRange.unitOfMeasure

String

The unit of measure for the data product option

"unitOfMeasure": "Hz"

dataProductOptions.AllowableRange.upperBound

String

The upper bound for the data product option

"upperBound": "500000"

dataProductOptions.allowableValues

Array of strings

The allowable values for the dataproduct option. If there is an allowable range these values are in addition to the range.

"allowableValues": ["All","LPF","OD","HPF"]

dataProductOptions.documentation

Array of strings

List of all the documentation for a data product option

"documentation": ["https://wiki.oceannetworks.ca/display/DP/Hydrophone+Data+Acquisition+and+Diversion+Mode"]

dataProductOptions.option

String

name of the data product option

"option": "dpo_hydrophoneDataDiversionMode"

dataProductOptions.suboptions

Array of DataProductOptions

some data product options have children that become required when you select the parent, for example when you select the "resample" option you must specific the type of resample: avg, minmax, minmaxavg.

Expand

title	suboption_example

"option": "dpo_resample",
"suboptions": [{
"allowableRange": null,
"allowableValues": [],
"documentation": [
"https://wiki.oceannetworks.ca/display/DP/Resampling+(Data+Files)"
],
"option": "dpo_none",
"suboptions": null
},
{
"allowableRange": null,
"allowableValues": [
"3600",
"600",
"86400",
"900",
"60"
],
"documentation": [

"helpDocument":

"https://wiki.oceannetworks.ca/display/DP/

1"

Resampling+(Data+Files)"
],
"option": "dpo_average",
"suboptions": null
},

Bad Request (HTTP 400)

errorCode

errorMessage

Description

127

Invalid parameter value

Occurs when an invalid code is used in the filter. Most filters require an exact match, otherwise this error will occur.

The name of the filter parameter

will be

is included in the "parameter" property.
129	Invalid parameter name	Occurs when a filter parameter is

used,

in the query but is not supported.

The name of the filter parameter is included in the "parameter" property.

URL

...

Examples

Return a list of All of the Data Data Product Extensions (no filters)

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53 [YOUR_TOKEN_HERE]

Return a list of all of the Data Product Extensions available for a Data Product Code of 'TSSD' (Time Series Scalar Data)

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&dataProductCode=TSSD

Return a list of all of the Data Products Extensions available for an the Extension of 'pdf'

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&extension=pdf

Return a list of all of the Data Products Extensions available for a Data Product Code of 'TSSD' (Time Series Scalar Data) and an Extension of 'csv'

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&dataProductCode=TSSD&extension=csv

Return a list of all of the Data Product Extension that have with a Data Product Name which contains containing 'scalar'

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&dataProductName=scalar

Return a list of all of the Data Product Extensions that are available for instruments at a the location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')

httpshttp://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&locationCode=BACAX

Return a list of all of the Data Products with an the Extension of 'mat' that are available for instruments at a the location with a Location Code of 'BACAX' ('Barkely Canyon Axis (POD1)')

httpshttp://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&extension=mat&locationCode=BACAX

Return a list of all of the Data Product Extensions that are available for a the device with a Device Code of 'NORTEKAQDPRO8398'

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&deviceCode=NORTEKAQDPRO8398

Return a list of all of the Data Product Extensions that are available for instruments with a the Device Category of 'ADCP2MHZ'

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53[YOUR_TOKEN_HERE]&deviceCategoryCode=ADCP2MHZ

Return the a list of all Data Products Extensions available for a the Property Code of 'seawatertemperature'

httphttps://dmasdata.uvicoceannetworks.ca/api/dataProducts?method=get&token=9aa154c9-06dc-40f2-8989-70c85a90bb53&propertyCode=seawatertemperature[YOUR_TOKEN_HERE]&propertyCode=seawatertemperature

API Proxy

The https://data.oceannetworks.ca/apiproxy/dataProducts URL link in the above examples can be used in a browser for sharing or testing purposes; however, it can not be accessed from code. Calls to the apiproxy server are redirected to a login screen to capture your user id. Accessing the apiproxy URL from code will return html in the payload, which may cause errors or unexpected behaviour. In order to use the dataProducts endpoint from code, you must use the https://data.oceannetworks.ca/api/dataProducts url along with a valid token.

Code Examples

Content Report Table

blueprintModuleCompleteKey	com.atlassian.confluence.plugins.confluence-knowledge-base:kb-how-to-article-blueprint
contentBlueprintId	5fdbc098-f47d-4b1d-bd32-eb876051b73b
analyticsKey	kb-how-to-article
blankDescription	Provide step-by-step guidance for completing a task.
blankTitle	How-to article
spaces	O2A
createButtonLabel	Add how-to article
labels	sample-code-data-products

Warning
Please report all issues with the web services, documentation, samples and client libraries to the Oceans 3.0 Help Centre

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Description

URL

get

Parameters

Response

Success (HTTP 200)

Bad Request (HTTP 400)

URL

Examples

API Proxy

Code Examples