Landing page¶
Landing page
Operation ID: getLandingPage
Authorization: None
Query parameters¶
The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. Allowed values: `json`, `html`, `jsonld`. Default: `json`.
The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. Allowed values: `en-US`, `fr-CA`. Default: `en-US`.
Responses¶
The landing page provides links to the API definition (link relations service-desc and service-doc), the Conformance declaration (path /conformance, link relation conformance), and the Feature Collections (path /collections, link relation data).
Content type: application/json
Schema: ogcapi-features-1__landingPage
Properties
| Property | Type | Required | Description |
|---|---|---|---|
title | string | No | — |
description | string | No | — |
links | array of ogcapi-features-1__link | Yes | — |
Example
{
"title": "Buildings in Bonn",
"description": "Access to data about buildings in the city of Bonn via a Web API that conforms to the OGC API Features specification.",
"links": [
{
"href": "http://data.example.org/",
"rel": "self",
"type": "application/json",
"title": "this document"
},
{
"href": "http://data.example.org/api",
"rel": "service-desc",
"type": "application/vnd.oai.openapi+json;version=3.0",
"title": "the API definition"
},
{
"href": "http://data.example.org/api.html",
"rel": "service-doc",
"type": "text/html",
"title": "the API documentation"
},
{
"href": "http://data.example.org/conformance",
"rel": "conformance",
"type": "application/json",
"title": "OGC API conformance classes implemented by this server"
},
{
"href": "http://data.example.org/collections",
"rel": "data",
"type": "application/json",
"title": "Information about the feature collections"
}
]
}
Content type: text/html
Schema: string
Example
A query parameter has an invalid value.
Content type: application/json
Schema: ogcapi-features-1__exception
Properties
| Property | Type | Required | Description |
|---|---|---|---|
code | string | Yes | — |
description | string | No | — |
Example
Content type: text/html
Schema: string
Example