Process endpoints for creating and mutating packages, offers, and refunds.
Assign asset to package leg
Assigns an asset to a specific package leg.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Assign asset to package leg › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Assign asset to package leg › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Add traveller to package
Adds a traveller to an existing package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Add traveller to package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Add traveller to package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Search available travel offers
Searches for available offers based on travel and traveller criteria.
query Parameters
limitThe optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.
offsetThe optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.
bboxOnly features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional)
If the value consists of four numbers, the coordinate reference system is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84)
unless a different coordinate reference system is specified in the parameter bbox-crs.
If the value consists of six numbers, the coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h) unless a different coordinate reference system is specified in the parameter bbox-crs.
The query parameter bbox-crs is specified in OGC API - Features - Part 2: Coordinate Reference Systems by Reference.
For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude.
However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).
If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box.
If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Search available travel offers › Request Body
A package planning request, resulting in package options
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Search available travel offers › Responses
a search offer response
type^(OfferCollection)$ · requiredactions that can be performed on this package, but also alternative (rel=alternative+1, alternative+2) offers or references to other resources In case it is an alternative, specify clearly in the description what the financial consequences are.
numberMatchednumberReturnedCreate draft package from selected offers
Creates or updates a draft package from selected offer identifiers.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Create draft package from selected offers › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Create draft package from selected offers › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Cancel package
Cancels an existing purchased or reserved package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Cancel package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Cancel package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Confirm package before purchase
Confirms a package before final purchase.
query Parameters
limitThe optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.
offsetThe optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.
bboxOnly features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional)
If the value consists of four numbers, the coordinate reference system is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84)
unless a different coordinate reference system is specified in the parameter bbox-crs.
If the value consists of six numbers, the coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h) unless a different coordinate reference system is specified in the parameter bbox-crs.
The query parameter bbox-crs is specified in OGC API - Features - Part 2: Coordinate Reference Systems by Reference.
For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude.
However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).
If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box.
If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Confirm package before purchase › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Confirm package before purchase › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Purchase selected offers directly
Purchases selected offers directly and returns the resulting package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Purchase selected offers directly › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Purchase selected offers directly › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Release package reservation
Releases a package reservation.
query Parameters
limitThe optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.
offsetThe optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.
bboxOnly features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional)
If the value consists of four numbers, the coordinate reference system is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84)
unless a different coordinate reference system is specified in the parameter bbox-crs.
If the value consists of six numbers, the coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h) unless a different coordinate reference system is specified in the parameter bbox-crs.
The query parameter bbox-crs is specified in OGC API - Features - Part 2: Coordinate Reference Systems by Reference.
For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude.
However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).
If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box.
If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Release package reservation › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Release package reservation › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Assign ancillary products to package
Assigns ancillary products to a package or a package leg.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Assign ancillary products to package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Assign ancillary products to package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Purchase existing package
Purchases a previously created package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Purchase existing package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Purchase existing package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Remove traveller from package
Removes a traveller from an existing package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Remove traveller from package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Remove traveller from package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Update traveller in package
Updates traveller details in an existing package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Update traveller in package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Update traveller in package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Extend package reservation expiry
Extends the expiry time for a reserved package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Extend package reservation expiry › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Extend package reservation expiry › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Claim refund option for package
Claims a refund option for the selected package content.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
Entur-POSPoint-of-sale identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Claim refund option for package › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Claim refund option for package › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Confirm claimed refund option
Confirms a previously claimed refund option.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Confirm claimed refund option › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Confirm claimed refund option › Responses
a geojson response, containing the package details in the main properties and the legs are represented in the features
type^(package)$ · requiredan amount of money, usable in fares, fare calculations or in extra costs.
statusThe life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.
use an ID contained in the placeDefinitions field, or from an external source, when using coordinates, please use the prefix 'gps:'
endTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
startTimehttps://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)
Places that are not specified in an external data source (like a home address)
idguaranteesexternalReferencedefault string, full names etc (length 0-200)
Update travel document validity start
Updates the validity start time for a travel document in a package.
Headers
Accept-Languageshort string, display names (length 0-75)
authorizationHeader field, JWT must be supplied
Entur-Distribution-ChannelDistribution channel identifier used by downstream sales and ticket distribution services.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Client-NameEncouraged for tracing and routing, but not required.
Entur-Log-LevelOptional request-scoped logging level. OMSA forwards the effective value to downstream APIs that support request-level logging.
Update travel document validity start › Request Body
Optional URIs for callbacks for this job.
Support for this parameter is not required and the parameter may be
removed from the API definition, if conformance class 'callback'
is not listed in the conformance declaration under /conformance.
Update travel document validity start › Responses
Validity updated successfully.
newTravelDocumentIdThe new travel document id with updated validity
previousTravelDocumentIdThe travel document id that was replaced