Entur Developer
Seating manager
Seating manager

rebooking-v-1-controller

Download schema

Fetch unhandled rebooked reservations for a dated service journey

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

Fetch all unhandled rebooked reservations for a dated service journey. A unhandled rebooked reservation is a reservations that has status=DRAFT and rebooking status SUGGESTED, MANUAL or ACCEPTED.

Fetch unhandled rebooked reservations for a dated service journey › query Parameters

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

Dated service journey id to fetch rebooked reservations for.

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

The status of the reservations considered, defaults to DRAFT

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

The rebooking statuses of the reservation that will be fetched. Defaults to SUGGESTED, MANUAL or ACCEPTED.

Enum values:
ACCEPTED
MANUAL
SUGGESTED
REBOOKED_DRAFT
REJECTED
NONE

Fetch unhandled rebooked reservations for a dated service journey › 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 unhandled rebooked reservations for a dated service journey › Responses

200

OK

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.

Fetch rebooking statistics grouped by original dated service journey

GET
https://api.entur.io/seating-manager
/v1/rebookings/dated-service-journeys

Fetch statistics for original departures from today onward in Norwegian local time. Supply exactly one of organisationId or lineId; supplying both or neither returns 400. The caller must have reservation read access to the organisations owning the selected original and replacement departures. Statistics count travel intentions, not individual reservation legs, under the original departure. Departures whose five rebooking counters are all zero are omitted. The reservation status defaults to DRAFT; rebooking statuses are MANUAL, SUGGESTED and ACCEPTED, in that priority order. Snoozed travel intentions are counted separately and excluded from active counts. No-journey travel intentions are counted separately for DRAFT only.

Fetch rebooking statistics grouped by original dated service journey › query Parameters

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

Owner organisation of the original departures. Required when lineId is omitted; cannot be combined with lineId.

lineId
​string · style: form · explode: true

Line of the original departures. Required when organisationId is omitted; cannot be combined with organisationId.

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

The status of the reservations considered, defaults to DRAFT

Enum values:
DRAFT
CONFIRMED
CANCELLED
DEPRECATED
Default: DRAFT

Fetch rebooking statistics grouped by original dated service journey › 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 rebooking statistics grouped by original dated service journey › Responses

Rebooking statistics for the original departures.

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
seat-display-controllercapacity-controller-v-1
Did you find what you were looking for?