Versions Compared

Key

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

...

Returns a list of properties with values for Property Code, Property Name, Description and Units of Measure (UOM), ordered by Property Code

 

[
 {
    "description":"Time: Gregorian days since 19700101T000000Z",
    "propertyCode":"gregoriantime",
    "propertyName":"Gregorian Time",
    "uom":"Gregorian days since 19700101T000000Z"
 },
 {
    "description":"Magnetic Heading",
    "propertyCode":"magneticheading",
    "propertyName":"Magnetic Heading",
    "uom":"deg",
    "cvTerm": [{  "uom": [{ "vocabulary""BODC data storage units",    "uri""http://vocab.nerc.ac.uk/collection/P06/current/UAAA/"   }]  }]
 },
 {
    "description":"Pitch",
    "propertyCode":"pitch",
    "propertyName":"Pitch",
    "uom":"deg",
    "cvTerm": [{  "uom": [{ "vocabulary""BODC data storage units",    "uri": "http://vocab.nerc.ac.uk/collection/P06/current/UAAA/"   }]  }]
 },
 {
    "description":"Pressure",
    "propertyCode":"pressure",
    "propertyName":"Pressure",
    "uom":"decibar",
    "cvTerm": [{  "uom": [{ "vocabulary""BODC data storage units",    "uri": "http://vocab.nerc.ac.uk/collection/P06/current/UPDB/"   }]  }]
 },
 {
    "description":"Roll",
    "propertyCode":"roll",
"propertyName":"Roll",
"uom":"deg"},
{
"description":"Temperature: sea water",
"propertyCode":"seawatertemperature",
"propertyName":"Sea Water Temperature",
"uom":"C"
},
{
"description":"Sound Speed: sound velocity sensor",
"propertyCode":"soundspeed",
"propertyName":"Sound Speed",
"uom":"m/s"
},
{
"description":"Voltage: voltage sensor",
"propertyCode":"voltage",
"propertyName":"Voltage",
"uom":"V"
"cvTerm": [{  "uom": [{ "vocabulary""BODC data storage units",    "uri""http://vocab.nerc.ac.uk/collection/P06/current/UVLT/"   }]  }]
}
]
Property
Type
Description
Example
descriptionstringReturns a description of the property
"description":"Pressure"
propertyCodestringReturns the property code"propertyCode":"pressure"
propertyNamestringReturns the property name.
"propertyName":"Pressure"
uomstringReturns the Unit Of Measure that the property measurements are in
"uom":"decibar"
cvTermList

Returns a list of controlled vocabulary terms associated with the Property and the Unit of Measure associated with the Property if one exists. The controlled vocabulary terms associated with the Property are included in the "property" list and the terms associated with the Unit of Measure are included in the "uom" list.

Each vocabulary term is made up of:

  1. Key : "vocabulary" Value : "title of the vocabulary term belongs to"
  2. Key : "uri" Value : "URL of the vocabulary term"

 

"cvTerm": [{"property" : [{ "vocabulary""NERC-??","uri""http://vocab/..." }],

"uom": [{ "vocabulary" : "BODC data storage units", "uri" : "http://vocab.nerc.ac.uk/collection/P06/current/UVLT/
" }] }]

Bad Request (HTTP 400)

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 will be included in the "parameter" property
129Invalid parameter name

Occurs when a filter parameter is used, but is not supported.

...