Versions Compared

Key

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


Table of contents:

Table of Contents
excludeTable of contents






Overall

structure 

Structure 

The metObs API is an 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 found in the features field which contains a number of Feature objects as described below.




FeatureCollection

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

KeyNot nullData TypeDescription
typeyesStringAlways equal to "FeatureCollection"
featuresyeslist<Feature>See below for the description of the specific Feature object
timeStampyesStringTimestamp when the response was generated. In RFC3339 5.6 format.
numberReturnedyesNumberNumber of 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

object

Object

KeyNot nullTypeDescription

id

yes

String

Internal database ID

type

yes

String

Always equal to "Feature"

geometryyesObjectPosition of the station in GeoJSON format
geometry.coordinates.0yesfloatlongitude in WGS84
geometry.coordinates.1yesfloatlatitude in WGS84





Observation
Anchor
SchemasObservation
SchemasObservation

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

Key

Not null

Data Type

Description

properties.parameterId

yes

String

Parameter ID identifying the parameter by a name (the list of parameters)

properties.stationId

yes

String

Station ID identifying the station (the list of stations)

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





Station

Anchor
SchemaStation
SchemaStation

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

KeyNot nullData TypeDescription
properties.barometerHeightnofloatHeight above sea level in meters of the station's barometer
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.countryyesStringThree-letter ISO 3166-1 alpha-3 country code 
properties.regionIdnoStringWMO region id
properties.stationIdyesStringStation id
properties.parameterIdyesList<String>List of parameterIds as defined in Parameters schema, which the station observes
properties.statusyesStringPossible 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 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 operationFrom, but may change in future versions
properties.stationHeightnoNumberHeight above sea level in meters of the station's height