Versions Compared

Old Version 14

changes.mady.by.user Ryan Ross

Saved on

compared with

New Version 15

changes.mady.by.user Allan Rempel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: remove link to "External Web Services", scrub token, add hasDeviceData, hasPropertyData

...

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. Use the dataProductCode and extension when requesting a data product via the dataProductDelivery web service.

For a list of available data product codes and extensions, along with help document links, see the Available Data Products page.

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


URL

No Format
https://data.oceannetworks.ca/api/dataProducts

...

Parameter
Type
Description
Example
Required   
tokenstringll Web Services require a token. Once logged in at https://data.oceannetworks.ca/login, your token can be retrieved or generated at https://data.oceannetworks.ca/Profile . Click on the "Web Services" tab, then click "Generate Token".token=5ba514e8-1203-428c-8835-879c8173e387YOUR_TOKEN_HERE
Optional   
dataProductCodestring

Return all Data Product Extensions matching a specific Data Product Code.

  • Data Product Code must be valid and match exactly, including case.
dataProductCode=annotationfile
extensionstring

Return all Data Products that have a specific File Extension.

  • Extension must be valid and match exactly, including case.
extension=csv
dataProductNamestring

Return all Data Products where the Data Product Name contains a keyword.

  • Filter is not case sensitive, 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=time
locationCodestring

Return all Data Products 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
deviceCategoryCodestring

Return all Data Products 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
deviceCodestring

Return all Data Products 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
propertyCodestring

Return all Data Products 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

...

Property
Type
Description
Example
dataProductCodestringReturns the data product code.
"dataProductCode":"TSSD"
dataProductName
stringReturns the name of the data product.
"dataProductName":"Time Series Scalar Data"
extension
stringReturns the file extension for the data product.
"extension":"json"
hasDeviceDatabooleanReturns whether at least one device and/or sensor with this data product is NEPTUNE searchable"hasDeviceData":true
hasPropertyDatabooleanReturns whether at least one sensor with this data product is a NEPTUNE-searchable primary sensor"hasPropertyData":false
helpDocument
stringReturns a Link URL to the Oceans 2.0 Help documentation for the specific Data Product.
"helpDocument":"https://wiki.oceannetworks.ca/display/DP/1"

...

errorCode
errorMessage
Description
127Invalid 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 is included in the "parameter" property.
129Invalid parameter name

Occurs when an unsupported a filter parameter is in the query but is not supported.

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

 

 URL Examples

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

...