interface

False

(none)

(none)

(none)

OGC API — Common — Part 1

interface

False

(none)

(none)

(none)

OGC API — Common — Part 2

interface

False

(none)

(none)

(none)

OGC API — Records

interface

False

(none)

(none)

(none)

Uniform Additional Dimensions

interface

False

(none)

(none)

(none)

Address

Postal address of the resource

interface

False

(none)

deliveryPoint [*]

String

Address lines for the location (e.g. street name and door number)

city [0..1]

String

City for the location

administrativeArea [0..1]

String

State or province of the location

postalCode [0..1]

String

ZIP or other postal code

country [0..1]

String

Country of the physical address. ISO 3166-1 is recommended

role [*]

String

The type of postal address (e.g. office, home, etc.)

(none)

BBox

A sorted list of 4 (2D) or 6 (3D) coordinates

Array

False

(none)

item [4..6]

Real

A sorted list of 4 (2D) or 6 (3D) coordinates

(none)

CollectionDescription

Description of a collection. It is returned by the Web API at /collections/{collectionId}

interface

False

(none)

id [1]

String

Identifier of the collection (sometimes referred as collectionId). It is used in the Web API as path parameter in /collections/{collectionId}

title [0..1]

String

A short, human-readable summary of the collection

description [0..1]

String

A human-readable explanation about data in the collection

attribution [0..1]

String

Provides a way to identify the source of the geographic information which can contain markup text whose format may be indicated in the attributionMediaType property. That format can be either plain text (text/plain), HTML (text/html) or CommonMark (text/markdown)

attributionMediaType [0..1]

AttributionMediaTypeCode

Media type for the markup language of the attribution: It can be either plain text (text/plain), HTML (text/html) or CommonMark (text/markdown).

accessContraints [0..1]

AccessContraintsCode

Restrictions on the availability of the collection that the user needs to be aware of before using or redistributing the data.

parent [0..1]

String

An id of a collection that is the parent of this collection, if the collection is part of a hierarchy. In this case, this property allows to identify another collection within the same dataset as its parent (by setting parent to the id of that collection), enabling clients to construct a hierarchy. For example a rivers’ collection can have an topographic collection as parent.

publisher [0..1]

String

Organization or individual responsible for making the data available

license [0..1]

String

The legal provisions under which the data of this collection is made available

rights [0..1]

String

A statement that concerns all rights not addressed by the license such as a copyright statement

keywords [*]

String

The topic or topics of the resource. Typically represented using free-form keywords, tags, key phrases, or classification codes

itemType [0..1]

String

Indicator about the type of the items in the collection if the collection has an accessible /collections/{collectionId}/items endpoint. Examples are “feature” (default) of “record”.

dataType [0..1]

String

Nature of the data in the collection. For example, this could be set to map, vector or coverage. It is not an indication of the available data access mechanism, but a hint regarding the internal representation of the data.

featureType [*]

String

The list of feature (or coverage) type(s) which are present inside the collection. If the data is exposed as items each feature type is expected to share the same property types. For a coverage type it is related to the range type. This is useful for associating the relevant portrayal rules of a style.

geoDataClass [*]

anyURI

URIs identifying a class of data contained in the geospatial data (useful for example to determine compatibility with styles or processes)

defaultField [*]

String

A sorted list of field names. For a features data access mechanism , it is the list of returnable properties included by default and complementing the geometry of the features. For a coverage data access mechanism, they are names of fields whose values are included by default. Note that an API may provide a mechanism (e.g. a query parameter called ‘properties’ or ‘exclude-properties’) to override this default list in customized responses.

crs [*]

String, Class

The list of references to coordinate reference systems supported by the API expressed as full URIs or CURIEs; the first item is typically the default coordinate reference system. If no reference to point to can be found, it could also be a list of descriptions of CRSs as string or a full class using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON class.

storageCrs [0..1]

String, Class

The native coordinate reference system (i.e., the most efficient CRS in which to request the data, possibly how the data is stored on the server); this is the default output coordinate reference system for Maps and Coverages. If no reference to point to can be found, it could also be a description of CRSs as string or a full class using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON class.

epoch [0..1]

Real

Epoch of the native (storage) Coordinate Reference System (CRS)

geometryDimension [0..1]

Integer

Number of spatial dimensions of the primary geometry of individual elements of the data: 0 for points, 1 for curves, 2 for surfaces, 3 for solids and unspecified when mixed or unknown. Not to be confused with the dimensions of the domain which are defined by the extent element.

minScaleDenominator [0..1]

Real

Minimum scale denominator for usage of the collection

maxScaleDenominator [0..1]

Real

Maximum scale denominator for usage of the collection

minCellSize [0..1]

Real

Minimum cell size for usage of the collection in degrees of latitude for data referenced to Earth

maxCellSize [0..1]

Real

Maximum cell size for usage of the collection in degrees of latitude for data referenced to Earth

created [0..1]

DateTime

Timestamp indicating when the data in the collection was first produced

updated [0..1]

DateTime

Timestamp of the last change/revision to the data in the collection

(none)

Collections

A set of geospatial resources that may be available as one or more sub-resource distributions. It is returned by the Web API at /collections

interface

False

(none)

numberMatched [0..1]

Integer

Number of elements in the response that match the selection parameters like bbox.

numberReturned [0..1]

Integer

Number of elements in the response. Omitted unknown or difficult to compute

(none)

Concept

A concept defined in a vocabulary

interface

False

(none)

id [1]

String

Identifier for the concept in the knowledge system

title [0..1]

String

A human readable title for the concept

description [0..1]

String

A human readable description for the concept

definition [0..1]

anyURI

A URI providing further description of the concept

(none)

ConformanceClasses

A declaration of the conformance classes that the API conforms to. It is returned by the Web API at /conformance

interface

False

(none)

conformsTo [1..*]

anyURI

A conformance class URIs from the ones defined in the OGC API standard documents

(none)

Contact

Contact point of the resource. It can be a person or an organization

interface

False

(none)

id [0..1]

String

A value uniquely identifying a contact

name [0..1]

String

The name of the responsible person

position [0..1]

String

The name of the role or position of the responsible person taken from the organization’s formal organizational hierarchy or chart

organization [0..1]

String

Organization/affiliation of the contact

hoursOfService [0..1]

String

Time period when the contact can be contacted

contactInstructions [0..1]

String

Supplemental instructions on how or when to contact can be made

role [*]

String

The set of named duties, job functions and/or permissions associated with this contact. (e.g. developer, administrator, etc.)

(none)

Coordinates

Array

False

(none)

item [1..*]

Real,String

(none)

(none)

Email

Email address of the resource

interface

False

(none)

value [1]

String

The value is the email itself

role [*]

String

The type of email (e.g. home, work, etc.)

(none)

Exception

A schema for exceptions based on RFC 7807. It is returned by the Web API in case of an error retrieving the API resources

interface

False

(none)

type [1..*]

String

A URI that identifies the problem type. When this member is not present, its value is assumed to be about:blank

title [1]

String

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem

status [1]

String

The HTTP status code generated by the server for this occurrence of the problem

detail [1]

String

A human-readable explanation specific to this occurrence of the problem

instance [1]

String

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced

(none)

Extent

The extent of the resource with spatial, temporal optional Uniform Additional Dimensions (UAD) schema. The first item in the arrays for bbox or interval describe the overall extent of the data. All subsequent items describe more precise extents, e.g., to identify clusters of data.

interface

False

(none)

(none)

(none)

Fields

Array

False

(none)

item [*]

(none)

(none)

Format

Format of the resource

interface

False

(none)

name [0..1]

String

Name of the format

mediaType [0..1]

String

Media type of the format

(none)

Grid

Provides information about the limited availability of data within the collection organized as a grid (regular or irregular) along the dimension.

abstract

True

(none)

cellsCount [1]

UnsignedInteger

Number of samples available along the dimension for data organized as a regular or irregular grid

(none)

Interval

Commonly a sorted list of a pair of numbers, but it is string to support for example for a pair of dates in ISO format

type

False

(none)

item [2..2]

Real,String

(none)

(none)

IrregularGrid

Irregular grid description using syncronized lists of coordinates and its bounds. For the spatial dimensions they are expressed in the ‘storageCRS’ of the collectionDescription. For TemporalExtent they are based in the trs. For OtherDimensions they are in ‘trs’ , ‘vrs’ or directly in the way specified in the ‘definition’

interface

False

(none)

Coordinates [1..*]

Real, String

Sorted list of coordinates along the dimension for which data organized as an irregular grid in the collection is available (e.g., 2, 10, 80, 100).

boundsCoordinates [*]

Interval

Ordered list of the coordinates in absolute units of the lower and upper bounds of the dimension for each cell. For the spatial dimensions they are expressed in the ‘storageCRS’ of the collectionDescription. For TemporalExtent they are based in the trs. For OtherDimensions they are in ‘trs’ , ‘vrs’ or directly in the way specified in the ‘definition’

(none)

LandingPage

Provides the information needed to navigate all the resources exposed through the API. It is returned by the Web API at the root node Web API endpoint.

interface

False

(none)

title [*]

String

The title of the API. While a title is not required, implementors are strongly advised to include one

description [0..1]

String

A longer description of the API.

attribution [0..1]

String

Provides a way to identify the source of the geographic information provided by the instance of the Web API. The attribution of the Web API should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. The string can include HTML markup or markdown.

attributionMediaType [0..1]

AttributionMediaTypeCode

The ‘attribution’ can contain markup text whose format may be indicated in the attributionMediaType property (e.g., text/html for HTML or text/markdown for CommonMark). If the ‘attributionMediaType’ indicates something other than text/plain, the attribution element string should be interpreted by a markup parser selected based on that media type to be presented to the user (e.g., text/markdown will be parsed by a library supporting CommonMark). By allowing markup, the attribution string can import images (e.g., organization logos) and format the text (e.g., the name of the organization in italics).

(none)

Link

An expression of a relationship between resources.

type

False

(none)

href [1]

String

URI to a remote resource (or resource fragment)

rel [1]

String

The type or semantics of the relation

type [0..1]

String

A hint indicating what the media type of the result of dereferencing the link should be.

hreflang [0..1]

String

A hint indicating what the language of the result of dereferencing the link should be.

title [0..1]

String

Used to label the destination of a link such that it can be used as a human-readable description

length [0..1]

Integer

A hint indicating the Content-length of the result of dereferencing the link should be

(none)

OtherDimensionExtent

Other dimension definition and extent. First Interval is the overall interval and additional ones are spaced within the overall Interval

interface

False

(none)

interval [1..*]

Interval

Sorted list of one or more intervals that describe the extent for this dimension of the dataset. The value null is supported and indicates an unbounded or half-bounded interval. The first interval describes the overall extent of the data for this dimension. All subsequent intervals describe more precise intervals, e.g., to identify clusters of data. Clients only interested in the overall extent will only need to access the first item (a pair of lower and upper bound values).

trs [0..1]

String, Class

Temporal Coordinate Reference System (e.g. as defined by Features for ‘temporal’). This must be a URI to a registered TRS if one is available, or a fully description.

vrs [0..1]

String, Class

Vertical Coordinate Reference System (e.g. as defined in EDR for ‘vertical’). This must be a URI to a registered VRS if one is available, or a fully description.

definition [0..1]

anyURI

A URI to the definition of the measured or observed property corresponding to this dimension

unit [0..1]

String

The unit of measure in which the interval and/or grid values are expressed

unitLang [0..1]

anyURI

The language (or vocabulary) in which the unit is expressed (defaults to “UCUM” if not specified)

variableType [0..1]

VariableTypeCode

Class of variable, distinguishing between continuous vs. discrete, numerical vs. categorical, and ordinal vs. nominal. Continuous variables (continuous) represent an infinite spectrum of values (such as spatial coordinates or temporal instants), while discrete variables (numericalOrdinal, numericalNominal, categoricalOrdinal, and categoricalNominal) represent a finite or countable set of distinct values.

(none)

Phone

Phone or Fax of the resource

interface

False

(none)

value [1]

String

The value is the phone number itself

role [*]

String

The type of phone number (e.g. home, work, fax, etc.)

(none)

RegularGrid

Resolution of regularly gridded data along the dimension in the collection.

interface

False

(none)

firstCoordinate [1]

Real,String

First coordinate where a regular grid begins, with subsequent coordinates adding resolution unit at each step. Commonly is a number but can be a string to support date first coordinates. For the spatial dimensions they are expressed in the ‘storageCRS’ of the collectionDescription. For TemporalExtent they are based in the trs. For the OtherDimensions they are in ‘trs’ , ‘vrs’ or directly in the way specified in the ‘definition’

resolution [1]

Real,String

Resolution of regularly gridded data along the dimension in the collection. Commonly is a number but can be a string to support date resolution. For the spatial dimensions they are expressed in the collectionDescription ‘storageCRS’ units. For TemproalExtent they are based in the trs units. For the OtherDimensions they are in ‘trs’ units , ‘vrs’ units or directly in ‘unit’

relativeBounds [0..1]

Interval

Distance in units (for the spatial dimensions they are the collectionDescription ‘storageCRS’ units; for TemproalExtent they are based in the trs units; for the OtherDimensions they are in ‘trs’ units , ‘vrs’ units or directly in ‘unit’) from coordinate to the lower and upper bounds of each cell for regular grids, describing the geometry of the cells.

availableResolution [*]

Real,String

List of resolutions made available by the API. If it is not indicated, there are no restrictions in resolutions other that the limits indicated in the ‘minCellSize’ and ‘maxCellSize’ of the collection description. For the spatial dimensions they are expressed in the collectionDescription ‘storageCRS’ units. For TemproalExtent they are based in the trs units. For the OtherDimensions they are in ‘trs’ units , ‘vrs’ units or directly in ‘unit’

(none)

ResourceLanguage

Language of the resource.

interface

False

(none)

code [1]

String

The language tag as per RFC-5646

name [0..1]

String

The untranslated name of the language

alternate [0..1]

String

The name of the language in another well-understood language, usually English

dir [0..1]

LanguageDirectionCode

The direction for text in this language. The default, ltr (left-to-right), represents the most common situation. However, care should be taken to set the value of dir appropriately if the language direction is not ltr. Other values supported are rtl (right-to-left), ttb (top-to-bottom), and btt (bottom-to-top)

(none)

TemporalExtent

The temporal reference system and extent. First Interval is the overall interval and additional ones are spaced within the overall Interval

interface

False

(none)

trs [0..1]

String, Class

Reference system of the temporal extent (property interval). The default reference system is the Gregorian calendar. In the Core this is the only supported temporal reference system. Extensions may support additional temporal reference systems. This must be a URI to a registered TRS if one is available, or a fully description.

interval [*]

Interval

One or more time intervals that describe the temporal extent of the dataset. In the Core only a single time interval is supported. Extensions may support multiple intervals. The first time interval describes the overall temporal extent of the data. All subsequent time intervals describe more precise time intervals, e.g., to identify clusters of data. Clients only interested in the overall extent will only need to access the first item in each array.

(none)

SpatialExtent

The spatial dimension and extent. ‘bbox’ is in ‘crs’. ‘storageCrsBox’ is in the storageCrs of the parent class. For bbox and storageCrsBbox, first BBox is the overall extent and additional ones are spaced within the overall extent. If no reference to point to can be found, it could also be a list of descriptions of CRSs as string or a full class e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON class.

interface

False

(none)

crs [0..1]

String,Class

Coordinate reference system of the coordinates of the bbox property. For data referenced to Earth only the default value is allowed. The default reference system is CRS84 or CRS84h for coordinates with height. For non-terrestrial coordinate reference system, another CRS may be specified

bbox [*]

BBox

Sorted list of one or more bounding boxes that describe the spatial extent of the dataset. The first bounding box describes the overall spatial extent of the data. All subsequent bounding boxes describe more precise bounding boxes, e.g., to identify clusters of data. Clients only interested in the overall spatial extent will only need to access the first item in each array.

storageCrsBbox [*]

BBox

One or more bounding boxes that describe the spatial extent of the dataset in the storage (native) CRS (storageCrs property in the collectionDesc). The first bounding box describes the overall spatial extent of the data. All subsequent bounding boxes describe more precise bounding boxes, e.g., to identify clusters of data. Clients only interested in the overall spatial extent will only need to access the first item in each array.

(none)

Theme

A theme defined by a concept in an scheme of concepts.

interface

False

(none)

scheme [0..1]

String

An identifier for the knowledge organization system used to classify the resource. It is recommended that the identifier be a resolvable URI. The list of schemes used in a searchable catalog can be determined by inspecting the server’s OpenAPI document or, if the server implements CQL2, by exposing a queryable (e.g. named scheme) and enumerating the list of schemes in the queryable’s schema definition.

(none)

AccessConstraintsCode

Enumeration of contraints

enumeration

False

(none)

Name

Definition

confidential

Confidential access constraint

secret

secret access constraint

restricted

Restricted access constraint

topSecret

Top secret access constraint

unclassified

Unclassified access constraint

AttributionMediaTypeCode

Enumeration of media types for attribution

interface

False

(none)

Name

Definition

text/plain

Plain text

text/html

Hypertext markup language

text/markdown

Mark down text format

LanguageDirectionCode

Enumeration of language directions.

enumeration

False

(none)

Name

Definition

ltr

left to right

rtl

right to left

ttb

Top to bottom

btt

Bottom to top

VariableTypeCode

Enumeration of Variable types. The class of variable, distinguishing between continuous vs. discrete, numerical vs. categorical, and ordinal vs. nominal. Continuous variables (continuous) represent an infinite spectrum of values (such as spatial coordinates or temporal instants), while discrete variables (numericalOrdinal, numericalNominal, categoricalOrdinal, and categoricalNominal) represent a finite or countable set of distinct values. Nominal variables are unordered, while ordinal variables imply a specific order. Numerical variables are identified with integer or real numbers, while categorical variables are identified with textual strings. The variable type informs correct interpretation and interpolation method.

interface

False

(none)

Name

Definition

continuous

Continuous variable representing an infinite spectrum of values (such as spatial coordinates or temporal instants)

numericalOrdinal

Numerical ordinal variables are discrete variables, identified with integer or real numbers implying a specific order.

numericalNominal

Numerical nominal variables are discrete variables, identified with unordered integer or real numbers.

categoricalOrdinal

Categorical ordinal variables are discrete variables representing a finite or countable set of distinct values implying a specific order.

categoricalNominal

Categorical nominal variables are discrete variables representing a finite or countable set of distinct unordered values.