The following is a list of the most common terms used by the Oceans 2.0 API.
| Term | Definition |
|---|---|
begin | A dataProductDelivery service filter that represents the starting datatime of a time interval for a data product request. Example: &begin=2015-04-24T00:00:01.000Z |
beginDeployment | A web service filter that represents the starting datetime of a time interval for a deployment. Example: &beginDeployment=2015-04-24T00:00:01.000Z |
bbox | A 3D Bounding Box, representing the minimum and maximum extents (latitude, longitude, depth) of all geographic features in a collection. Example: "bbox":{"maxDepth":987.0,"maxLat":48.316839,"maxLon":-126.0501233333,"minDepth":981.0,"minLat":48.3165166667,"minLon":-126.050872} |
cvTerm | A web service output value that represents a controlled vocabulary term for the specific item. Example: "cvTerm":{"deviceCategory":[{"uri":"http://vocab.nerc.ac.uk/collection/L05/current/130/","vocabulary":"SeaDataNet device categories"}] |
Data Product | Can include both raw data (such as tabular scalar data, manufacturers formats) and visualizations (such as graphs, charts and maps). Data products can also be represented in a number of different formats, such as:
|
dataProductCode | A web service filter or output value that represents an abbreviation of a data product name, which acts as a unique identifier for a data product. Example: dataProductCode=TSSD or "dataProductCode":"TSSD"
|
dataProductName | A web service filter or output value that represents the full name of a specific data product, which can be used by a user to identify a specific data product and may be used as a label. Example: &dataProductName=Scalar or "dataProductName":"Time Series Scalar Data" |
dataSearchURL | A locations web service output value that contains a link url to the Oceans 2.0 GUI for a specific location. Example: "dataSearchURL":"http://qaweb2.neptune.uvic.ca/DataSearch?location=BACAX" |
Deployment | A specific date range and location that an instrument is connected to ONC network. A deployment is uniquely identified by a deviceCode, a locationCode, begin & end dates and a geographic location (lat, lon, depth). A deployment does not guarantee data availability. An instrument may be connected to the network, but not actively collecting data during portions of a deployment. An instrument my be deployed at multiple locations over its lifespan. |
depth | The distance below the water surface. For a location, depth represents the average depth or centroid of a 3D bounding box encompassing all of the site devices represented in the collection. For a device, depth represents the depth of a specific instrument deployment. Example: "depth":984.3076 |
Device | An instrument that has one or more sensors that observe a property or phenomenon with a goal of producing an estimate of the value of the property. A specific sensor on a device is identified by a property (variable). A Device can have data at the device level or at the property (variable) level. For example A camera's image data is at the device level. A device can be deployed at multiple locations over its lifespan. |
Device Category | A grouping of like devices, such as CTD - Conductivity Temperature (and Depth) sensor. A device category can contain devices from multiple manufactures, for example CTD may contain devices from Sea-Bird, RBR, Alec Electronics, AML, Falmouth. |
deviceCategoryCode | A web service filter or output value that represents an abbreviation of a device category name, which acts as a unique identifier for a device category. Example: &deviceCategoryCode=CTD or "deviceCategoryCode":"CTD"
|
deviceCategoryName | A web service filter or output value that represents the full name of a specific device category, which could be used by a user to identify a specific device category and may be used as a label. Example: &deviceCategoryName=Conductivity or "deviceCategoryName":"Conductivity Temperature (and Depth Sensor)" |
deviceId | A numeric unique identifier for a specific device. Used by DMAS and by some legacy web services and user workflows. Included in the results of a devices web service payload. Example: "deviceId":23599 |
deviceName | A web service filter or output value that represents the full name of a specific device, which can be used by a user to identify a specific device and may be used as a label. Example: &deviceName=Sea-Bird or "deviceName":"Sea-Bird SeaCAT SBE16plus 4686" |
end | A dataProductDelivery service filter that represents the ending datetime of a time interval for a data product request. Example: &end=2015-04-24T00:05:29.000Z |
endDeployment | A web service filter that represents the ending datetime of a time interval for a deployment. Example: &endDeployment=2015-04-24T00:05:29.000Z |
extension | A web service filter or output value that represents a data product file format. Example: &extension=mat or "extension":"mat"
|
hasDeviceData | A web service output value boolean (true/false) that indicates if a data product delivery request can be made using a device (by Device or by Device & Property). Example: "hasDeviceData":"true" |
hasPropertyData | A web service output value boolean (true/false) that indicates if a data product delivery request can be made using a primary sensor request (by Location & Property). Example: "hasPropertyData":"false" |
helpDocument | A dataProducts service output value that contains a link url to the Data Product documentation for a specific data product. See Data Products Home for more information. Example: "helpDocument":"https://wiki.oceannetworks.ca/display/DP/1" is the help document url for the "Time Series Scalar Data" data product |
lat | Degrees latitude of a geographic location. Latitude is the angular displacement of a place north or south of the equator. For a location, lat represents the average latitude or centroid of bounding box encompassing all site devices represented in the collection. For a device, lat represents the latitude of a specific instrument deployment. Example:"lat":48.31668927333395 |
Location | The parent of an Ocean's 2.0 Tree Node that you can get data from. More specifically, in the Oceans 2.0 Data Search GUI, a location is a Tree Node that contains device categories (Instruments by Location) or properties (Variables by Location) that can be selected to download data. From the Ocean's 2.0 perspective, a location is a Search Tree Node that has one or more site devices and/or has one or more primary sensors. If there are multiple instruments of the same device category at a location, child-locations or pseudo-nodes will exist and data can be pulled from any one of them. Device Categories can be either at the location or at the child-location level, whereas Properties (variables) can only be at the location level, due to the 'Primary Sensor' concept, which stitches together data from multiple sensors over time at a location. A location represents a feature of interest that can be either at a fixed position, such as a named cluster of instruments on the sea floor, like Axis (POD #1) or above the water, like 'Mill Bay Shore Station' or on a mobile platform, such as the BC Ferries vessel on the 'Tsawwassen - Duke Point' route, a research vessel such as 'R/V Sikuliaq', an ROV such as 'Jason 2' or a Glider. |
locationCode | A web service filter or output value that represents a short abbreviation of a location name, which acts as a unique identifier for a specific location. Example: &locationCode=CQSBG or "locationCode":"CQSBG"
|
locationName | A web service filter or output value that represents the full name of a specific location, which could be used by a user to identify a specific location and may be used as a label. Example: &locationName=Bubbly Gulch or "locationName":"Bubbly Gulch" |
lon | Degree longitude of a geographic location. Longitude is the angular displacement of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object. For a location, lon represents the average longitude or centroid of bounding box encompassing all site devices represented in the collection. For a device, lon represents the longitude of a specific instrument deployment. Example: "lon":-126.05033437333402 |
includeChildren | A locations service boolean filter to include all children of a location in the results, in a non-hierarchical representation. Example: &includeChildren=true |
Property | The common name given to a sensor type. A property is an observable phenomenon that can be measured to produce an estimated value. A property is also known as a variable. |
propertyCode | A web service filter or output which acts as a unique identifier for a specific property (variable). Example: &property=oxygen or "property":"oxygen" |
uom | Unit of Measure Example: "uom":"psi" represents "Pounds per sq inch" |