The frost.met.no Frost API specification is an XHTML/RDFa document that defines the classes and terms of the JSON-LD format used by the API. This document has been generated using Parrot, a RIF and OWL documentation service. The ontology is also described in a more succinct format using RDF/Turtle.

The frost.met.no Frost API specification (Ontology) VC Definition

The frost.met.no Frost API specification is an ontology that provides definitions of the main concepts and properties required to describe a meteorological, hydrological or oceanographic observation as delivered by the Frost API.

Version Control information

Version
draft
License
http://creativecommons.org/licenses/by/3.0/

Definition

The URI of this ontology is https://frost.met.no/schema


CfConvention (RDFS Class) VC Definition In use

The CF standard definition of the element.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#CfConvention


In use

This class has the following properties cellMethods standardName
This class is used in cfConvention

Element (RDFS Class) VC Definition In use

A meteorological, hydrological, oceanographic or climatological parameter that is defined in the frost.met.no Frost API system. These can be measured, calculated, or statistical values. To retrieve the full list of all elements defined on frost.met.no, see https://frost.met.no/elements/v0.jsonld; for a specific element id, use https://frost.met.no/elements/{id}/v0.jsonld

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Element


In use

This class has the following properties cfConvention description legacyMetNoConvention

ElementResponse (RDFS Class) VC Definition Documentation

A response from the frost.met.no Frost API that contains metadata for a set of elements defined using the Element class.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#ElementResponse


This class is a sub class of Response

Error (RDFS Class) VC Definition In use

An error object returned by the frost.met.no Frost API. The error object contains a code, message and possible some help text describing how to handle the error.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Error


In use

This class has the following properties code help message reason

ErrorResponse (RDFS Class) VC Definition In use

An error response from the frost.met.no Frost API. All standard error responses from the Frost API are of this class.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#ErrorResponse


This class is a sub class of Response

In use

This class has the following properties error

Geometry (RDFS Class) VC Definition In use

A GeoJSON geometry object. In the case of the frost.met.no Frost API, a geometry must be one of POINT, LINESTRING, or POLYGON.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Geometry


This class is a super class of LineString Point Polygon

In use

This class has the following properties coordinate

IDFValue (RDFS Class) VC Definition In use

A single IDF (intensity, duration, frequency) value.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#IDFValue


In use

This class has the following properties duration frequency intensity

LegacyMetNoConventnion (RDFS Class) VC Definition In use

Description of the legacy MET Norway form of the Element.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#LegacyMetNoConvention


In use

This class has the following properties category elemCode
This class is used in legacyMetNoConvention

Level (RDFS Class) VC Definition

A description of a level. A level is given by a value, the unit of measure for the level, and the type of the level.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Level


LineString (RDFS Class) VC Definition

A set of coordinates that constitute a line. For a LineString, the coordinates property must be an array of at least two positions.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#LineString


This class is a sub class of Geometry

Location (RDFS Class) VC Definition In use

A geographical location or place , such as a city, town, lake, or range of hills. A location identifies a point or an area on the Earth's surface using WGS84 coordinates. To retrieve metadata for a specific location name, see https://frost.met.no/locations/{id}/v0.jsonld

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Location


In use

This class has the following properties feature

LocationResponse (RDFS Class) VC Definition Documentation

A response from the frost.met.no Frost API that contains metadata for a set of locations defined using the Location class.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#LocationResponse


This class is a sub class of Response

Observation (RDFS Class) VC Definition In use

An observation for an element, for a source, location, time, and level given by the ObservationSeries that the Observation belongs to.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Observation


In use

This class has the following properties qualitycode referenceTime

ObservationResponse (RDFS Class) VC Definition Documentation

A response from the frost.met.no Frost API that contains a set of observation data of the Observation class. The data property of an ObservationResponse contains a set of ObservationSeries.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#ObservationResponse


This class is a sub class of Response

ObservationSeries (RDFS Class) VC Definition In use Documentation

A series of observations for the referencetime and source specified by the sourceId property of the data. The observations property contains a set of Observations (i.e., data for a given time and place).

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#ObservationSeries


In use

This class has the following properties observations

ObservationTimeSeries (RDFS Class) VC Definition In use

A series of observations for the referencetime and source specified by the sourceId property of the data. The observations property contains a set of Observations (i.e., data for a given time and place).

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#ObservationTimeSeries


In use

This class has the following properties resultTimeInterval status timeOffset uri

ObservationTimeSeries (RDFS Class) VC Definition In use Documentation

A series of rainfall IDF values, for a given sourceId and location.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#RainfallIDF


In use

This class has the following properties operatingPeriods values

ObservationTimeSeriesResponse (RDFS Class) VC Definition Documentation

A response from the frost.met.no Frost API that contains a set of observation time series information of the ObservationTimeSeries class.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#ObservationTimeSeriesResponse


This class is a sub class of Response

Point (RDFS Class) VC Definition

A single point. For a Point, the coordinates must be a single position.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Point


This class is a sub class of Geometry

Polygon (RDFS Class) VC Definition

A set of coordinates that define a polygon. For a Polygon, the coordinates must be an array of closed LineString coordinates.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Polygon


This class is a sub class of Geometry

RainfallIDFResponse (RDFS Class) VC Definition Documentation

A response from the frost.met.no Frost API that contains a set of rainfall intensity-duration-frequency data.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#RainfallIDFResponse


This class is a sub class of Response

RainfallIDFSource (RDFS Class) VC Definition Documentation

Metadata about the IDF values that exist for a single source.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#RainfallIDFSource


RainfallIDFSourcesResponse (RDFS Class) VC Definition

A response from the frost.met.no Frost API that contains metadata about the set of available sources with IDF data.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#RainfallIDFSourcesResponse


This class is a sub class of Response

Response (RDFS Class) VC Definition In use

A response from the frost.met.no Frost API. All data responses from the Frost API inherit a common set of properties.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Response


This class is a sub class of schema:CreativeWork
This class is a super class of ElementResponse ErrorResponse LocationResponse ObservationResponse ObservationTimeSeriesResponse RainfallIDFResponse RainfallIDFSourcesResponse SourceResponse

SensorPlatform (RDFS Class) VC Definition In use

An Entity to which other Entities can be attached - particuarly Sensors but also including other Platforms. For example, a post might act as the Platform, a bouy might act as a Platform, or a fish might act as a Platform for an attached sensor. On the frost.met.no Frost API, the most common form of platform is a meteorological observation station.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#SensorPlatform


This class is a sub class of Source

In use

This class has the following properties wmoIdentifier

Source (RDFS Class) VC Definition In use Documentation

An entity which is a source of data values in the frost.met.no Frost API. A source can many different things; for example, a Sensorplatform such as a meteorological observation station, a Person, or an Algorithm such as a forecast or climate model. To retrieve metadata for specific source identifiers, see https://frost.met.no/sources/{id}/v0.jsonld

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#Source


This class is a super class of SensorPlatform

In use

This class has the following properties country level levelType

SourceResponse (RDFS Class) VC Definition Documentation

A response from the frost.met.no Frost API that contains data for a set of sources defined using the Source class.

Version Control information

Status
testing

Definition

The URI of this class is https://frost.met.no/schema#SourceResponse


This class is a sub class of Response

apiVersion (Property) VC Definition

The version of the frost.met.no Frost API that served this response.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#apiVersion

The domain of this property is Response

category (Property) VC Definition

The category of the Element object in legacy systems at MET Norway.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#category

The domain of this property is LegacyMetNoConventnion

cellMethods (Property) VC Definition

The methods applied to the data value comprising a list of blank-separated words of the form 'name: method'. Each 'name: method' pair indicates that for an axis identified by name, the values in the object have been determined or derived by the specified method.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#cellMethods

The domain of this property is CfConvention

cfConvention (Property) VC Definition

The Element as it would be specified using the CF convention.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#cfConvention

The domain of this property is Element

code (Property) VC Definition

Represents the code for this error. This property value will usually represent the HTTP response code. If there are multiple errors, errorCode will be the code for the first error.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#code

The domain of this property is Error

codeTable (Property) VC Definition

The reference to code table used by the data value, if the unit is a code.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#codeTable

The complex domain of this property is the union of Element Level Observation ObservationTimeSeries

coordinate (Property) VC Definition

An array containing the coordinates that define the given geometry. This may be an array containing x and y coordinates, or an array of arrays of such. The notation follows the GeoJSON open standard format for representing simple geographic features.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#coordinates

The domain of this property is Geometry

country (Property) VC Definition

The country to which the object is affiliated.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#country

The domain of this property is Source

createdAt (Property) VC Definition

The time at which this document was created.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#createdAt

The domain of this property is Response
The range of this property is schema:DateTime

currentItemCount (Property) VC Definition

The current number of items in this result set. This will generally be equivalent to data.length, and is provided as a convenience property. For example, suppose a developer requests a set of items, with a limit of 50 items per page. If the total set has 92 items in total, then the first page will have both currentItemCount and itemsPerPage equal to 50; for the second page, itemsPerPage will still be 50, but currentItemCount will be 42.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#currentItemCount

The domain of this property is Response

currentLink (Property) VC Definition

The current link indicates the URI that was used to generate the current API response. It is primarily useful for debugging purposes.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#currentLink

The domain of this property is Response

data (Property) VC Definition

Container for all the data returned by a response. The specific type of item returned depends on the class of the response.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#data

The complex domain of this property is the union of ElementResponse LocationResponse ObservationResponse ObservationTimeSeriesResponse RainfallIDFResponse RainfallIDFSourcesResponse SourceResponse

description (Property) VC Definition

A description of the object.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#description

The domain of this property is Element

duration (Property) VC Definition

The duration value in minutes.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#duration

The domain of this property is IDFValue

elemCode (Property) VC Definition

The element code of the Element object in legacy systems at MET Norway.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#elemCode

The domain of this property is LegacyMetNoConventnion

elementId (Property) VC Definition Documentation

The frost.met.no Frost API id of the element being measured/observed/calculated.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#elementId

The complex domain of this property is the union of Observation ObservationTimeSeries

error (Property) VC Definition Documentation

The error object that describes the error that has created this response.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#error

The domain of this property is ErrorResponse

exposureCategory (Property) VC Definition

The exposure category of the data for the specified data source.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#exposureCategory

The complex domain of this property is the union of Observation ObservationTimeSeries

feature (Property) VC Definition

The type of the named geographic feature described by a Location object.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#feature

The domain of this property is Location

frequency (Property) VC Definition

The frequency value in years.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#frequency

The domain of this property is IDFValue

geo (Property) VC Definition

The spatial location of the object, described using a GeoJson geometry object in WGS84.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#geometry

The complex domain of this property is the union of Location ObservationSeries ObservationTimeSeries ObservationTimeSeries Source

help (Property) VC Definition

A human readable optional text that describes how the developer may fix the problem.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#help

The domain of this property is Error

id (Property) VC Definition Documentation

The identifier of the object defined by this data structure.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#id

The complex domain of this property is the union of Element Location Source

intensity (Property) VC Definition

The intensity value.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#intensity

The domain of this property is IDFValue

itemsPerPage (Property) VC Definition

The number of items in a result set. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than itemsPerPage. However the size of data.items should not exceed itemsPerPage.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#itemsPerPage

The domain of this property is Response

legacyMetNoConvention (Property) VC Definition

The legacy form of the Element, as used in legacy systems at MET Norway.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#legacyMetNoConvention

The domain of this property is Element

level (Property) VC Definition Documentation

The spatial level of the object. The type of the level (height, depth, etc) is given by the levelType property.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#level

The domain of this property is Source

levels (Property) VC Definition Documentation

The spatial level of the data when it was observed (if known). Represented as an array of Level objects to handle the possibility of multiple level definitions.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#levels

The complex domain of this property is the union of ObservationSeries ObservationTimeSeries

levelType (Property) VC Definition Documentation

The type of the level of the object, described as a frost.met.no Element.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#levelType

The domain of this property is Source

license (Property) VC Definition

The license that applies to this content, typically indicated by URL.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#license

The domain of this property is Response

message (Property) VC Definition

A human readable message that describes the error. If there are multiple errors, this will be the message pertaining to the first error.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#message

The domain of this property is Error

name (Property) VC Definition

The name of the object.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#name

The complex domain of this property is the union of Element Location Source

nextLink (Property) VC Definition

The next link indicates how more data can be retrieved. It points to the URI to load the next set of data. It can be used in conjunction with currentItemCount, startOffet, and totalItemCount to page through the data in a result set.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#nextLink

The domain of this property is Response

numberOfSeasons (Property) VC Definition

The number of seasons that the defined data source has been operational.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#numberOfSeasons

The complex domain of this property is the union of ObservationTimeSeries RainfallIDFSource

observations (Property) VC Definition Documentation

The list of observations in an observation series for a given source ID. The items in the list are of the Observation class.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#observations

The domain of this property is ObservationSeries

offset (Property) VC Definition

The offset of the first item in the data response. For consistency, the offset is 0-based.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#offset

The domain of this property is Response

operatingPeriods (Property) VC Definition

The periods of time during which the source has been operations, expressed as an array (set) of time specifications.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#operatingPeriods

The domain of this property is ObservationTimeSeries

performanceCategory (Property) VC Definition

The performance category of the data for the specified data source.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#performanceCategory

The complex domain of this property is the union of Observation ObservationTimeSeries

previousLink (Property) VC Definition

The previous link indicates how more data can be retrieved. It points to the URI to load the previous set of data. It can be used in conjunction with currentItemCount, startOffet, and totalItemCount to page through the data in a result set.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#previousLink

The domain of this property is Response

qualitycode (Property) VC Definition

A generated code which indicates confidence of the issuing authority in the quality of the data value.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#qualityCode

The domain of this property is Observation
The range of this property is schema:integer

queryTime (Property) VC Definition

The time, in seconds, that this document took to generate, as measured in the source code.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#queryTime

The domain of this property is Response

reason (Property) VC Definition

A more detailed optional text that describes the reason for the error (where message describes the kind of error).

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#reason

The domain of this property is Error

referenceTime (Property) VC Definition

The time of reference; for observations this is the time at which the measurement or statistic is officially observed and/or generated, as an ISO-8601 DateTime.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#referenceTime

The domain of this property is Observation

resultTimeInterval (Property) VC Definition

The interval between results in the timeseries. Given the reference time of an observation, add the resultTimeInterval to get the next observation in the timeseries.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#resultTimeInterval

The domain of this property is ObservationTimeSeries
The range of this property is schema:Duration

sourceId (Property) VC Definition

The id of the source at which these values were observed/measured.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#sourceId

The complex domain of this property is the union of ObservationSeries ObservationTimeSeries ObservationTimeSeries RainfallIDFSource

standardName (Property) VC Definition

The CF standard name of the Element object in the CF convention. For netcdf files generated at MET Norway, this is the CF standard name that would be used for the element.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#standardName

The domain of this property is CfConvention

status (Property) VC Definition

The status of the object. For the CFConvention, this is a reference to the CF version, Met Norway local standard or test (indicating the test status of the Element).For ObservationTimeSeries, this is about the current status of the time series.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#status

The domain of this property is ObservationTimeSeries
The complex domain of this property is the union of CfConvention ObservationTimeSeries

timeOffset (Property) VC Definition

The offset from the validFrom datetime. Add the offset to validFrom to get the referenceTime of the first observation in the timeseries.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#timeOffset

The domain of this property is ObservationTimeSeries
The range of this property is schema:Duration

totalItemCount (Property) VC Definition

The total number of items in this result set. For example, if a station has 1000 observations, the response may only contain 100 observations, but the totalItemcount would be 100.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#totalItemCount

The domain of this property is Response

unit (Property) VC Definition Documentation

The unit of measure of the object. If the value is a code, the unit of measure is set to 'code', and the codeTable property will contain a reference to the relevant code table.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#unit

The complex domain of this property is the union of Element https://frost.met.no/schema#CFConvention LegacyMetNoConventnion Level Level Observation ObservationTimeSeries ObservationTimeSeries

uri (Property) VC Definition

The suggested URI to retrieve the data defined by this ObservationTimeSeries.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#uri

The domain of this property is ObservationTimeSeries

valid time (Property) VC Definition

The point in time to which the object is valid (exclusive), as an ISO-8601 DateTime. If no validTo property is given, it is because the object continues to be valid at the current time.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#validTo

The complex domain of this property is the union of ObservationTimeSeries RainfallIDFSource Source
The range of this property is schema:DateTime

validFrom (Property) VC Definition

The point in time from which the object is valid (inclusive), as an ISO-8601 DateTime.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#validFrom

The complex domain of this property is the union of ObservationTimeSeries RainfallIDFSource Source
The range of this property is schema:DateTime

value (Property) VC Definition

The actual value of the measured/observed/calculated data.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#value

The complex domain of this property is the union of Level Observation

values (Property) VC Definition

A set of values for the given source, location, and time specification.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#values

The domain of this property is ObservationTimeSeries

wmoIdentifier (Property) VC Definition

The five digit numeric code character issued by the WMO that is used to identify land weather stations.

Version Control information

Status
testing

Definition

The URI of this property is https://frost.met.no/schema#wmoIdentifier

The domain of this property is SensorPlatform