OGC map services reference

OGC map services endpoint authentication, parameters, request and response contracts.

Last updated:

On this pageGET /api/ogc/GET /api/ogc/conformanceGET /api/ogc/apiGET /api/ogc/wmsGET /api/ogc/collectionsGET /api/ogc/collections/{cid}GET /api/ogc/collections/{cid}/itemsGET /api/ogc/collections/{cid}/items/{fid}

Paths, methods, parameters and available schemas are generated from the OpenAPI document in the repository.

OGC connection and query examples

GET /api/ogc/

OGC publishing

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

For error meanings and client actions, see the error code glossary.

GET /api/ogc/conformance

Conformance classes

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

For error meanings and client actions, see the error code glossary.

GET /api/ogc/api

OGC OpenAPI 3.0 schema

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

For error meanings and client actions, see the error code glossary.

GET /api/ogc/wms

WMS 1.3.0 map service

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

For error meanings and client actions, see the error code glossary.

GET /api/ogc/collections

Accessible collections

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

For error meanings and client actions, see the error code glossary.

GET /api/ogc/collections/{cid}

Collection

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Parameters

NameLocationTypeRequired
cidpathstringYes

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

GET /api/ogc/collections/{cid}/items

Collection features

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Parameters

NameLocationTypeRequired
cidpathstringYes
bboxquerystring | nullNo
bbox-crsquerystring | nullNo
crsquerystring | nullNo
datetimequerystring | nullNo
limitquerystring | nullNo
afterquerystringNo

Responses

HTTP 200

application/geo+json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

GET /api/ogc/collections/{cid}/items/{fid}

Single collection feature

Authentication: Access key (Bearer or Basic). Scope: Project read scope.

Parameters

NameLocationTypeRequired
cidpathstringYes
fidpathstringYes
crsquerystring | nullNo

Responses

HTTP 200

application/geo+json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.