Versions Compared

Key

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

...

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=YOUR_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

...