Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Resource

Path

End-point description

Places

POST /places

Returns place information for a given place request.

Offers

POST /offers

Returns trip and non-trip offers.

GET /bookings/{bookingId}/bookedOffers/ {bookedOfferId}/additionalOffers

Returns ancillary and reservation offers

Availabilities

GET /availabilities/placeMap

Get place map including availabilities.

GET /availabilities/preferences

Get availabilities for a set of preferences.

Bookings

POST /bookings

Allows to create a booking based on a previously requested offer.

 

GET /bookings/{bookingId}

Returns a booking with the id provided.

 

DELETE /bookings/{bookingId}

Deletes the booking with the id provided.

 

PATCH /bookings/{bookingId}

Allows updating the fulfillment type of the booking.

GET ????

/bookings/{bookingId}/history

Returns the history of the booking

Booking PartBookedOffers

POST /bookings/{bookingId}/bookedOffers

Adds a bookedOffer in a booking.

DELETE //bookings/{bookingId}/bookedOffers/{offerId}

Delete booked offer in a booking.

BookingPart

PATCH /bookings/{bookingId}/bookedOffer/
{bookedOfferId}/reservations/{reservationId}

Add a reservation part to a prebooked offer

 

DELETE /bookings/{bookingId}/bookedOffer/
{bookedOfferId}/reservations/{reservationId}

Delete a reservation part from a prebooked offer

PATCH /bookings/{bookingId}/bookedOffer/
{bookedOfferId}/ancillaries/{ancillaryId}

Add an ancillary part to a prebooked offer

DELETE /bookings/{bookingId}/bookedOffer/
{bookedOfferId}/ancillaries/{ancillaryId}

Delete an ancillary part from a prebook

On HoldOnHold

POST /booking/{bookingId}/onHoldOffer

Ask for possibilities to set prebooked offer on hold and extend time to live

 

PATCH /booking/{bookingId}/onHoldOffer/
{onHoldOfferId}

Set prebooked offer on hold and extend time to live

Bookings SearchBookingsSearch

POST /booking-search

Search for bookings in DS according to parameters

Passengers

GET /bookings/{bookingId}/
passengers/{passengerId}

Returns the passenger's information at every stage of the flow

 

PATCH /bookings/{bookingId}/
passengers/{passengerId}

Update the passenger's information

Purchaser

GET /bookings/{bookingId}/purchaser

Returns the purchaser information

PATCH /bookings/{bookingId}/purchaser

Update the purchaser information

Fulfillment

POST /bookings/{bookingId}/fulfillments

Triggers the fulfillment of the booking

PATCH /fulfillments/{fulfillmentId}

TBC.

Refund

POST /bookings/{bookingId}/refundOffers

Initiates a refund process by creating a RefundOffer resource.

 

GET /bookings/{bookingId}/refundOffers/{refundOfferId}

Returns the refund offer for the ids provided.

 

PATCH /bookings/{bookingId}/refundOffers/{refundOfferId}

Allows to accept and confirm a refund offer.

Exchange

GET /bookings/{bookingId}/exchangeOperations/{exchangeOperationId}

Returns the exchange operation with the id provided. It may be a provisional or a confirmed exchange.

 

PATCH /bookings/{bookingId}/exchangeOperations/{exchangeOperationId}

Allows to update an ongoing exchange operation.

DELETE /bookings/{bookingId}/exchangeOperations/{exchangeOperationId}

Cancels an ongoing exchange operation in provisional state.

POST /exchange-offer

Returns exchange offers for a specified fulfillments submitted given requested new trip characteristics.

Release (Cancel admission and resources but not refund)

POST /bookings/{bookingId}/releaseOffers

Initiates a release process by creating a releaseOffers resource.

PATCH /bookings/{bookingId}/
releaseOffers/{releaseOfferId}

Allows to accept and confirm a release offer.

MasterData

GET /places

Returns all searchable places (stops).

GET /coachLayouts

Returns all coach layouts.

GET /coachLayouts/{layoutId}

Returns a coach layout for a provided id.