There are two schema files available to download that are both needed to consume the API.
There are a couple of generic types used by many resources. They use the namespace
linkType and linksType
represents a link to another resource. It consist of:
rel- the mediatype of the target resource ( application/xml )
type- the xsd type of the target resource ( parameter )
href- the url to the target resource ( https://opendata-download-ocobs.smhi.se/api )
represents a set of
with additional information. This information contains a
to describe the resource, a
for extra description and
which represents the last time the target resource, or underlying subresources, was updated. This can be useful to deside if data is stale or not without traversing down to the actual data.
is used to represent the next level. For instance the Category type uses a list of
to represent all the Versions available. The
in this case refers to the different Versions in different formats.
Besides links to the same resource or the next resource in different formats,
are also used to refer to other useful resources. Here are some examples.
- Parent resources
linkTypeis available in the Versions listing of all the Parameters and also in the Parameter and Data resource itself.
geoBox and geoLinksType
represents an area of interest devided by
is a regular
but with an additional
category and version
types are used for versioning. The
links to the different versions of the API that can be used. Versions are incremented when changes are made to the API. There is one special version called
. This version is virtual and always points to the latest version of the API. It is not recomended to use this in any application as it might be redirected without notice. Instead try
to use the version with the highest number as these do not change. Older versions will be deprecated and only maintained for a couple of months.
type contains links to all available
The rest of the types are versioned and uses the namespace
. Common to these main types are
key- resource identifier
title- the name of the resource
summary- description of the resource
linkto other resources such as to themself in other mediatypes and more specific links to the next level.
hydrographySpecification, hydrographyRegion and hydrographyLinksType
represents a hydrographic specification. It contains
if the specification has any region files and it contains
hydrographyElement that has data for the specific specification. Beside the usual linksType information these links also contains the name of the target drainage basin.
Drainage Basin or
Dam or Weir. It contains
to all the available reference systems for the specific specification and element. Beside the usual linksType information these links also contains the name of the target reference