Introduction

The Farel API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes and API key based authentication.

Authorization

Use API keys to authenticate API requests.

Farel authenticates your API requests using your account’s API key. Farel raises an invalid request error if you don’t include a key, and an authentication error if the key is incorrect or outdated. You can generate the account’s API key in your agency web portal in Settings - API-key. API-key must be passed in header named X-AGENCY-API-KEY

Base URLs

Important: Each airline has their own specific domain. The API endpoints are hosted on airline-specific domains.

Base URL Pattern: https://{your-airline-domain}/api

Important: All API endpoints are prefixed with /api due to the servlet context path configuration.

To get your airline’s specific API domain, contact your technical integration manager.

Resources

Search Flights

The API allows you to search for flights by specified dates and route directions.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchFlightOptions/http-request.adoc[]

Search Flights request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchFlightOptions/request-fields.adoc[]

HTTP Response

The response contains information on each available flight: detailed information about the flight, branded fares, additional services, and prices for each passenger. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchFlightOptions/http-response.adoc[]

Search Flights response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchFlightOptions/response-fields.adoc[]

Search Returning Flights

The API allows you to search for returning flights by specified dates, route directions and fare frame ID.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchReturningFlights/http-request.adoc[]

Search Flights request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchReturningFlights/request-fields.adoc[]

HTTP Response

The response contains information on each available returning flight: detailed information about the flight, branded fares, additional services, and prices for each passenger. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchReturningFlights/http-response.adoc[]

Search Flights response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/searchReturningFlights/response-fields.adoc[]

Get Flights Calendar

The API allows you to get flight dates for specified dates and route directions.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/calendar/http-request.adoc[]

Get Flights Calendar request params

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/calendar/request-parameters.adoc[]

HTTP Response

The response contains list of dates with available flights. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/calendar/http-response.adoc[]

Search Flights response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/calendar/response-fields.adoc[]

Get fare data

The API allows you to get fare data by specified route directions.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/getRouteDetails/http-request.adoc[]

HTTP Response

The response contains information about fares. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/getRouteDetails/http-response.adoc[]

Fare data response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightSearchControllerTest/getRouteDetails/response-fields.adoc[]

Get flight fare prices

The API allows you to get fare prices by specified flights.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightFareControllerTest/getFlightFarePrices/http-request.adoc[]

HTTP Response

The response contains information about fare prices. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightFareControllerTest/getFlightFarePrices/http-response.adoc[]

Fare prices response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightFareControllerTest/getFlightFarePrices/response-fields.adoc[]

Get flight fare prices with rules

The API allows you to get fare prices by specified flights.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightFareControllerTest/getFlightFarePricesWithRules/http-request.adoc[]

HTTP Response

The response contains information about fare prices with riles. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightFareControllerTest/getFlightFarePricesWithRules/http-response.adoc[]

Fare prices response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightFareControllerTest/getFlightFarePricesWithRules/response-fields.adoc[]

Get route details

The API allows you to get route ID by flight IDs.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiRouteControllerTest/getRoute/http-request.adoc[]

HTTP Response

The response contains information about route with legs. Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiRouteControllerTest/getRoute/http-response.adoc[]

Route details response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiRouteControllerTest/getRoute/response-fields.adoc[]

Branded Fare Details

Branded fares consist of services such as baggage allowance, meals on board, seat selection, and exchange and refund conditions.

The request must include all of the following parameters to get information about the branded fares. Fare(Brand) frame id is a parameter in order to get actual fare.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBrandedFareControllerTest/brandedFarePrices/http-request.adoc[]

Branded Fare Details request fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBrandedFareControllerTest/brandedFarePrices/request-fields.adoc[]

The response contains information about each branded fare on the flight, indicating the scope of services, conditions, and prices for each passenger.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBrandedFareControllerTest/brandedFarePrices/http-response.adoc[]

Branded Fare Details response fields description

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBrandedFareControllerTest/brandedFarePrices/response-fields.adoc[]

Flight Offer

The airline may sell additional services on the flight, such as extra baggage, pre-paid meals onboard, seat selection, etc.

You need to submit a request to receive a list of additional services of the airline available for purchase.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightOfferControllerTest/flightOffers/http-request.adoc[]

Flight Offer request params

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightOfferControllerTest/flightOffers/request-parameters.adoc[]

The response contains information about each branded fare on the flight, indicating the scope of services, conditions, and prices for each passenger.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightOfferControllerTest/flightOffers/http-response.adoc[]

Flight Offer response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiFlightOfferControllerTest/flightOffers/response-fields.adoc[]

Flight Assistances

This request is for a list of available passenger assistance services.

Http Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiAssistanceControllerTest/assistances/http-request.adoc[]

Flight Assistances request params

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiAssistanceControllerTest/assistances/request-parameters.adoc[]

The response for each service additionally indicates the type of passenger for which assistance can be selected.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiAssistanceControllerTest/assistances/http-response.adoc[]

Flight Assistances response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiAssistanceControllerTest/assistances/response-fields.adoc[]

Booking Create

To create a booking, you must specify information about the selected flight, brand, and passengers. Additionally, for each passenger, you can specify a list of selected additional services and assistance of the airline on this flight.

*The set of mandatory parameters that must be specified to the passenger when booking may differ depending on the selected airline configuration. For each airline, the agent must agree on the list of parameters to be used.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createBooking/http-request.adoc[]

Booking Create request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createBooking/request-fields.adoc[]

The response contains information about the created booking and its price.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createBooking/http-response.adoc[]

Booking Create response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createBooking/response-fields.adoc[]

Booking Payment

To pay for the booking from the agent’s balance, you must complete the following request with information on the booking id. Our system will automatically determine the payment instrument for your agency and authorize for the amount of the booking.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingPaymentControllerTest/pay/http-request.adoc[]

Table 1. Path params
Parameter Description

bookingId

Booking id (UUID)
HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingPaymentControllerTest/pay/http-response.adoc[]

Booking Order

Booking payment deadline in seconds. Order ID must be passed in path, it can be obtained from the booking create request.

Table 2. Path params
Parameter Description

orderId

Order ID (UUID)
HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiOrderControllerTest/getTimeLimit/http-response.adoc[]

Booking Details

This endpoint is designed to receive detailed information on booking: booking details, data on each passenger segment, and route. The request can be made after paying for the booking, in order to receive information about successful authorization. And to receive changes to the reservation that could have occurred on the side of the airline.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingDetailControllerTest/bookingDetails/http-request.adoc[]

Table 3. Path params
Parameter Description

bookingId

Booking id (UUID)
HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingDetailControllerTest/bookingDetails/http-response.adoc[]

Booking Details response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingDetailControllerTest/bookingDetails/response-fields.adoc[]

Refund Details

Endpoint for getting refund details by booking for each passenger segment.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refundInfo/http-request.adoc[]

Table 4. Path params
Parameter Description

bookingId

Booking id (UUID)
HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refundInfo/http-response.adoc[]

Refund Details response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refundInfo/response-fields.adoc[]

Refund

Endpoint for performing a refund on the specified passenger segments of the booking.

Http Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refund/http-request.adoc[]

Table 5. Path params
Parameter Description

bookingId

Booking id (UUID)
Request body

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refund/request-body.adoc[]

Refund request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refund/request-fields.adoc[]

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingRefundControllerTest/refund/http-response.adoc[]

Add Infant

The endpoint is designed to add an infant for the current booking. Information about the route, brand and fare rules is inherited from the main booking.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createAddInfBooking/http-request.adoc[]

Add Infant request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createAddInfBooking/request-fields.adoc[]

As a result of the operation, a new booking with an infant is created, which is associated with the main booking.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createAddInfBooking/http-response.adoc[]

Add Infant response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingControllerTest/createAddInfBooking/response-fields.adoc[]

Exchange Flight Alternative Dates

Endpoint for getting exchange flight alternative dates by booking ID and flightIDs.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/alternativeFlightInfo/http-request.adoc[]

Table 6. Path params
Parameter Description

bookingId

Booking id (UUID)
HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/alternativeFlightInfo/http-response.adoc[]

Response params

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/alternativeFlightInfo/response-fields.adoc[]

Get Exchange Alternative Flights

An endpoint for getting for an alternative flights to exchange.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/bookingFlights/http-request.adoc[]

Table 7. Path params
Parameter Description

bookingId

Booking id (UUID)

The response contains information about each available flight and passengers.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/bookingFlights/http-response.adoc[]

Get Exchange Alterntive Flights response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/bookingFlights/response-fields.adoc[]

Search exchange options by pax segment IDs and flight date

Endpoint for searching exchange options by pax segment IDs and flight date.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchangeSearch/http-request.adoc[]

Table 8. Path params
Parameter Description

bookingId

Booking id (UUID)
Booking Exchange Search request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchangeSearch/request-fields.adoc[]

The response contains information about the exchange option routes.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchangeSearch/http-response.adoc[]

Booking Exchange response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchangeSearch/response-fields.adoc[]

Execute booking exchange

Endpoint for executing booking exchange.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchange/http-request.adoc[]

Table 9. Path params
Parameter Description

bookingId

Booking id (UUID)
Booking Exchange request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchange/request-fields.adoc[]

The response contains new booking ID and newly created order ID.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchange/http-response.adoc[]

Booking Exchange response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/exchange/response-fields.adoc[]

Get booking exchange preview

Endpoint for getting booking exchange preview.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/preview/http-request.adoc[]

Table 10. Path params
Parameter Description

bookingId

Booking id (UUID)
Booking Exchange Preview request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/preview/request-fields.adoc[]

The response contains booking exchange preview data.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/preview/http-response.adoc[]

Booking Exchange preview response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/preview/response-fields.adoc[]

Get exchange calendar by specified filter

Endpoint for getting exchange calendar by specified filter.

HTTP Request

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/getExchangeCalendar/http-request.adoc[]

Table 11. Path params
Parameter Description

bookingId

Booking id (UUID)
Booking Exchange calendar request fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/getExchangeCalendar/http-request.adoc[]

The response flight dates for specified request.

HTTP Response

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/getExchangeCalendar/http-response.adoc[]

Booking Exchange calendar response fields

Unresolved directive in agency-api.adoc - include::/mnt/gitlab-runner/builds/RRsrzGr7L/1/farel_repos/farel-os/farel-os-api/application/../agency-api/target/generated-snippets/AgencyApiBookingExchangeControllerTest/getExchangeCalendar/response-fields.adoc[]

Service Payload

Each service has additional parameters, which depend on the category of the service.

Table 12. Service Payload Description

Service Category

Payload Path

Type

Description

BAGGAGE

payload.type

String

Type of baggage: Cabin or Check-in

BAGGAGE

payload.weight

Short

Baggage weight

Errors code

Agency API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc). Codes in the 5xx range indicate an error with Agency API’s servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.

Table 13. HTTP Status code summary

HTTP Code

Description

200, 201, 202 - OK

Everything worked as expected.

304 - Not Modified

The request redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource.

400 - Bad Request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

No valid API key provided.

403 - Forbidden

Forbidden. The API key doesn’t have permissions to perform the request.

404 - Not Found

The requested resource doesn’t exist.

500, 502, 503, 504 - Server Errors

Something went wrong on Agency API’s end. (These are rare.)