Page tree

Versions Compared

Key

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

Overall structure 

The oceanObs API is a OGC API - Features service and follows this standard as documented here: http://docs.opengeospatial.org/is/17-069r3/17-069r3.html.

Data is returned in a FeatureCollection object that describes the returned data set. Data points are in Features - each feature type is found in the features field which contains a number of Feature objects as described below.




FeatureCollection

Features Feature objects are wrapped in a GeoJSON FeatureCollection, which includes:

KeyNot nullData TypeDescription
typeyesStringAlways
contain FeatureCollection
equal to "FeatureCollection"
featuresyeslist<Feature>See below for the description of the specific feature
timeStampyesStringTimestamp when the response was generated. In RFC3339 5.6 format.
numberReturnedyesNumberNumber of
features
Feature objects returned
linksyesList of Link objects

Links to pages;

  • the link with rel="self" is a link to the page itself. 
  • the link with rel="next" is a link to the next page of results





Generic fields for every Feature

KeyNot nullTypeDescription

id

yes

String

Internal database ID

type

yes

String

Always contain Featureequal to "Feature"

geometryyesObjectPosition of the station in GeoJSON format. For "Oberservation" objects it is derived from the station's location
geometry.coordinates.0yesfloatlongitude
geometry.coordinates.1yesfloatlatitude





Observation
Anchor
SchemasObservation
SchemasObservation

This is a GeoJSON feature and the table below describes the returned data:

Position of the observation in GeoJSON format. Derived from the stations location

Key

Not null

Data Type

Description

properties.parameterId

yes

String

Parameter ID identifiying identifying the parameter by a name

properties.stationId

yes

String

Station ID identifying the station

properties.created

yes

String

Timestamp of create time in observation database in RFC3339 5.6 format

properties.observed

yes

String

Observation time in RFC3339 5.6 format

properties.value

yes

Object

Measured value

geometry

yes

Object





Station

Anchor
SchemaStation
SchemaStation

This is a GeoJSON feature and the table below describes the returned data:

KeyNot nullData TypeDescription
properties.instrumentParameteryesInstrumentParameterN/A - Currently null
properties.nameyesStringName of the station. See station list for a list of names
properties.owneryesStringOwner of the station
properties.typeyesStringStation type. See here for available types
properties.countryyesStringCountry code
properties.regionIdnoStringRegion id
properties.stationIdyesStringStation id
properties.parameterIdyesList<String>List of parameterId's parameterIds as defined in Parameters schema, which the station observes
properties.statusyesStringIndicated whether the station is active or inactivePossible values are "Active" or "Inactive"
properties.wmoContryCodenoStringWMO country code
properties.wmoStationIdnoStringWMO station id
properties.createdyesStringCreation time in database (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z")
properties.operationTonoStringLast date the station is operational in RFC3339 5.6 format. If the station is currently operational this field is null
properties.operationFromyesStringFirst date the station is operational in RFC3339 5.6 format
properties.updatednoStringLast station update in RFC3339 5.6 format. Update may be a new location, changes to instrument parameters etc
properties.validTonoStringLast date the station sends valid data in RFC3339 5.6 format. For now this is the same as timeOperationEndas operationTo, but may change in future versions
properties.validFromyesStringFirst date the station sends valid data in RFC3339 5.6 format. For now this is the same as timeOperationStartas operationFrom, but may change in future versionsgeometryyesObjectPosition of the station in GeoJSON format