discovery

Server

Discovery endpoints for landing page, conformance, and API metadata.

Get API landing page

GET

https://api.entur.io/omsa/v1

Gives 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.

Get API landing page › query Parameters

f

string · enum · style: form

The optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON.

Enum values:

json

html

Default: json

Get API landing page › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Get API landing page › Responses

The reponse containing a landing page

landingPage

link[] · required

title

string

description

string

attribution

string

The attribution 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.

GET/

curl https://api.entur.io/omsa/v1 \
  --header 'Accept-Language: <string>' \
  --header 'Authorization: None <token>'

Example Responses

{
  "title": "Example processing server",
  "description": "Example server implementing the OGC API - Processes 1.0 Standard",
  "attribution": "attribution",
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

Get OpenAPI specification document

GET

https://api.entur.io/omsa/v1

/api

Returns this OpenAPI document in JSON or YAML format.

Get OpenAPI specification document › query Parameters

f

string · enum · style: form · explode: true

Output format for the OpenAPI document.

Enum values:

json

yaml

yml

Default: json

Get OpenAPI specification document › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get OpenAPI specification document › Responses

General Success response.

string

Get API conformance declaration

GET

https://api.entur.io/omsa/v1

/conformance

A list of all conformance classes specified in a standard that the server conforms to.

Get API conformance declaration › query Parameters

f

string · enum · style: form

The optional f parameter indicates the output format that the server shall provide as part of the response document. The default format is JSON.

Enum values:

json

html

Default: json

Get API conformance declaration › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get API conformance declaration › Responses

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.

confClasses

conformsTo

string[] · required

List available collections

GET

https://api.entur.io/omsa/v1

/collections

returns a collection of available collection (like offers, packages, legs, support-requests and payments)

List available collections › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

List available collections › Responses

A list of available collections

collections

link[] · required

collectionInfo[] · required

timeStamp

string · date-time

numberMatched

integer · min: 0

numberReturned

integer · min: 0

GET/collections

curl https://api.entur.io/omsa/v1/collections \
  --header 'Authorization: None <token>'

Example Responses

{
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ],
  "timeStamp": "2024-08-25T15:00:00Z",
  "numberMatched": 1,
  "numberReturned": 1,
  "collections": [
    {
      "id": "dem",
      "title": "Digital Elevation Model",
      "description": "A Digital Elevation Model.",
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ],
      "extent": {},
      "itemType": "unknown",
      "crs": [
        "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
      ],
      "dataType": "string",
      "geometryDimension": 0,
      "minScaleDenominator": 0,
      "maxScaleDenominator": 0,
      "minCellSize": 0,
      "maxCellSize": 0
    }
  ]
}

json

application/json

Get collection metadata

GET

https://api.entur.io/omsa/v1

/collections/{collectionId}

a (machine or human) readable description of this collection

Get collection metadata › path Parameters

collectionId

string · required · style: simple

local identifier of a collection

Get collection metadata › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get collection metadata › Responses

description of data delivered by this collection

collectionInfo

id

string · required

identifier of the collection used, for example, in URIs

Example: dem

link[] · required

title

string

human readable title of the collection

Example: Digital Elevation Model

description

string

a description of the data in the collection

Example: A Digital Elevation Model.

extent

object

itemType

string

indicator about the type of the items in the collection if the collection has an accessible /collections/{collectionId}/items endpoint

Default: unknown

crs

string[]

the list of coordinate reference systems supported by the API; the first item is the default coordinate reference system

Example: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84","http://www.opengis.net/def/crs/EPSG/0/4326"]

Default: ["http://www.opengis.net/def/crs/OGC/1.3/CRS84"]

dataType

geometryDimension

integer · min: 0 · max: 3

The geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown

minScaleDenominator

number

Minimum scale denominator for usage of the collection

maxScaleDenominator

number

Maximum scale denominator for usage of the collection

minCellSize

number

Minimum cell size for usage of the collection

maxCellSize

number

Maximum cell size for usage of the collection

GET/collections/{collectionId}

curl https://api.entur.io/omsa/v1/collections/:collectionId \
  --header 'Accept-Language: <string>' \
  --header 'Authorization: None <token>'

Example Responses

{
  "id": "dem",
  "title": "Digital Elevation Model",
  "description": "A Digital Elevation Model.",
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ],
  "extent": {},
  "itemType": "unknown",
  "crs": [
    "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
  ],
  "dataType": "string",
  "geometryDimension": 0,
  "minScaleDenominator": 0,
  "maxScaleDenominator": 0,
  "minCellSize": 0,
  "maxCellSize": 0
}

json

List available processes

GET

https://api.entur.io/omsa/v1

/processes

The 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.

List available processes › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

List available processes › Responses

Information about the available processes

processList

processSummary[] · required

link[] · required

GET/processes

curl https://api.entur.io/omsa/v1/processes \
  --header 'Accept-Language: <string>' \
  --header 'Authorization: None <token>'

Example Responses

{
  "processes": [
    {
      "title": "title",
      "description": "description",
      "keywords": [
        "string"
      ],
      "metadata": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ],
      "id": "id",
      "version": "version",
      "jobControlOptions": [
        "sync-execute"
      ],
      "links": [
        {
          "rel": "rel",
          "href": "https://www.example.com/path/to/resource",
          "type": "type",
          "method": "POST",
          "description": "description",
          "body": {},
          "headers": {
            "key": "string"
          },
          "isMandatory": true,
          "hash": "hash",
          "validity": {
            "type": "type",
            "startTime": "2024-08-25T15:00:00Z",
            "endTime": "2024-08-25T15:00:00Z",
            "duration": 0,
            "dayType": "MON"
          }
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "rel",
      "href": "https://www.example.com/path/to/resource",
      "type": "type",
      "method": "POST",
      "description": "description",
      "body": {},
      "headers": {
        "key": "string"
      },
      "isMandatory": true,
      "hash": "hash",
      "validity": {
        "type": "type",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "duration": 0,
        "dayType": "MON"
      }
    }
  ]
}

json

application/json

Get process description

GET

https://api.entur.io/omsa/v1

/processes/{processID}

The 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.

Get process description › path Parameters

processID

string · enum · required · style: simple

Enum values:

search-offers

select-offers

add-traveller

update-traveller

remove-traveller

assign-asset

assign-ancillary

purchase-offers

Get process description › Headers

Accept-Language

shortString · maxLength: 75 · required · style: simple

short string, display names (length 0-75)

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get process description › Responses

A process description.

collections

Did you find what you were looking for?

discovery

Get API landing page

Get API landing page › query Parameters

Get API landing page › Headers

Get API landing page › Responses

Get OpenAPI specification document

Get OpenAPI specification document › query Parameters

Get OpenAPI specification document › Headers

Get OpenAPI specification document › Responses

Get API conformance declaration

Get API conformance declaration › query Parameters

Get API conformance declaration › Headers

Get API conformance declaration › Responses

List available collections

List available collections › Headers

List available collections › Responses

Get collection metadata

Get collection metadata › path Parameters

Get collection metadata › Headers

Get collection metadata › Responses

List available processes

List available processes › Headers

List available processes › Responses

Get process description

Get process description › path Parameters

Get process description › Headers

Get process description › Responses

Build with Entur

Contribute

Terms & Policies