Entur Developer
Seating manager
Seating manager

reservation-controller

Download schema

GET
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}

path Parameters

reference
​string · uuid · required · style: simple

The reference of the reservation that will be fetched

The reference of the reservation that will be fetched

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a

Headers

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

Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Update a reservation with reservation lines

PUT
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}

Update a reservation with reservation lines.

The draft reservation version containing only the requested reservation lines will be returned.

If reservationLineRequests (body) is empty, then the draft reservation will contain no reservation lines.

Update a reservation with reservation lines › path Parameters

reference
​string · uuid · required · style: simple

The reference of the reservation that will be updated.

The reference of the reservation that will be updated.

Update a reservation with reservation lines › Headers

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

Update a reservation with reservation lines › Request Body

`reservationLine` details for the updated reservation. These reservationsLines will completely replace the existing reservationLines on the existing reservation.
ReservationLineRequest
type
​string · required

The type of reservation line.

Example: SINGLE_SEAT
reference
​string · uuid

The reference of the reservation line if already existing. Leave blank for new reservation lines.

orderLineId
​string

OrderLine ID for this reservation line`

Example: d4a599f6-6b0b-473f-a182-79f87a4a8689
numberOfTravellers
​integer · int32

Number of travellers on the reservation line.

Example: 2

Update a reservation with reservation lines › Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

PATCH
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}

path Parameters

reference
​string · uuid · required · style: simple

The reference of the reservation that will be updated.

The reference of the reservation that will be updated.

Headers

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

Request Body

ReservationUpdateRequest
checkOrderStatusHistory
​boolean · required

A flag to be used by internal clients, if true, check if the order has ever been CONFIRMED, should not change reservation status to CONFIRMED if order has never been CONFIRMED

Example: true
status
​string | null · enum

The new reservation status. Mutually exclusive with rebookingStatus.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: CONFIRMED
rebookingStatus
​string | null · enum

The new rebooking status. Mutually exclusive with status.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
info
​string | null

Optional information that can be added when patching rebookingStatus to REJECTED.

Example: No seats available.
sendNotification
​boolean | null

Whether to send rebooking/replaced notification messages on Kafka when confirming. Defaults to true.

Example: true

Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

GET
https://api.entur.io/seating-manager
/v1-beta/reservations

query Parameters

datedServiceJourneyId
​string · required · style: form · explode: true

The datedServiceJourney of the reservation that will be fetched

reservationStatus
​string · enum · style: form · explode: true

The reservation status of the reservation that will be fetched. Defaults to DRAFT and CONFIRMED.

The reservation status of the reservation that will be fetched. Defaults to DRAFT and CONFIRMED.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT,CONFIRMED
rebookingStatuses
​string[] · style: form · explode: true

The rebooking statuses of the reservation that will be fetched. Defaults to all.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
NONE
updatedAfter
​string · date-time · style: form · explode: true
origin
​string · style: form · explode: true

NSR code of the origin stop place. When combined with destination, returns only reservations onboard the requested leg.

destination
​string · style: form · explode: true

NSR code of the destination stop place. When combined with origin, returns only reservations onboard the requested leg.

Headers

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

Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Create a reservation from origin to destination on a DatedServiceJourney

POST
https://api.entur.io/seating-manager
/v1-beta/reservations

This endpoint can be used to create a reservation, optionally with the supplied reservation linesAn organisation id will be stored, this id determined by the authentication used by the client

Create a reservation from origin to destination on a DatedServiceJourney › query Parameters

ownerOrganisationId
​integer · int64 · style: form · explode: true

The organisation to be set as owner of the reservation. Only Entur may specify ownerOrganisation, otherwise the requesting organisation will be set as owner of the reservation.

The organisation to be set as owner of the reservation. Only Entur may specify ownerOrganisation, otherwise the requesting organisation will be set as owner of the reservation.

Example: 1

Create a reservation from origin to destination on a DatedServiceJourney › Headers

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

Create a reservation from origin to destination on a DatedServiceJourney › Request Body

CreateReservationRequest
originNsrCode
​string · minLength: 1 · required

The nsrCode of the origin stop place

Example: NSR:StopPlace:337
destinationNsrCode
​string · minLength: 1 · required

The nsrCode of the destination stop place

Example: NSR:StopPlace:548
datedServiceJourneyId
​string · minLength: 1 · required

The id of the dated service journey which the reservation belongs to.

Example: ENT:DatedServiceJourney:4788391
​ReservationLineRequest[] · required
reference
​string | null · uuid

If supplied this id will be used as reference for this reservation. If not it will be generated automatically.

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
orderId
​string | null

An orderId that can be used for lookup purposes

Example: A1B2C3D4
status
​string · enum

The status to set for the reservation.

Enum values:
DRAFT
CONFIRMED
Example: DRAFT
Default: DRAFT

Create a reservation from origin to destination on a DatedServiceJourney › Responses

Created

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Replace reservation lines

POST
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}/reservation-lines/replace
Code
      Replace existing reservation lines connected with new allocated reservation lines.

Replace reservation lines › path Parameters

reference
​string · uuid · required · style: simple

UUID for the reservation we want to replace reservationLines on.

Replace reservation lines › Headers

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

Replace reservation lines › Request Body

Request body detailing which reservation lines to remove and what should replace them
ReplaceReservationLinesRequest
​CreateReservationLinesBySeatingPropertiesRequest[] · required

List of SeatingProperties to allocate for.

reservationLinesToRemove
​string[] · required

List of reservationLine-references to remove.

Replace reservation lines › Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Add reservation lines

POST
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}/reservation-line
Code
      Adds reservation lines connected to the given reservation.
      The response is a list of all reservation lines that exists on the reservation after adding the ones in the request.

Add reservation lines › path Parameters

reference
​string · uuid · required · style: simple

UUID for the reservation we want to add reservation lines to.

Add reservation lines › query Parameters

groupOverride
​boolean · style: form · explode: true
Default: false

Add reservation lines › Headers

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

Add reservation lines › Request Body

List with reservation lines to add

List of SeatingProperties to allocate for.
CreateReservationLinesBySeatingPropertiesRequest
​SeatingPropertiesRequestV1 · required

Properties of a seat. They describe both physical and logical properties of a seat.Physical properties are for example position of the seat.Logical properties describe properties that the operator use when selling the seat. For example fare class.

numberOfTravellers
​integer | null · int32

The properties required by the traveller(s).

mustReserveWholeCompartment
​boolean

Whether to reserve a whole compartment to this traveller. If not provided, or set to false, a single seat with the provided properties will be reserved instead.

Example: true
Default: false
orderLineId
​string | null

OrderLine ID to reserve seats for

Example: d4a599f6-6b0b-473f-a182-79f87a4a8689

Add reservation lines › Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Remove reservation lines

DELETE
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}/reservation-line
Code
      Removes reservation lines connected to the given reservation.
      The response is a list of UUIDs representing the reservation line references that got removed.

Remove reservation lines › path Parameters

reference
​string · uuid · required · style: simple

UUID for the reservation we want to remove reservation lines from.

Remove reservation lines › Headers

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

Remove reservation lines › Request Body

​string[]

List with UUIDs of reservation lines to cancel

Remove reservation lines › Responses

200

OK

​string[]

Notifies customer about rebooked seats

POST
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}/rebooking-notification
Code
      Triggers a notification to the customer about rebooked seats.

Notifies customer about rebooked seats › path Parameters

reference
​string · uuid · required · style: simple

UUID for the reservation we want to trigger a notification for.

Notifies customer about rebooked seats › Headers

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

Notifies customer about rebooked seats › Responses

No Content

No data returned

Create reservation and reserve seats by seating properties

POST
https://api.entur.io/seating-manager
/v1-beta/reservations/allocate

Create reservation and reserve seats allocated by seating properties. If the optional orderLineId is provided for a set of seating properties, the reservation line(s) allocated by the seating properties will be associated to the orderLineId

Create reservation and reserve seats by seating properties › query Parameters

ownerOrganisationId
​integer · int64 · style: form · explode: true

The organisation to be set as owner of the reservation. Only Entur may specify ownerOrganisation, otherwise the requesting organisation will be set as owner of the reservation.

The organisation to be set as owner of the reservation. Only Entur may specify ownerOrganisation, otherwise the requesting organisation will be set as owner of the reservation.

Example: 1

Create reservation and reserve seats by seating properties › Headers

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

Create reservation and reserve seats by seating properties › Request Body

CreateReservationBySeatingPropertiesRequest
originNsrCode
​string · required

The nsrCode of the origin stop place

Example: NSR:StopPlace:337
destinationNsrCode
​string · required

The nsrCode of the destination stop place

Example: NSR:StopPlace:548
datedServiceJourneyId
​string · required

The id of the dated service journey which the reservation belongs to.

Example: ENT:DatedServiceJourney:4788391
status
​string · enum · required

The status to set for the reservation.

Enum values:
DRAFT
CONFIRMED
Example: DRAFT
​CreateReservationLinesBySeatingPropertiesRequest[] · required

List of traveler seating properties to reserve seats or compartments for, with optional associated orderLineId.

orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4

Create reservation and reserve seats by seating properties › Responses

Created

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Create reservations for a sequence of legs and reserve seats by seating properties

POST
https://api.entur.io/seating-manager
/v1-beta/reservations/allocate/trip

Create reservation and reserve seats allocated by seating properties. If the optional orderLineId is provided for a set of seating properties, the reservation line(s) allocated by the seating properties will be associated to the orderLineId

Create reservations for a sequence of legs and reserve seats by seating properties › Headers

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

Create reservations for a sequence of legs and reserve seats by seating properties › Request Body

Request to create a trip reservation by seating properties.
CreateTripReservationBySeatingPropertiesRequest
originalDatedServiceJourneyId
​string · required

Original dated service journey ID.

​LegRequest[] · required
​CreateTripReservationLinesBySeatingPropertiesRequest[] · required
orderId
​string | null

Order ID for the reservation.

status
​string · enum

Initial status of the reservation.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED

Create reservations for a sequence of legs and reserve seats by seating properties › Responses

Created

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Update a reservation line in a reservation

PATCH
https://api.entur.io/seating-manager
/v1-beta/reservations/{reference}/reservation-lines/{reservationLineReference}

Update a reservation line in a reservation.

The result will depend on the reservation status.

  • ReservationStatus:DRAFT : The draft reservation version will contain the updated reservation line and existing lines.
  • ReservationStatus:CONFIRMED : A new draft reservation version containing only the updated reservation line.
  • ReservationStatus:CANCELLED : No operation.

Update a reservation line in a reservation › path Parameters

reference
​string · uuid · required · style: simple

The reference of the reservation the reservation that will be updated.

reservationLineReference
​string · uuid · required · style: simple

The reference of the reservationLine to be updated.

Update a reservation line in a reservation › Headers

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

Update a reservation line in a reservation › Request Body

PatchReservationLineRequest
type
​string · required

The type of reservation line.

Example: SINGLE_SEAT
elementCarriageNumber
​integer · int32

The carriage number of the element of the seat being reserved on this reservationLine.

Example: 1
elementCarriageIdentifier
​string

The carriage identifier of the element of the seat being reserved on this reservationLine.

Example: 1
orderLineId
​string

OrderLine ID for this reservation line`

Example: d4a599f6-6b0b-473f-a182-79f87a4a8689

Update a reservation line in a reservation › Responses

200

OK

ReservationLineResponse
reference
​string · uuid · required

Reference for this reservation line`

reservedProperties
​string[] · required
​SeatingPropertiesResponseV1 · required

Properties of a seat. They describe both physical and logical properties of a seat.Physical properties are for example position of the seat.Logical properties describe properties that the operator use when selling the seat. For example fare class.

requestedProperties
​string[] · required
​SeatingPropertiesResponseV1 · required

Properties of a seat. They describe both physical and logical properties of a seat.Physical properties are for example position of the seat.Logical properties describe properties that the operator use when selling the seat. For example fare class.

type
​string · required

The type of reservation line.

Example: SINGLE_SEAT
orderLineId
​string

OrderLine ID for this reservation line.

Example: d4a599f6-6b0b-473f-a182-79f87a4a8689
numberOfTravellers
​integer · int32

Number of travellers on the reservation line.

Example: 2

Fetch grouped reservations for a travel intention

GET
https://api.entur.io/seating-manager
/v1-beta/reservations/travel-intentions/{originalDatedServiceJourneyId}
Code
        Fetches all travel intentions connected to the given original dated service journey id, grouped by travel intention reference with their full rebooking history. 
        Each group contains all versions of the travel intention and the reservations belonging to each version. Filters on reservation status and rebooking status are 
        applied only to the latest version of each travel intention — groups where the latest version does not match are excluded entirely. The fullHistory parameter 
        controls how many versions are included per group: when true (default), all versions are returned; when false, only the two most recent versions are returned.

Fetch grouped reservations for a travel intention › path Parameters

originalDatedServiceJourneyId
​string · required · style: simple

The ID of the original dated service journey — the departure the travel intentions were initially created for and that connects all related travel intentions and their reservations together.

Fetch grouped reservations for a travel intention › query Parameters

reservationStatus
​string[] · style: form · explode: true

The reservation status to filter on. If not specified, all statuses are included.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
rebookingStatusFilter
​string[] · style: form · explode: true

The rebooking statuses to filter on. Defaults to all statuses if not specified.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
NONE
fullHistory
​boolean · style: form · explode: true

Whether to return the full version history of each travel intention. If false, only the two most recent versions are returned. Defaults to full history.

Default: true

Fetch grouped reservations for a travel intention › Headers

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

Fetch grouped reservations for a travel intention › Responses

200

OK

TravelIntentionResponseV1
travelIntentionReference
​string · uuid · required
​TravelIntentionVersionResponseV1[] · required

GET
https://api.entur.io/seating-manager
/v1-beta/reservations/reservation-line/{reservationLineReference}

path Parameters

reservationLineReference
​string · uuid · required · style: simple

The reference of the reservation line that will be fetched

Headers

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

Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Get reservations by orderId

GET
https://api.entur.io/seating-manager
/v1-beta/reservations/orderId/{orderId}

Fetches the newest version of all reservations connected to the orderId

Get reservations by orderId › path Parameters

orderId
​string · required · style: simple

The orderId of the reservations that will be fetched

Get reservations by orderId › query Parameters

reservationStatuses
​string[] · style: form · explode: true

Optional reservation statuses to filter on. If not supplied, defaults to DRAFT, CONFIRMED and CANCELLED, falling back to DEPRECATED if no active reservations exist for the orderId

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED

Get reservations by orderId › Headers

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 reservations by orderId › Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

Get all versions of reservation

GET
https://api.entur.io/seating-manager
/v1-beta/reservations/debug/{reference}

Fetches all versions of reservation with given reference

Get all versions of reservation › path Parameters

reference
​string · uuid · required · style: simple

The reference of the reservation that will be fetched with all versions

Get all versions of reservation › Headers

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 all versions of reservation › Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.

GET
https://api.entur.io/seating-manager
/v1-beta/reservations/by-statuses

query Parameters

datedServiceJourneyId
​string · required · style: form · explode: true

The datedServiceJourney of the reservation that will be fetched

reservationStatus
​string[] · style: form · explode: true

The reservation status of the reservations that will be fetched. Defaults to DRAFT and CONFIRMED.

The reservation status of the reservations that will be fetched. Defaults to DRAFT and CONFIRMED.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT,CONFIRMED
rebookingStatuses
​string[] · style: form · explode: true

The rebooking statuses of the reservation that will be fetched. Defaults to all.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
NONE
updatedAfter
​string · date-time · style: form · explode: true
origin
​string · style: form · explode: true

NSR code of the origin stop place. When combined with destination, returns only reservations onboard the requested stretch.

destination
​string · style: form · explode: true

NSR code of the destination stop place. When combined with origin, returns only reservations onboard the requested stretch.

Headers

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

Responses

200

OK

ReservationResponse
version
​integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1
​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

​StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId
​string · minLength: 1 · required

Id of the dated service journey

status
​string · enum · minLength: 1 · required

Describes the reservation status.

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Example: DRAFT
reference
​string · uuid · minLength: 1 · required

The reference for this reservation

Example: c129cc9c-76e4-4f28-a4e2-5af96550627a
organisationId
​integer · int64 · required

The organisation id of the order which the reservation belongs to.

Example: 20
createdAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00
versionedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00
updatedAt
​string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this was previously updated. This includes status changes, reservation line changes and so on.

Example: 2011-12-03T10:15:30+01:00
​ReservationLineResponse[] · required
createdBy
​integer · int64 · required

The organisation id this version of the reservation was created by.This id is determined by the authentication used by the client.

Example: 20
rebookingStatus
​string | null · enum

Describes the rebooking status of the reservation.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
Example: ACCEPTED
orderId
​string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4
updatedBy
​integer | null · int64

The organisation id of the organisation that last updated this reservation.This id is determined by the authentication used by the client.

Example: 20
info
​string | null

Additional free text information about the reservation.

Example: Unable to rebook this reservation due to no available seats.
seating-offer-controllerthird-party-reservation-controller
Did you find what you were looking for?