Schemas latest | Entur for Developers

ReservationLineRequest

`reservationLine` details for the updated reservation. These reservationsLines will completely replace the existing reservationLines on the existing reservation.

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

SingleSeatReservationLineRequest

`reservationLine` details for the updated reservation. These reservationsLines will completely replace the existing reservationLines on the existing reservation.

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

seatNumber

string · required

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

Example: 1

elementCarriageNumber

integer · int32 · required

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

Example: 1

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

elementCarriageIdentifier

string

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

Example: 1

FreeSeatingReservationLineRequest

`reservationLine` details for the updated reservation. These reservationsLines will completely replace the existing reservationLines on the existing reservation.

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

elementCarriageIdentifier

string

The carriage identifier for the free seating being reserved on this reservationLine.

Example: 1

CompartmentReservationLineRequest

`reservationLine` details for the updated reservation. These reservationsLines will completely replace the existing reservationLines on the existing reservation.

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

compartmentName

string · required

Logical name of the compartment.

Example: 10

elementCarriageNumber

integer · int32 · required

The carriage number of the element containing the compartment.

Example: 1

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

elementCarriageIdentifier

string

The carriage identifier of the element containing the compartment.

Example: 1

orderLineIds

string[]

Order line ids for each single seat if the compartment is changed from several single seats. If not, leave empty

Example: ["11sdw-1234-5678-90ab-cdef12345678","11sdw-1234-5678-90ab-cdef12345678"]

FailedRebookingReservationLineRequest

`reservationLine` details for the updated reservation. These reservationsLines will completely replace the existing reservationLines on the existing reservation.

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

information

string

Information as to why rebooking failed. This field is immutable.

reservedProperties

string[]

previousType

string

The previous type of reservation line.

Example: SINGLE_SEAT

previousElementCarriageIdentifier

string

The carriage number of the carriage of the seat or compartment previously reserved on this reservationLine.

Example: 1

previousSeatNumber

string

The seat number of the seat previously reserved on this reservationLine if it was a SingleSeatReservationLine.

Example: 1

previousCompartmentName

string

Logical name of the compartment previously reserved on this reservationLine if it was a CompartmentReservationLine.

Example: 10

previousOrderLineIds

string[]

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

SingleSeatReservationLineResponse

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

seatNumber

string · required

Seat number of this seat. This relates to the seat marker on the actual vehicle.

Example: S12

elementCarriageIdentifier

string · required

Carriage identifier of the corresponding carriage.

Example: 3

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

elementCarriageNumber

integer · int32

Carriage number of the corresponding carriage.

Example: 3

CompartmentReservationLineResponse

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

compartmentName

string · required

Logical name of the compartment.

Example: 10

elementCarriageIdentifier

string · required

Carriage number of the element in which the compartment resides.

Example: 1

seatsInCompartment

string[] · required

All seatNumbers located in compartment.

Example: ["1","2","3"]

orderLineIds

string[] · required

List of order line ids for if the compartment was changed from several single seats. If not, it should be empty.

Example: ["11sdw-1234-5678-90ab-cdef12345678","11sdw-1234-5678-90ab-cdef12345678"]

compartmentLabel

string · required

String of seats in the compartment.

Example: Kupe 11, 12, 13, 14, 15, 16

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

elementCarriageNumber

integer · int32

Carriage number of the element in which the compartment resides.

Example: 1

FreeSeatingReservationLineResponse

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

elementCarriageIdentifier

string

Carriage identifier of the corresponding carriage.

Example: 3

FailedRebookingReservationLineResponse

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

information

string · required

Information about the reservation line.

Example: Some information

previousType

string · required

The previous type of reservation line.

Example: SINGLE_SEAT

orderLineIds

string[] · required

List of order line ids for the previous reservation, one value if the previous reservation was a single seat or compartment, multiple values if it was several single seat rebooked to one compartment reservation.

Example: ["11sdw-1234-5678-90ab-cdef12345678","11sdw-1234-5678-90ab-cdef12345678"]

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

previousElementCarriageIdentifier

string

The carriage number of the carriage of the seat or compartment previously reserved on this reservationLine.

Example: 1

previousSeatNumber

string

The seat number of the seat previously reserved on this reservationLine if it was a SingleSeatReservationLine.

Example: 1

previousCompartmentName

string

Logical name of the compartment previously reserved on this reservationLine if it was a CompartmentReservationLine.

Example: 10

RebookedReservationLineDataResponse

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

SingleSeatDataResponse

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

seatNumber

string · required

Seat number of this seat. This relates to the seat marker on the actual vehicle.

Example: S12

elementCarriageIdentifier

string · required

Carriage identifier of the corresponding carriage.

Example: 3

elementSeries

string · required

Rolling stock series for the element this seat is reserved in

Example: GOA-BM73A-KOMFORT

elementSeriesVersion

integer · int32 · required

Rolling stock series version for the element this seat is reserved in

Example: 1

elementCarriageNumber

integer · int32

Carriage number of the corresponding carriage.

Example: 3

CompartmentDataResponse

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

compartmentName

string · required

Logical name of the compartment.

Example: 10

elementCarriageIdentifier

string · required

Carriage number of the element in which the compartment resides.

Example: 1

seatsInCompartment

string[] · required

All seatNumbers located in compartment.

Example: ["1","2","3"]

elementSeries

string · required

Rolling stock series for the element this compartment is reserved in

Example: GOA-BM73A-KOMFORT

elementSeriesVersion

integer · int32 · required

Rolling stock series version for the element this compartment is reserved in

Example: 1

numberOfTravellers

integer · int32

Number of travellers on the reservation line.

Example: 2

elementCarriageNumber

integer · int32

Carriage number of the element in which the compartment resides.

Example: 1

FreeSeatingDataResponse

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

elementCarriageIdentifier

string

Carriage identifier of the corresponding carriage.

Example: 3

elementSeries

string

Rolling stock series for the element this free seat is reserved in, if any

Example: GOA-BM73A-KOMFORT

elementSeriesVersion

integer · int32

Rolling stock series version for the element the free seat is reserved in, if any

Example: 1

FailedRebookingDataResponse

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

information

string · required

Information about the reservation line that failed to be rebooked and a best effort description of why it failed. This field should include information about what seats or compartment in what element failed to be rebooked.

Example: Compartment 1 in element TYPE-73A-BFR-STANDARD-VY, v1 was closed due to <reason>. Unable to rebook 3 travellers due to <reason>.

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

PatchSingleSeatReservationLineRequest

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

seatNumber

string

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

Example: 1

PatchCompartmentReservationLineRequest

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

numberOfTravellers

integer · int32

Number of travellers on the reservation line.

Example: 2

compartmentName

string

Logical name of the compartment.

Example: 10

PatchFreeSeatingReservationLineRequest

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

RebookedReservationLineResponseV1

reference

string · uuid · required

Reference for this reservation line`

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

orderLineId

string

OrderLine ID for this reservation line`

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

FailedRebookingDataResponseV1

reference

string · uuid · required

Reference for this reservation line`

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

information

string · required

Information about the reservation line that failed to be rebooked and a best effort description of why it failed. This field should include information about what seats or compartment in what element failed to be rebooked.

Example: Compartment 1 in element TYPE-73A-BFR-STANDARD-VY, v1 was closed due to <reason>. Unable to rebook 3 travellers due to <reason>.

orderLineId

string

OrderLine ID for this reservation line`

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

RebookedSingleSeatReservationLineResponseV1

reference

string · uuid · required

Reference for this reservation line`

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

seatNumber

string · required

Seat number of this seat. This relates to the seat marker on the actual vehicle.

Example: S12

elementCarriageIdentifier

string · required

Carriage identifier of the corresponding carriage.

Example: 3

elementSeries

string · required

Rolling stock series for the element this seat is reserved in

Example: GOA-BM73A-KOMFORT

elementSeriesVersion

integer · int32 · required

Rolling stock series version for the element this seat is reserved in

Example: 1

orderLineId

string

OrderLine ID for this reservation line`

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

RebookedFreeSeatingReservationLineResponseV1

reference

string · uuid · required

Reference for this reservation line`

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

orderLineId

string

OrderLine ID for this reservation line`

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

elementCarriageIdentifier

string

Carriage identifier of the corresponding carriage.

Example: 3

elementSeries

string

Rolling stock series for the element this free seat is reserved in, if any

Example: GOA-BM73A-KOMFORT

elementSeriesVersion

integer · int32

Rolling stock series version for the element the free seat is reserved in, if any

Example: 1

RebookedCompartmentReservationLineResponseV1

reference

string · uuid · required

Reference for this reservation line`

reservationLineType

string · required

The type of reservation line.

Example: SINGLE_SEAT

reservedProperties

string[] · required

compartmentName

string · required

Logical name of the compartment.

Example: 10

elementCarriageIdentifier

string · required

Carriage number of the element in which the compartment resides.

Example: 1

seatsInCompartment

string[] · required

All seatNumbers located in compartment.

Example: ["1","2","3"]

elementSeries

string · required

Rolling stock series for the element this compartment is reserved in

Example: GOA-BM73A-KOMFORT

elementSeriesVersion

integer · int32 · required

Rolling stock series version for the element this compartment is reserved in

Example: 1

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

ReservationLineResponseV1

orderLineIds

string[] · required

List of order line ids linked to this reservation line. Contains one ID for single seat or compartment, multiple IDs if it was several single seat rebooked to one compartment reservation.

reference

string · uuid · required

Reference for this reservation line

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.

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.

numberOfTravellers

integer · int32 · required

Number of travellers on the reservation line.

Example: 2

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

SingleSeatReservationLineResponseV1

orderLineIds

string[] · required

List of order line ids linked to this reservation line. Contains one ID for single seat or compartment, multiple IDs if it was several single seat rebooked to one compartment reservation.

reference

string · uuid · required

Reference for this reservation line

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.

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.

numberOfTravellers

integer · int32 · required

Number of travellers on the reservation line.

Example: 2

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

seatNumber

string · required

elementCarriageIdentifier

string · required

SeatingPropertiesResponseV1

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.

SeatingPropertiesResponseV1

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.

CompartmentReservationLineResponseV1

orderLineIds

string[] · required

List of order line ids linked to this reservation line. Contains one ID for single seat or compartment, multiple IDs if it was several single seat rebooked to one compartment reservation.

reference

string · uuid · required

Reference for this reservation line

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.

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.

numberOfTravellers

integer · int32 · required

Number of travellers on the reservation line.

Example: 2

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

elementCarriageIdentifier

string · required

Carriage number of the element in which the compartment resides.

Example: 1

compartmentName

string · required

Logical name of the compartment.

Example: 10

seatsInCompartment

string[] · required

All seatNumbers located in compartment.

Example: ["1","2","3"]

compartmentLabel

string · required

String of seats in the compartment.

Example: Kupe 11, 12, 13, 14, 15, 16

SeatingPropertiesResponseV1

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.

SeatingPropertiesResponseV1

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.

FreeSeatingReservationLineResponseV1

orderLineIds

string[] · required

List of order line ids linked to this reservation line. Contains one ID for single seat or compartment, multiple IDs if it was several single seat rebooked to one compartment reservation.

reference

string · uuid · required

Reference for this reservation line

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.

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.

numberOfTravellers

integer · int32 · required

Number of travellers on the reservation line.

Example: 2

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

elementCarriageIdentifier

string

Carriage identifier of the carriage containing the free seating. Null if the whole departure is available for free seating

Example: 3

FailedRebookingReservationLineResponseV1

orderLineIds

string[] · required

List of order line ids linked to this reservation line. Contains one ID for single seat or compartment, multiple IDs if it was several single seat rebooked to one compartment reservation.

reference

string · uuid · required

Reference for this reservation line

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.

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.

numberOfTravellers

integer · int32 · required

Number of travellers on the reservation line.

Example: 2

type

string · required

The type of reservation line.

Example: SINGLE_SEAT

information

string · required

Information about the reservation line.

Example: Some information

SortingRequestV1

Sorting property for rebooking of reservations.

sortingKey

string · required

Sorting key.

Example: NuisanceFacilityEnum.noAnimals

sortingValue

integer · int32 · required

Sorting value.

Example: 2

SortingResponseV1

Sorting property for rebooking of reservations.

sortingKey

string · required

Sorting key.

Example: NuisanceFacilityEnum.noAnimals

sortingValue

integer · int32 · required

Sorting value.

Example: 2

MaterialCompositionRequest

existingMaterialCompositionNetexId

string · required

The netex id of the material composition that will be changed.

Example: GOA:CompoundTrain:73a_1-2-3-4

MaterialElementRequest[] · required

List of elements in the changed material composition. Each list element corresponds to a carriage.

newMaterialCompositionNetexId

string | null

The new netex id of the material composition that will be changed. If not supplied, an id will be generated.

Example: GOA:CompoundTrain:73a_1-2-3-4_extra-carriage

MaterialElementRequest

List of elements in the changed material composition. Each list element corresponds to a carriage.

logicalElementSeries

string · required

The rolling stock series of the logical element for this element.

Example: GOA-BM73A-PREMIUM

carriageIdentifier

string · required

The carriage identifier for this element.

Example: 5

sequenceNumber

integer · int32 · required

The sequence number for this element in the material composition. 1-n

Example: 3

direction

string · enum · required

The direction for this element.

Enum values:

FORWARDS

BACKWARDS

UNKNOWN

Example: BACKWARDS

ElementPartResponseV1

Information about one element in one material composition.

StopPlaceWithTimesResponseV1 · required

Destination stop place for this element in this material composition.

StopPlaceWithTimesResponseV1 · required

Destination stop place for this element in this material composition.

materialCompositionNetexId

string · required

Netex id for corresponding material composition.

Example: GOA:CompoundTrain:73

sequenceNumber

integer · int32 · required

Sequence number of the element in this material composition.

Example: 2

direction

string · enum · required

Direction of the element in this material composition.

Enum values:

FORWARDS

BACKWARDS

UNKNOWN

Example: BACKWARDS

SeatingOfferElementResponse

series

string · required

Rolling stock series of the corresponding element.

Example: GOA-BM73A-KOMFORT

seriesVersion

integer · int32 · required

Rolling stock version of the corresponding element.

Example: 2

carriageNumber

integer · int32 · required

Carriage number for the element in the train.

carriageIdentifier

string · required

Carriage identifier for the element in the train.

Example: V5-upper

netexId

string · required

Netex id of the element.

Example: GOA:TrainElement:73-2-A

ElementPartResponseV1[] · required

seatmapKey

string | null

Seatmap key of the basic element. This can be used as a lookup in the seatmap service.

Example: SETRA-S431DT-LOWER

SeatingOfferResponse

datedServiceJourneyId

string · required

The netex id of the datedServiceJourney

Example: VYG:DatedServiceJourney:61_21-12-02

datedServiceJourneyVersion

integer · int32 · required

The version of the datedServiceJourney

Example: 1

organisationId

integer · int64 · required

The organisation id this seating offer is operated by.

Example: 20

seatingOfferStatus

string · enum · required

Describes the seating offer status

Enum values:

ACTIVE

CANCELLED

TO_BE_REPLACED

REPLACED_MATERIAL

REPLACED_DSJ

SEAT_USAGES_DELETED

REMOVED

DEPRECATED

Example: ACTIVE

serviceJourneyId

string · required

The netex id of the serviceJourney

Example: GOA:ServiceJourney:709_337-R

operatingDate

string · date · required

The date which the departure belongs to. Might differ from departureDateTime.

Example: 2023-02-13

departureDateTime

string · date-time · required

The time of departure from the first station.

Example: 2023-02-13T12:00:00+01:00

lineId

string · required

The netex id of the line

Example: GOA:Line:50

createdAt

string · date-time · required

When this seating offer was initially created

Example: 2018-10-26T10:00:00Z

inactive

boolean · required

Whether this seating offer is closed for sale or not

Example: false

manualMaterial

boolean · required

Whether the material for this seating offer was set manually.

Example: false

transportType

string · enum · required

The type of transport this seating offer is for.

Enum values:

BUS

REPLACEMENT_BUS

TRAIN

FERRY

OTHER

Example: TRAIN

SeatingOfferElementResponse[] · required

replacesNetexId

string | null

Netex id for the previous material used for this seating offer. If null the material on this dated service journey has never been changed.

Example: GOA:Train:73

updatedAt

string | null · date-time

The last time this seating offer was updated. If null the seating offer has not been updated

Example: 2018-10-26T10:23:38Z

StopPlaceWithTimesResponseV1

Destination stop place for this element in this material composition.

nsrCode

string · required

Stop Place id defined by National StopPlace registry.

Example: NSR:StopPlace:337

departureDateTime

string · date-time · required

Time of departure from this stop. Set to time of arrival on last stop.

Example: 2025-02-12T12:08:45.539473+01:00

arrivalDateTime

string · date-time · required

Time of arrival on this stop. Set to time of departure on first stop.

Example: 2025-02-12T12:08:45.539473+01:00

sequenceNr

integer · int32 · required

The ordering of the station in the journey.

Example: 0

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.

StopPlaceResponseV1

Destination `StopPlace` of the `reservation`

nsrCode

string · required

Stop Place id defined by National StopPlace registry.

Example: NSR:StopPlace:337

sequenceNr

integer · int32 · required

The ordering of the station in the journey.

Example: 0

CreateThirdPartyReservationsRequest

ThirdPartyReservation[] · required

The third party reservations to create

ThirdPartyReservation

The third party reservations to create

reference

string · uuid · required

This id will be used as reference for this reservation.

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

orderId

string · required

An orderId that can be used for lookup purposes

Example: A1B2C3D4

datedServiceJourneyId

string · required

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

Example: ENT:DatedServiceJourney:4788391

owningSystem

string · required

The ID of the system that owns this reservation

Example: osdm-gateway

CreateThirdPartyReservationsResponse

ThirdPartyReservationResponse[] · required

The third party reservations that were created

ThirdPartyReservationResponse

The third party reservations that were created

reference

string · uuid · required

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 · required

An orderId that can be used for lookup purposes

Example: A1B2C3D4

owningSystem

string · required

The ID of the system that owns this reservation

Example: osdm-gateway

createdAt

string · YYYY-MM-DDThh:mm:ssZ · minLength: 1 · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00

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

CreateReservationLinesBySeatingPropertiesRequest

List of SeatingProperties to allocate for.

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

ReplaceReservationLinesRequest

Request body detailing which reservation lines to remove and what should replace them

CreateReservationLinesBySeatingPropertiesRequest[] · required

List of SeatingProperties to allocate for.

reservationLinesToRemove

string[] · required

List of reservationLine-references to remove.

SeatingPropertiesRequestV1

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.

nuisanceFacilities

string[] · unique · required

Set of possible nuisance factors of the seat. Netex enumerations.

Enum values:

UNKNOWN

SMOKING

NO_SMOKING

FAMILY_AREA

CHILDFREE_AREA

ANIMALS_ALLOWED

NO_ANIMALS

BREASTFEEDING_FRIENDLY

Example: FAMILY_AREA,SMOKING

passengerCommsFacilities

string[] · unique · required

Set of possible communication facilities available for passenger in the seat. Netex enumerations.

Enum values:

UNKNOWN

FREE_WIFI

PUBLIC_WIFI

POWER_SUPPLY_SOCKETS

TELEPHONE

AUDIO_ENTERTAINMENT

VIDEO_ENTERTAINMENT

BUSINESS_SERVICES

Example: POWER_SUPPLY_SOCKETS,TELEPHONE

sanitaryFacilities

string[] · unique · required

Set of possible sanitary facilities available for passenger in the seat. Netex enumerations.

Enum values:

NONE

TOILET

WHEELCHAIR_ACCESS_TOILET

SHOWER

WASHING_AND_CHANGE_FACILITIES

BABY_CHANGE

WHEELCHAIR_BABY_CHANGE

SHOE_SHINER

Example: TOILET,SHOWER

mobilityFacilities

string[] · unique · required

Set of possible mobility facilities available for passenger in the seat. Netex enumerations.

Enum values:

UNKNOWN

LOW_FLOOR

STEP_FREE_ACCESS

SUITABLE_FOR_PUSHCHAIRS

SUITABLE_FOR_WHEELCHAIRS

SUITABLE_FOR_HEAVILIY_DISABLED

BOARDING_ASSISTANCE

ONBOARD_ASSISTANCE

Example: SUITABLE_FOR_WHEELCHAIRS,LOW_FLOOR

baggageType

string[] · unique · required

Set of possible baggage types possible for passenger in the seat. Netex enumerations.

Enum values:

HANDBAG

HAND_LUGGAGE

SMALL_SUITCASE

SUITCASE

TRUNK

OVERSIZE_ITEM

BICYCLE

MOTORCYCLE

Example: HANDBAG,SUITCASE

fareClass

string | null · enum

Fare class of the seat. Netex enumeration.

Enum values:

UNKNOWN

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

PREFERENTE

PREMIUM_CLASS

BUSINESS_CLASS

STANDARD_CLASS

Example: FIRST_CLASS

groupBooking

string | null · enum

Group booking permission of the seat. Netex enumeration.

Enum values:

GROUPS_ALLOWED

GROUPS_NOT_ALLOWED

GROUPS_ALLOWED_WITH_RESERVATION

GROUP_BOOKINGS_RESTRICTED

UNKNOWN

Example: GROUPS_ALLOWED

accommodationFacility

string | null · enum

Accommodation property of the seat. Netex enumeration.

Enum values:

UNKNOWN

SEATING

FOLDING_SEAT

SLEEPER

SINGLE_SLEEPER

DOUBLE_SLEEPER

SPECIAL_SLEEPER

COUCHETTE

Example: SINGLE_SLEEPER

seatAttachment

string | null · enum

Attachment of the seat. Netex enumeration.

Enum values:

REVERSIBLE

FIXED

FOLDING

REMOVABLE

OTHER

Example: REVERSIBLE

seatPosition

string | null · enum

Position of the seat. Netex enumeration.

Enum values:

WINDOW

AISLE

MIDDLE

UPPER_BERTH

MIDDLE_BERTH

LOWER_BERTH

OTHER

Example: MIDDLE_BERTH

relativeDirection

string | null · enum

Relative direction of the seat. Netex enumeration.

Enum values:

BOTH

FORWARDS

BACKWARDS

Example: BACKWARDS

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

CreateTripReservationBySeatingPropertiesRequest

Request to create a trip reservation by seating properties.

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

CreateTripReservationLinesBySeatingPropertiesRequest

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 · int32 · required

The number of travellers of this reservation line.

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

LegRequest

Leg of a trip. Each leg results in a new reservation.

datedServiceJourneyId

string · required

Dated service journey ID for the leg.

originNsrCode

string · required

NSR code where the traveller leg starts.

destinationNsrCode

string · required

NSR code where the traveller leg ends.

RebookToSeatTypeRequest

datedServiceJourneyId

string · required

The datedServiceJourney whose reservations should be rebooked

reservationReferences

string[] · required

References of reservations that should be moved

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.

mustReserveWholeCompartment

boolean · required

If accommodation is COUCHETTE or SLEEPER, should the whole compartment be reserved (true) or can strangers be seated together (false)?

PatchSeatingOfferRequest

inactive

boolean | null

If true, the departure will not be open for sales

Example: false

manualMaterial

boolean | null

If true, the material on this SeatingOffer has been set manually

Example: false

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

RebookedReservationLineResponse

Reservation lines that are rebooked for this reservation, including previous reservation line.

reference

string · uuid · required

The reference for this reservation line, this is a randomly generated UUID

Example: 123e4567-e89b-12d3-a456-426614174000

RebookedReservationLineDataResponse · required

orderLineId

string | null

OrderLine ID for this reservation line`

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

RebookedReservationResponse

reference

string · uuid · required

The reference for this reservation, this is a randomly generated UUID

Example: 123e4567-e89b-12d3-a456-426614174000

version

integer · int32 · required

The highest/newest version of this reservation. The initial version number is 1.

Example: 1

StopPlaceResponseV1 · required

Destination StopPlace of the reservation

StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId

string · required

Id of the dated service journey

organisationId

integer · int64 · required

The organisation id of the order which the reservation belongs to.This id is determined by the authentication used by the client.

Example: 20

createdAt

string · YYYY-MM-DDThh:mm:ssZ · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00

versionedAt

string · YYYY-MM-DDThh:mm:ssZ · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00

updatedAt

string · YYYY-MM-DDThh:mm:ssZ · required

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

Example: 2011-12-03T10:15:30+01:00

reservationStatus

string · enum · required

Describes the reservation status.

Enum values:

DRAFT

CONFIRMED

CANCELLED

DEPRECATED

Example: DRAFT

rebookingStatus

string · enum · required

Describes the rebooking status of the reservation.

Enum values:

ACCEPTED

MANUAL

SUGGESTED

REBOOKED_DRAFT

REJECTED

Example: ACCEPTED

RebookedReservationLineResponse[] · minItems: 1 · required

Reservation lines that are rebooked for this reservation, including previous reservation line.

orderId

string | null

The orderId of the connected order where the creating client provided it. There are reservations without a connected order.

Example: ZGMCDSVS

previousDatedServiceJourneyId

string | null

Id of the previous dated service journey if the dated service journey has been changed

info

string | null

Additional free text information about the reservation.

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

CoachResponse

List of coaches in this trip

id

string · required

The identifier of the coach

Example: 1

label

string · required

The label of the coach

Example: 1

sequenceNumber

integer · int32 · required

The sequence number in this coach

SeatResponse[] · required

SeatResponse

List of seats in this coach

id

string · required

The identifier of the seat

Example: 1

label

string · required

The label for the seat

Example: 12A

ReservationResponse[] · required

TripResponse

tripId

string · required

The unique identifier of the trip (DSJ)

Example: VYG:DatedServiceJourney:67_OSL-BRG_25-05-22

route

string[] · required

object · required

Mapping of stop place IDs to human-readable station names

Example: {"NSR:StopPlace:337":"Oslo","NSR:StopPlace:548":"Bergen"}

CoachResponse[] · required

RebookedReservationResponseV1

reference

string · uuid · required

The reference for this reservation, this is a randomly generated UUID

Example: 123e4567-e89b-12d3-a456-426614174000

version

integer · int32 · required

The highest/newest version of this reservation. The initial version number is 1.

Example: 1

StopPlaceResponseV1 · required

Destination StopPlace of the reservation

StopPlaceResponseV1 · required

Destination StopPlace of the reservation

datedServiceJourneyId

string · required

Id of the dated service journey

organisationId

integer · int64 · required

The organisation id of the order which the reservation belongs to.This id is determined by the authentication used by the client.

Example: 20

createdAt

string · YYYY-MM-DDThh:mm:ssZ · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00

versionedAt

string · YYYY-MM-DDThh:mm:ssZ · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00

updatedAt

string · YYYY-MM-DDThh:mm:ssZ · required

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

Example: 2011-12-03T10:15:30+01:00

reservationStatus

string · enum · required

Describes the reservation status.

Enum values:

DRAFT

CONFIRMED

CANCELLED

DEPRECATED

Example: DRAFT

rebookingStatus

string · enum · required

Describes the rebooking status of the reservation.

Enum values:

ACCEPTED

MANUAL

SUGGESTED

REBOOKED_DRAFT

REJECTED

Example: ACCEPTED

RebookedReservationLineResponseV1[] · minItems: 1 · required

RebookedReservationLineResponseV1[] · required

orderId

string | null

The orderId of the connected order where the creating client provided it. There are reservations without a connected order.

Example: ZGMCDSVS

previousDatedServiceJourneyId

string | null

Id of the previous dated service journey if the dated service journey has been changed

info

string | null

Additional free text information about the reservation.

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

CommonError

timestamp

string · date-time · required

status

integer · int32 · required

error

string · required

exception

string · required

message

string · required

path

string · required

RebookingOverviewResponseV1

originalDatedServiceJourneyId

string · minLength: 1 · required

Id of the original dated service journey

replacements

string[] · required

All replacement dated service journeys

amountOfSuggestedRebookings

integer · int32 · required

Number of rebookings suggested

Example: 1

amountOfManualRebookings

integer · int32 · required

Number of rebookings ready for manual handling

Example: 2

amountOfAcceptedRebookings

integer · int32 · required

Number of rebookings accepted

Example: 0

amountOfNoJourneyRebookings

integer · int32 · required

Number of no-journey rebookings

Example: 0

amountOfSnoozedRebookings

integer · int32 · required

Number of rebookings snoozed

Example: 0

SeatingPropertiesResponseV1

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.

fareClass

string | null · enum

Fare class of the seat. Netex enumeration.

Enum values:

UNKNOWN

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

PREFERENTE

PREMIUM_CLASS

BUSINESS_CLASS

STANDARD_CLASS

Example: FIRST_CLASS

groupBooking

string | null · enum

Group booking permission of the seat. Netex enumeration.

Enum values:

GROUPS_ALLOWED

GROUPS_NOT_ALLOWED

GROUPS_ALLOWED_WITH_RESERVATION

GROUP_BOOKINGS_RESTRICTED

UNKNOWN

Example: GROUPS_ALLOWED

accommodationFacility

string | null · enum

Accommodation property of the seat. Netex enumeration.

Enum values:

UNKNOWN

SEATING

FOLDING_SEAT

SLEEPER

SINGLE_SLEEPER

DOUBLE_SLEEPER

SPECIAL_SLEEPER

COUCHETTE

Example: SINGLE_SLEEPER

seatAttachment

string | null · enum

Attachment of the seat. Netex enumeration.

Enum values:

REVERSIBLE

FIXED

FOLDING

REMOVABLE

OTHER

Example: REVERSIBLE

seatPosition

string | null · enum

Position of the seat. Netex enumeration.

Enum values:

WINDOW

AISLE

MIDDLE

UPPER_BERTH

MIDDLE_BERTH

LOWER_BERTH

OTHER

Example: MIDDLE_BERTH

relativeDirection

string | null · enum

Relative direction of the seat. Netex enumeration.

Enum values:

BOTH

FORWARDS

BACKWARDS

Example: BACKWARDS

nuisanceFacilities

string[] · unique

Set of possible nuisance factors of the seat. Netex enumerations.

Enum values:

UNKNOWN

SMOKING

NO_SMOKING

FAMILY_AREA

CHILDFREE_AREA

ANIMALS_ALLOWED

NO_ANIMALS

BREASTFEEDING_FRIENDLY

Example: FAMILY_AREA,SMOKING

passengerCommsFacilities

string[] · unique

Set of possible communication facilities available for passenger in the seat. Netex enumerations.

Enum values:

UNKNOWN

FREE_WIFI

PUBLIC_WIFI

POWER_SUPPLY_SOCKETS

TELEPHONE

AUDIO_ENTERTAINMENT

VIDEO_ENTERTAINMENT

BUSINESS_SERVICES

Example: POWER_SUPPLY_SOCKETS,TELEPHONE

sanitaryFacilities

string[] · unique

Set of possible sanitary facilities available for passenger in the seat. Netex enumerations.

Enum values:

NONE

TOILET

WHEELCHAIR_ACCESS_TOILET

SHOWER

WASHING_AND_CHANGE_FACILITIES

BABY_CHANGE

WHEELCHAIR_BABY_CHANGE

SHOE_SHINER

Example: TOILET,SHOWER

mobilityFacilities

string[] · unique

Set of possible mobility facilities available for passenger in the seat. Netex enumerations.

Enum values:

UNKNOWN

LOW_FLOOR

STEP_FREE_ACCESS

SUITABLE_FOR_PUSHCHAIRS

SUITABLE_FOR_WHEELCHAIRS

SUITABLE_FOR_HEAVILIY_DISABLED

BOARDING_ASSISTANCE

ONBOARD_ASSISTANCE

Example: SUITABLE_FOR_WHEELCHAIRS,LOW_FLOOR

baggageType

string[] · unique

Set of possible baggage types possible for passenger in the seat. Netex enumerations.

Enum values:

HANDBAG

HAND_LUGGAGE

SMALL_SUITCASE

SUITCASE

TRUNK

OVERSIZE_ITEM

BICYCLE

MOTORCYCLE

Example: HANDBAG,SUITCASE

TotalCapacityEntryResponseV1

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.

numberOfSeats

integer · int32 · required

totalCompartments

integer · int32 · required

TotalMaterialCompositionCapacityResponseV1

materialCompositionId

string · required

fromStopPlaceId

string · required

untilStopPlaceId

string · required

TotalCapacityEntryResponseV1[] · required

SeatsAvailabilitiesElementResponseV1

Information about one element in the material of this seat offer.

elementNetexId

string · required

Netex id of the element.

Example: GOA:TrainElement:73-2-A

series

string · required

Rolling stock series of the element.

Example: GOA-BM73A-KOMFORT

seriesVersion

integer · int32 · required

Rolling stock version of the element.

Example: 2

elementCarriageNumber

integer · int32 · required

Number of the element.

Example: 15

ElementPartResponseV1[] · required

seatmapKey

string | null

Nøkkel til seatmap som tilhører elementet.

Example: BM73

SeatsReservationsReservationResponseV1

One reservation for the corresponding seat.

status

string · enum · required

Status of the reservation.

Enum values:

DRAFT

CONFIRMED

CANCELLED

DEPRECATED

Example: DRAFT or CONFIRMED

sequenceNrOrigin

integer · int32 · required

Index of the origin station of the reservation.

Example: 0

sequenceNrDestination

integer · int32 · required

Index of the destination station of the reservation.

Example: 0

nsrCodeOrigin

string · required

Nsr code of the origin station of the reservation.

Example: NSR:StopPlace:269

nsrCodeDestination

string · required

Nsr code of the destination station of the reservation.

Example: NSR:StopPlace:337

reference

string · uuid · required

Reference of the reservation holding this seat.

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

orderId

string | null

Optional orderId connected to this reservation

Example: ABCD1234

SeatsReservationsResponseV1

Seat reservations for a seat offer.

status

string · required

Status of the seat offer.

Example: ACTIVE

SeatsAvailabilitiesElementResponseV1[] · required

SeatsReservationsSeatResponseV1[] · required

SeatsReservationsSeatResponseV1

Information about one seat in the seat offer. Only seats with reservations are listed.

seatNumber

string · required

Seat number.

Example: 23

elementCarriageNumber

integer · int32 · required

Number of the corresponding element.

Example: 3

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.

series

string · required

Rolling stock series of the corresponding element.

Example: GOA-BM73A-KOMFORT

seriesVersion

integer · int32 · required

Rolling stock version of the corresponding element.

Example: 2

SeatsReservationsReservationResponseV1[] · required

compartmentName

string | null

A unique identifier of each compartment. If set then every seat with the same compartmentName belongs to the same physical compartment.

Example: 1

CapacitiesOccupancyElementResponseV1

Element containing a set of seats, and their occupancy status.

elementCarriageNumber

integer · int32 · required

Number of the corresponding element. The number used by passengers to find the correct carriage.

Example: 3

series

string · required

Rolling stock series of the corresponding element.

Example: GOA-BM73A-KOMFORT

seriesVersion

integer · int32 · required

Rolling stock version of the corresponding element.

Example: 2

SeatsOccupancySeatResponseV1[] · required

ElementPartResponseV1[] · required

CapacitiesOccupancySeatUsageResponseV1

List of seat usages between two neighboring stopPlaces.

nsrCode

string · required

Id of the StopPlace from which the stretch originates.

Example: NSR:StopPlace:337

availability

string · enum · required

Availability of the seat.

Enum values:

AVAILABLE

OCCUPIED

CLOSED

LAST_STOP

Example: OCCUPIED

closed

boolean · required

Is the seat closed for this stopPlace. Always true if departure is inactive.

Example: true

boarding

boolean · required

Will the seat be occupied by a new passenger on this stopPlace?

Example: true

alighting

boolean · required

Will a passenger vacate this seat on this stopPlace?

Example: true

SeatsOccupancyResponseV1

Occupancy status for seats in seat offer separated by elements.

CapacitiesOccupancyElementResponseV1[] · required

SeatsOccupancySeatResponseV1

Occupancy status for one seat.

seatNumber

string · required

Seat number.

Example: 23

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.

CapacitiesOccupancySeatUsageResponseV1[] · required

List of seat usages between two neighboring stopPlaces.

compartmentName

string | null

A unique identifier of each compartment. If set then every seat with the same compartmentName belongs to the same physical compartment.

Example: 1

AvailableCompartmentResponse

Compartment (e.g. Sleeper, Couchette etc.) with available seats.

compartmentName

string · required

Unique name identifying compartment in an element.

Example: COMPARTMENT_1

AvailableSeatResponse[] · required

Seats in compartment.

compartmentLabel

string | null

Human-readable label identifying compartment in an element.

Example: Kupé 21, 25

AvailableElementWithCompartmentsResponse

Element (e.g. train carriage) with available seats and/or compartments.

carriageIdentifier

string · required

Carriage number of the element.

Example: 1

AvailableCompartmentResponse[] · required

Available compartments in element.

AvailableSeatResponse[] · required

Available single seats in element. These are seats that are not part of a compartment.

AvailableSeatResponse

Seat with seatNumber and properties.

seatNumber

string · required

Seat number of seat.

Example: 21

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.

SeatsAvailabilitiesResponseV1

Seat availabilities for a seat offer.

status

string · required

Status of the seat offer.

Example: ACTIVE

SeatsAvailabilitiesElementResponseV1[] · required

SeatsAvailabilitiesSeatResponseV1[] · required

SeatsAvailabilitiesSeatResponseV1

Availability information for one seat in the seat offer.

seatNumber

string · required

Seat number.

Example: 23

elementCarriageNumber

integer · int32 · required

Number of the corresponding element.

Example: 3

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.

series

string · required

Rolling stock series of the corresponding element.

Example: GOA-BM73A-KOMFORT

seriesVersion

integer · int32 · required

Rolling stock version of the corresponding element.

Example: 2

availability

string · enum · required

Availability of the seat.

Enum values:

AVAILABLE

OCCUPIED

CLOSED

LAST_STOP

Example: OCCUPIED

closed

boolean · required

Is the seat closed for this stopPlace. Always true if departure is inactive.

Example: true

compartmentLabel

string | null

For internal use only!! If set then every seat with the same label belongs to the same physical compartment.

Example: 1

compartmentName

string | null

A unique identifier of each compartment. If set then every seat with the same compartmentName belongs to the same physical compartment.

Example: 1

AvailableElementResponse

Element (e.g. train carriage) with available.

carriageIdentifier

string · required

Carriage number of the element.

Example: 1

AvailableSeatResponse[] · required

Available seats in element.

ServiceJourneyScheduleResponse

serviceJourneyId

string · required

The netex id of the serviceJourney

Example: GOA:ServiceJourney:709_337-R

firstDepartureDate

string · date · required

The first date and time of departure.

Example: 2023-02-13

lastDepartureDate

string · date · required

The last date and time of departure.

Example: 2023-02-18

ElementDebugResponse

series

string · required

Rolling stock series of the corresponding element.

Example: GOA-BM73A-KOMFORT

seriesVersion

integer · int32 · required

Rolling stock version of the corresponding element.

Example: 2

carriageIdentifier

string · required

Carriage identifier for the element in the train.

Example: 4

netexId

string · required

Netex id of the element.

Example: GOA:TrainElement:73-2-A

ElementPartResponseV1[] · required

SeatDebugResponse[] · required

seatmapKey

string | null

Seatmap key of the basic element. This can be used as a lookup in the seatmap service.

Example: SETRA-S431DT-LOWER

SeatDebugResponse

seatNumber

string · required

The seat number of the seat.

Example: 101

elementCarriageIdentifier

string · required

The carriage identifier of the carriage containing the seat.

Example: 4

row

integer | null · int32 · required

The row in the carriage containing the seat.

Example: 4

column

integer | null · int32 · required

The column in the carriage containing the seat.

Example: 4

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.

SeatGroupDebugResponse[] · required

SeatUsageDebugResponse[] · required

SeatGroupDebugResponse

name

string · required

The name of the seat group.

Example: COMPARTMENT-1

seatGroupType

string · enum · required

The type of the seat group.

Enum values:

OTHER

TABLE_GROUP

COMPARTMENT

COMPANION

Example: COMPARTMENT

label

string | null

The label of the seat group.

Example: Kupe 1: 11-15

SeatUsageDebugResponse

fromSequenceNumber

integer · int32 · required

The sequence nr of the stop place that this seat usage is from.

Example: 0

toSequenceNumber

integer · int32 · required

The sequence nr of the stop place that this seat usage is to.

Example: 1

elementClosureReferences

string[] · required

The references of element closures affecting this seat usage.

Example: [784160f6-4afe-4ff9-8d11-186d4cd9b8b8]

seatNumberClosureReferences

string[] · required

The references of seat closures affecting this seat usage.

Example: [784160f6-4afe-4ff9-8d11-186d4cd9b8b8]

createdAt

string · date-time · required

When this seat usage was initially created.

Example: 2018-10-26T10:00:00Z

reservationLineReference

string | null · uuid

The reference of the reservation line that has reserved this seat usage. Null if unreserved.

Example: 784160f6-4afe-4ff9-8d11-186d4cd9b8b8

updatedAt

string | null · date-time

When this seat usage was las updated. Null if never updated after creation.

Example: 2018-10-26T10:00:00Z

updatedBy

integer | null · int64

The organisation id that last updated this seat usage.

Example: 1

SeatingOfferDebugResponse

datedServiceJourneyId

string · required

The netex id of the datedServiceJourney

Example: VYG:DatedServiceJourney:61_21-12-02

datedServiceJourneyVersion

integer · int32 · required

The version of the datedServiceJourney

Example: 1

organisationId

integer · int64 · required

The organisation id this seating offer is operated by.

Example: 20

seatingOfferStatus

string · enum · required

Describes the seating offer status

Enum values:

ACTIVE

CANCELLED

TO_BE_REPLACED

REPLACED_MATERIAL

REPLACED_DSJ

SEAT_USAGES_DELETED

REMOVED

DEPRECATED

Example: ACTIVE

serviceJourneyId

string · required

The netex id of the serviceJourney

Example: GOA:ServiceJourney:709_337-R

departureDateTime

string · date-time · required

The time of departure from the first station.

Example: 2023-02-13T10:00:00Z

lineId

string · required

The netex id of the line

Example: GOA:Line:50

createdAt

string · date-time · required

When this seating offer was initially created

Example: 2018-10-26T10:00:00Z

createdBy

integer · int64 · required

The organisation id this seating offer was created by.

Example: 1

updatedBy

integer | null · int64 · required

The organisation id that last updated this seating offer.

Example: 1

inactive

boolean · required

Whether this seating offer is closed for sale or not

Example: false

manualMaterial

boolean · required

Whether the material for this seating offer was set manually.

Example: false

capactiyOnly

boolean · required

Whether the seating offer has real RollingStock material or is meant for capacity only.

Example: false

transportType

string · enum · required

The type of transport this seating offer is for.

Enum values:

BUS

REPLACEMENT_BUS

TRAIN

FERRY

OTHER

Example: TRAIN

ElementDebugResponse[] · required

StopPlaceWithTimesResponseV1[] · required

replacesNetexId

string | null

Netex id for the previous material used for this seating offer. If null the material on this dated service journey has never been changed.

Example: GOA:Train:73

updatedAt

string | null · date-time

The last time this seating offer was updated. If null the seating offer has not been updated

Example: 2018-10-26T10:23:38Z

ReservationResponseV1

reference

string · uuid · required

The reference for this reservation

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

version

integer · int32 · required

The version of the reservation. Starts with 1.

Example: 1

datedServiceJourneyId

string · required

Id of the dated service journey

versionedAtDatedServiceJourneyVersion

integer · int32 · required

The version of the datedServiceJouney at the time the reservation was versioned

originNsrCode

string · required

Origin NSR code of the reservation

destinationNsrCode

string · required

Destination NSR code of the reservation

organisationId

integer · int64 · required

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

Example: 20

status

string · enum · required

Describes the reservation status.

Enum values:

DRAFT

CONFIRMED

CANCELLED

DEPRECATED

Example: DRAFT

createdAt

string · date-time · required

When this reservation was initially created

Example: 2011-12-03T10:15:30+01:00

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

versionedAt

string · date-time · required

When this version of this reservation was created

Example: 2011-12-03T10:15:30+01:00

updatedAt

string · date-time · required

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

Example: 2011-12-03T10:15:30+01:00

ReservationLineResponseV1[] · required

orderId

string | null

The 'id' of the order the reservation belongs to

Example: A1B2C3D4

rebookingStatus

string | null · enum

Describes the rebooking status of the reservation.

Enum values:

ACCEPTED

MANUAL

SUGGESTED

REBOOKED_DRAFT

REJECTED

Example: ACCEPTED

notificationRule

string | null · enum

Rule for what type of notification is sent to reservation owner on departure closures

Enum values:

CANCELLED_WITHOUT_REPLACEMENT

CANCELLED_WITH_REPLACEMENT

REPLACED_TO_OTHER_SERVICE

Example: CANCELLED_WITHOUT_REPLACEMENT

info

string | null

Additional free text information about the reservation.

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

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

TravelIntentionResponseV1

travelIntentionReference

string · uuid · required

TravelIntentionVersionResponseV1[] · required

TravelIntentionVersionResponseV1

travelIntentionVersion

integer · int32 · required

status

string · enum · required

Enum values:

SUCCESS

NO_JOURNEY

REJECTED

NO_SEATS

snoozed

boolean · required

originalDatedServiceJourneyId

string · required

originNsrCode

string · required

destinationNsrCode

string · required

versionedAt

string · date-time · required

ReservationResponseV1[] · required

info

string | null

RebookingOverviewResponse

datedServiceJourneyId

string · minLength: 1 · required

Id of the dated service journey

amountOfSuggestedRebookings

integer · int32 · required

Number of rebookings suggested

Example: 1

amountOfManualRebookings

integer · int32 · required

Number of rebookings ready for manual handling

Example: 2

amountOfAcceptedRebookings

integer · int32 · required

Number of rebookings accepted

Example: 0

RebookingHistoryOverviewResponse

datedServiceJourneyId

string · minLength: 1 · required

Id of the dated service journey

amountOfRejected

integer · int32 · required

Number of rejected rebooked reservations

Example: 1

amountOfConfirmed

integer · int32 · required

Number of confirmed rebooked reservations

Example: 2

PreviewResponse

norwegianPreview

string · required

englishPreview

string · required