API Specification with examples
Legend for tables:
-
St: status — M = Mandatory, C = Conditional, O = Optional
-
Rep: repetition (max occurrences)
Api endpoints have been grouped into three main categories. Use the right-hand menu to navigate between the different endpoints.
Schemas (reference)
ErrorResponse
| Field | Structure | St | Rep | Comments |
|---|---|---|---|---|
status |
String |
O |
0..1 |
HTTP status text |
statusCode |
Integer (int32) |
O |
0..1 |
HTTP status code |
message |
String |
O |
0..1 |
Human-readable error |
errorCode |
String |
O |
0..1 |
Error code identifier |
errors |
String[ ] |
O |
0..n |
Detail messages |
JourneyResponse (selected fields)
| Field | Structure | St | Rep | Comments |
|---|---|---|---|---|
recordLocator |
String |
O |
0..1 |
PNR |
journeyId |
Integer (int32) |
O |
0..1 |
Journey id |
passenger |
PassengerDTO |
O |
0..1 |
Passenger |
baggageSlots |
Array of BaggageSlotDTO |
O |
0..n |
Slots and baggage |
flights |
Array of JourneyFlightDTO |
O |
0..n |
Flights |
totalAllowance |
Integer (int32) |
O |
0..1 |
Allowance |
ticketOpenForBagtag |
Boolean |
O |
0..1 |
Ticket open for bag tag |
ticketOpenForCheckin |
Boolean |
O |
0..1 |
Ticket open for check-in |
version |
Integer (int32) |
O |
0..1 |
Optimistic version |
carrier |
String |
O |
0..1 |
Carrier |
destinationAirport |
String |
O |
0..1 |
Destination |
departureAirport |
String |
O |
0..1 |
Departure |
boardingTime |
String (date-time) |
O |
0..1 |
Boarding time |
scheduledArrival |
String (date-time) |
O |
0..1 |
Scheduled arrival |
scheduledDeparture |
String (date-time) |
O |
0..1 |
Scheduled departure |
passengerName |
String |
O |
0..1 |
Display name |
baggageAllowanceUnit |
String (nullable) |
O |
0..1 |
Unit |
passiveTagsEnabled |
Boolean (nullable) |
O |
0..1 |
Passive tags |
baggageCancellationAllowed |
Boolean (nullable) |
O |
0..1 |
Cancellation |
validations |
Array of JourneyValidation |
O |
0..n |
Validation messages |
firstTransferFlightNumber |
String |
O |
0..1 |
Transfer flight 1 |
firstTransferAirport |
String |
O |
0..1 |
Transfer airport 1 |
secondTransferFlightNumber |
String |
O |
0..1 |
Transfer flight 2 |
secondTransferAirport |
String |
O |
0..1 |
Transfer airport 2 |
BaggageDTO
| Field | Structure | St | Rep | Comments |
|---|---|---|---|---|
baggageId |
Integer (int32) |
O |
0..1 |
Baggage id |
bagtagHumanReadable |
String |
O |
0..1 |
Human-readable tag |
licenseplate |
String |
O |
0..1 |
License plate code |
greenstrip |
Boolean |
O |
0..1 |
Green strip |
priority |
Boolean |
O |
0..1 |
Priority |
createdByBagId |
Boolean |
O |
0..1 |
Created via BagID |
deviceId |
Integer (int32) |
O |
0..1 |
Linked device |
specialRequirement |
String |
O |
0..1 |
Special requirement |