home
modules
URLS to comply to OGC, to describe the interface
Landing pageGives a (technical & human readable) output describing how this API must be used. If the parameter f=html is supplied, a human readable page must be responded.
Parameters
| Name | In | Type | Required | Description |
|---|
f | query | string | | The optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON. |
Responses
| Code | Content type | Type | Description |
|---|
| 200 | application/json | landingPage | The reponse containing a landing page |
GET /api
This documentThis document
Parameters
| Name | In | Type | Required | Description |
|---|
f | query | string | | The optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON. |
Responses
| Code | Content type | Type | Description |
|---|
the feature collections in the datasetreturns a collection of available collection (like offers, packages, legs, support-requests and payments)
Responses
| Code | Content type | Type | Description |
|---|
| 200 | application/json | collections | A list of available collections |
GET /collections/{collectionId}?collectionId=... -> collection
describe the feature collection with id `collectionId`a (machine or human) readable description of this collection
Parameters
| Name | In | Type | Required | Description |
|---|
collectionId | path | string | ✓ | local identifier of a collection |
Responses
| Code | Content type | Type | Description |
|---|
| 200 | application/json | collection | description of data delivered by this collection |
API conformance definitionA list of all conformance classes specified in a standard that the server conforms to.
Parameters
| Name | In | Type | Required | Description |
|---|
f | query | string | | The optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON. |
Responses
| Code | Content type | Type | Description |
|---|
| 200 | application/json | conformance | The URIs of all conformance classes supported by the server. |
To support "generic" clients that want to access multiple
OGC API Features implementations - and not "just" a specific
API / server, the server declares the conformance
classes it implements and conforms to.
retrieve the list of available processesThe list of processes contains a summary of each process the OGC API - Processes offers, including the link to a more detailed description of the process. For more information, see
Section 7.9.
Responses
| Code | Content type | Type | Description |
|---|
| 200 | application/json | processList | Information about the available processes |
GET /processes/{processID}?processID=... -> process
retrieve a process descriptionThe process description contains information about inputs and outputs and a link to the execution-endpoint for the process. The Core does not mandate the use of a specific process description to specify the interface of a process. That said, the Core requirements class makes the following _recommendation_ implementations SHOULD consider supporting the OGC process description. For more information, see
Section 7.10.
Parameters
| Name | In | Type | Required | Description |
|---|
processID | path | string | ✓ | |
Responses
| Code | Content type | Type | Description |
|---|
| 200 | application/json | process | A process description. |