API description

Info

Description
Title
QGIS Server Demo
Contact email
benjamin.jakimow@geo.hu-berlin.de
Contact name
Benjamin Jakimow

Paths

get The API definition
OperationId
getApiDescription
Tags
["Capabilities"]
Description
The formal documentation of this API according to the OpenAPI specification, version 3.0. I.e., this document.
Responses
{"200":{"content":{"application/openapi+json;version=3.0":{"schema":{"type":"object"}},"text/html":{"schema":{"type":"string"}}},"description":"The formal documentation of this API according to the OpenAPI specification, version 3.0. I.e., this document."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Retrieve a single feature from the 'Countries' feature collection
OperationId
getFeature_vectordata_97c00dbf_e162_43b7_b9c3_009032dc7192
Tags
["Features"]
Description
Retrieve a feature; use content negotiation or specify a file extension to request HTML (.html or GeoJSON (.json)
Parameters
Name Description Type
{"$ref":"#/components/parameters/featureId"}
Responses
{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/featureGeoJSON"}},"text/html":{"schema":{"type":"string"}}},"description":"Retrieve a 'Countries' feature by 'featureId'."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Retrieve features of 'Countries' feature collection
OperationId
getFeatures_vectordata_97c00dbf_e162_43b7_b9c3_009032dc7192
Tags
["Features"]
Description
Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema. Use content negotiation or specify a file extension to request HTML (.html) or GeoJSON (.json).
Parameters
Name Description Type
{"$ref":"#/components/parameters/limit"}
fid Filter the collection by 'fid' integer
iso_a2 Filter the collection by 'iso_a2' string
NAME Filter the collection by 'NAME' string
FIPS_10_ Filter the collection by 'FIPS_10_' string
ISO_A3 Filter the collection by 'ISO_A3' string
WB_A2 Filter the collection by 'WB_A2' string
WB_A3 Filter the collection by 'WB_A3' string
Responses
{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/featureCollectionGeoJSON"}},"text/html":{"schema":{"type":"string"}}},"description":"Metadata about the collection 'Countries' shared by this API."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Describe the 'Countries' feature collection
OperationId
describeCollection_vectordata_97c00dbf_e162_43b7_b9c3_009032dc7192
Tags
["Capabilities"]
Description
Metadata about a feature collection.
Responses
{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collectionInfo"}},"text/html":{"schema":{"type":"string"}}},"description":"Metadata about the collection 'Countries' shared by this API."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Retrieve a single feature from the 'Countries' feature collection
OperationId
getFeature_vectordata_63227ab2_5dc5_4812_9645_7e20c3827563
Tags
["Features"]
Description
Retrieve a feature; use content negotiation or specify a file extension to request HTML (.html or GeoJSON (.json)
Parameters
Name Description Type
{"$ref":"#/components/parameters/featureId"}
Responses
{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/featureGeoJSON"}},"text/html":{"schema":{"type":"string"}}},"description":"Retrieve a 'Countries' feature by 'featureId'."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Retrieve features of 'Countries' feature collection
OperationId
getFeatures_vectordata_63227ab2_5dc5_4812_9645_7e20c3827563
Tags
["Features"]
Description
Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema. Use content negotiation or specify a file extension to request HTML (.html) or GeoJSON (.json).
Parameters
Name Description Type
{"$ref":"#/components/parameters/limit"}
fid Filter the collection by 'fid' integer
iso_a2 Filter the collection by 'iso_a2' string
NAME Filter the collection by 'NAME' string
FIPS_10_ Filter the collection by 'FIPS_10_' string
ISO_A3 Filter the collection by 'ISO_A3' string
WB_A2 Filter the collection by 'WB_A2' string
WB_A3 Filter the collection by 'WB_A3' string
Responses
{"200":{"content":{"application/geo+json":{"schema":{"$ref":"#/components/schemas/featureCollectionGeoJSON"}},"text/html":{"schema":{"type":"string"}}},"description":"Metadata about the collection 'Countries' shared by this API."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Describe the 'Countries' feature collection
OperationId
describeCollection_vectordata_63227ab2_5dc5_4812_9645_7e20c3827563
Tags
["Capabilities"]
Description
Metadata about a feature collection.
Responses
{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collectionInfo"}},"text/html":{"schema":{"type":"string"}}},"description":"Metadata about the collection 'Countries' shared by this API."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Metadata about the feature collections shared by this API.
OperationId
describeCollections
Tags
["Capabilities"]
Description
Describe the feature collections in the dataset statements and the metadata about the feature data in this dataset.
Responses
{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content"}},"text/html":{"schema":{"type":"string"}}},"description":"Describe the feature collections in the dataset statements and the metadata about the feature data in this dataset."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get Information about standards that this API conforms to
OperationId
getRequirementClasses
Tags
["Capabilities"]
Description
List all requirements classes specified in a standard (e.g., WFS 3.0 Part 1: Core) that the server conforms to
Responses
{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/root"}},"text/html":{"schema":{"type":"string"}}},"description":"List all requirements classes specified in a standard (e.g., WFS 3.0 Part 1: Core) that the server conforms to"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}
get WFS 3.0 Landing Page
OperationId
getLandingPage
Tags
["Capabilities"]
Description
The landing page provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.
Responses
{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/root"}},"text/html":{"schema":{"type":"string"}}},"description":"The landing page provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/exception"}},"text/html":{"schema":{"type":"string"}}},"description":"An error occurred."}}

Models

Type
object
Properties
Name Description Type Example
crs The coordinate reference systems in which geometries may be retrieved. Coordinate reference systems are identified by a URI. The first coordinate reference system is the coordinate reference system that is used by default. This is always "http://www.opengis.net/def/crs/OGC/1.3/CRS84", i.e. WGS84 longitude/latitude. array
  • http://www.opengis.net/def/crs/OGC/1.3/CRS84
  • http://www.opengis.net/def/crs/EPSG/0/4326
description a description of the features in the collection string Buildings in the city of Bonn.
extent {"$ref":"#/components/schemas/extent"}
links {"example":[{"href":"http://data.example.org/collections/buildings/items","rel":"item","title":"Buildings","type":"application/geo+json"},{"href":"http://example.com/concepts/buildings.html","rel":"describedBy","title":"Feature catalogue for buildings","type":"text/html"}],"items":{"$ref":"#/components/schemas/link"},"type":"array"}
name identifier of the collection used, for example, in URIs string buildings
relations Related collections that may be retrieved for this collection object {"id": "label"}
title human readable title of the collection string Buildings
Required
  • links
  • name
Type
object
Properties
Name Description Type Example
collections {"items":{"$ref":"#/components/schemas/collectionInfo"},"type":"array"}
links {"example":[{"href":"http://data.example.org/collections.json","rel":"self","title":"this document","type":"application/json"},{"href":"http://data.example.org/collections.html","rel":"alternate","title":"this document as HTML","type":"text/html"},{"href":"http://schemas.example.org/1.0/foobar.xsd","rel":"describedBy","title":"XML schema for Acme Corporation data","type":"application/xml"}],"items":{"$ref":"#/components/schemas/link"},"type":"array"}
Required
  • collections
  • links
Type
object
Properties
Name Description Type Example
code {"type":"string"}
description {"type":"string"}
Required
  • code
Type
object
Properties
Name Description Type Example
crs {"default":"http://www.opengis.net/def/crs/OGC/1.3/CRS84","description":"Coordinate reference system of the coordinates in the spatial extent (property `spatial`). In the Core, only WGS84 longitude/latitude is supported. Extensions may support additional coordinate reference systems.","enum":["http://www.opengis.net/def/crs/OGC/1.3/CRS84"],"type":"string"}
spatial West, north, east, south edges of the spatial extent. The minimum and maximum values apply to the coordinate reference system WGS84 longitude/latitude that is supported in the Core. If, for example, a projected coordinate reference system is used, the minimum and maximum values need to be adjusted. array
  • -180
  • -90
  • 180
  • 90
Required
  • spatial
Type
object
Properties
Name Description Type Example
features {"items":{"$ref":"#/components/schemas/featureGeoJSON"},"type":"array"}
links {"items":{"$ref":"#/components/schemas/link"},"type":"array"}
numberMatched {"minimum":0,"type":"integer"}
numberReturned {"minimum":0,"type":"integer"}
timeStamp {"format":"dateTime","type":"string"}
type {"enum":["FeatureCollection"],"type":"string"}
Required
  • features
  • type
Type
object
Properties
Name Description Type Example
geometry {"$ref":"#/components/schemas/geometryGeoJSON"}
id {"oneOf":[{"type":"string"},{"type":"integer"}]}
properties {"nullable":true,"type":"object"}
type {"enum":["Feature"],"type":"string"}
Required
  • geometry
  • properties
  • type
Type
object
Properties
Name Description Type Example
type {"enum":["Point","MultiPoint","LineString","MultiLineString","Polygon","MultiPolygon","GeometryCollection"],"type":"string"}
Required
  • type
Type
object
Properties
Name Description Type Example
conformsTo {"example":["http://www.opengis.net/spec/wfs-1/3.0/req/core","http://www.opengis.net/spec/wfs-1/3.0/req/oas30","http://www.opengis.net/spec/wfs-1/3.0/req/html","http://www.opengis.net/spec/wfs-1/3.0/req/geojson"],"items":{"type":"string"},"type":"array"}
Required
  • conformsTo
Type
object
Properties
Name Description Type Example
links {"example":[{"href":"http://data.example.org/","rel":"self","title":"this document","type":"application/json"},{"href":"http://data.example.org/api","rel":"service","title":"the API definition","type":"application/openapi+json;version=3.0"},{"href":"http://data.example.org/conformance","rel":"conformance","title":"WFS 3.0 conformance classes implemented by this server","type":"application/json"},{"href":"http://data.example.org/collections","rel":"data","title":"Metadata about the feature collections","type":"application/json"}],"items":{"$ref":"#/components/schemas/link"},"type":"array"}
Required
  • links