FAB_PkgAvailRS
FAB_PkgAvailRS is an example of a FABRequestResponse. Additionally it contains the HolidaySearchResponse element, which is an example of a FABSearchResponse. The HolidaySearchResponse also includes:
| Attribute or element | Mandatory? | Definition | Note |
|---|---|---|---|
/PackageHolidays | Yes if results are present | List of PackageHolidays | - |
/PackageHolidays/PackageHoliday@ItineraryId | Yes | String | Required for later basket request. Contains encoded ampersand. Length and structure is not fixed. |
/PackageHolidays/PackageHoliday@Supplier | Yes | FAB supplier code | - |
/PackageHolidays/PackageHoliday@Country | No | ISO 3166-1 alpha-2 code of destination country | Due to limited coverage it is advisable to not rely on this attribute |
/PackageHolidays/PackageHoliday@NumberOfNights | Yes for a return trip | Non negative integer. | Simple calculation between departure date and return departure date, no consideration of time. |
/PackageHolidays/PackageHoliday@LeadInPricePerPassenger | Yes | Adult lead in price | - |
/PackageHolidays/PackageHoliday@YouthPrice | No | Youth lead in price | Enabled via backend config; contact support. Attribute will be missing if no youths were searched for. Attribute may be missing if value is unknown; e.g if supplier does not provide it at search. |
/PackageHolidays/PackageHoliday@ChildPrice | No | Child lead in price | Enabled via backend config; contact support. Attribute will be missing if no children were searched for. Attribute may be missing if value is unknown; e.g if supplier does not provide it at search. |
/PackageHolidays/PackageHoliday@InfantPrice | No | Infant lead in price | Enabled via backend config; contact support. Attribute will be missing if no infants were searched for. Attribute may be missing if value is unknown; e.g if supplier does not provide it at search. |
/PackageHolidays/PackageHoliday@FlightOnly | Yes | true indicates trip is a flight. false indicates package. | - |
/PackageHolidays/PackageHoliday@OneWayOnly | Yes | boolean that indicates if trip is oneway or return | - |
/PackageHolidays/PackageHoliday@BookableByFAB | Yes | boolean that indicates if FAB can book this trip | - |
/PackageHolidays/PackageHoliday@Currency | Yes | ISO 4217 alphabetic currency of provided prices | - |
/PackageHolidays/PackageHoliday@BookingChannel | No | - | Advised to ignore |
/PackageHolidays/PackageHoliday@PassengerIdRequired | No, default false | boolean, if true then ID information must be provided to the supplier before departure | - |
/PackageHolidays/PackageHoliday@PassengerIdMandatory | No, default false | boolean, if true then ID information must be provided to the supplier before booking | - |
/PackageHolidays/PackageHoliday@NationalityRequired | No, default false | true or false, if true then nationality information must be provided to the supplier before departure | - |
/PackageHolidays/PackageHoliday@NationalityMandatory | No, default false | true or false, if true then Nationality attribute must be set for each passenger before booking | - |
/PackageHolidays/PackageHoliday@LastTicketTimestamp | No | yyyyMMdd HHmm UTC timestamp for deadline to ticket fare by | - |
/PackageHolidays/PackageHoliday[*]/Flight@OriginAirport | Yes | IATA code | - |
/PackageHolidays/PackageHoliday[*]/Flight@DestinationAirport | Yes | IATA code | - |
/PackageHolidays/PackageHoliday[*]/Flight@HomeboundDeparturePoint | No | IATA code | Only set for Open Jaw trips |
/PackageHolidays/PackageHoliday[*]/Flight@HomeboundArrivalPoint | No | IATA code | Only set for Open Jaw trips |
/PackageHolidays/PackageHoliday[*]/Flight@DepartureDate | Yes | yyyyMMdd | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@DepartureTime | Yes | HHmm | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeDate | Yes for a return trip | yyyyMMdd | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeTime | Yes for a return trip | HHmm | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeDepartDate | Yes for a return trip | yyyyMMdd | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeDepartTime | Yes for a return trip | HHmm | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@ArrivalDate | Yes | yyyyMMdd | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@ArrivalTime | Yes | HHmm | In local time of airport |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundFlightNumber | Yes | Outbound flight number, prefixed with marketing carrier code | - |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnFlightNumber | Yes for a return trip | Return flight number, prefixed with marketing carrier code | - |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundFlightBasePrice | Yes | Outbound adult price for fare + taxes | For some older supplier integrations this may exclude tax, contact Customer Service for more information |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnFlightBasePrice | Yes for a return trip | Return adult price for fare + taxes | For some older supplier integrations this may exclude tax, contact Customer Service for more information |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundCarrier | No | Outbound operating carrier code of first leg | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnCarrier | No | Return operating carrier code of first leg | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight@MarketingCarrier | Yes | Outbound marketing carrier code of first leg | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundMarketingCarrier | No | Marketing outbound carrier code | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight@InboundMarketingCarrier | No | Marketing indbound carrier code | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight@FareClass | No | Indicates the fare class of the first outbound leg | Generally a single letter, e.g “Y” |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundFlightClass | No | Indicates the fare class of the first outbound leg | Generally a single letter, e.g “Y” |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnFlightClass | No | Indicates the fare class of the first inbound leg | Generally a single letter, e.g “Y” |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundStopPoints | No | IATA code of any technical stops that are part of the outbound flight | - |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnStopPoints | No | IATA code of any technical stops that are part of the return flight | - |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundAirlineName | No | Outbound operating carrier name | - |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnAirlineName | No | Return operating carrier name | - |
/PackageHolidays/PackageHoliday[*]/Flight@OriginAirportName | No | Origin airport name | - |
/PackageHolidays/PackageHoliday[*]/Flight@DestinationAirportName | No | Destination airport name | - |
/PackageHolidays/PackageHoliday[*]/Flight@FareType | Yes | Published Private NoFrills NegoCorporate | - |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundCabinClass | Yes | ECONOMY PREMIUM BUSINESS FIRST | - |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnCabinClass | Yes | ECONOMY PREMIUM BUSINESS FIRST | - |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundJourneyMins | No | total outbound journey duration in minutes | - |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnJourneyMins | No | total return journey duration in minutes | - |
/PackageHolidays/PackageHoliday[*]/Flight@OutboundNumStops | No, default zero | the total number of stops on the outbound journey | - |
/PackageHolidays/PackageHoliday[*]/Flight@ReturnNumStops | No, default zero | the total number of stops on the return journey | - |
/PackageHolidays/PackageHoliday[*]/Flight@ITFare | No, default false | boolean indicating if this flight result is an IT (Inclusive Tour) fare and therefore should only be used when using the flight as part of an “inclusive package”. | - |
/PackageHolidays/PackageHoliday[*]/Flight@CAT35Fare | No, default false | boolean indicating if this flight result is a CAT35 fare | - |
/PackageHolidays/PackageHoliday[*]/Flight@MultiLegOutboundFlight | No, default false | boolean indicating if the outbound flight consists of multiple legs | - |
/PackageHolidays/PackageHoliday[*]/Flight@MultiLegReturnFlight | No, default false | boolean indicating if the return flight consists of multiple legs | - |
/PackageHolidays/PackageHoliday[*]/Flight@DisconnectedFlights | No, default false | boolean, if true then trip is Open Jaw | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance | No | Indicates included baggage allowance | Only supported by select suppliers |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Per | Yes | Passenger or Adult or Youth or Child or Infant | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Unit | Yes | Piece or kg or lb or Unknown | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Quantity | Yes | Integer | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Type | Yes | Hold or Hand | - |
/PackageHolidays/PackageHoliday[*]/Flight/HomeboundBaggageAllowance | No | Same structure as OutboundBaggageAllowance | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*] | No | If segment is multileg/indirect one or more subsegments/legs will be listed | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@DeparturePoint | Yes | IATA code | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@DepartureDate | Yes | yyyyMMdd | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@DepartureTime | Yes | HHmm | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@ArrivalPoint | Yes | IATA code | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@ArrivalDate | Yes | yyyyMMdd | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@ArrivalTime | Yes | HHmm | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@OperatingCarrier | No | Operating carrier code of leg | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@MarketingCarrier | No | Marketing carrier code of leg | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@OperatedBy | No | Operating carrier name | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@FlightNumber | Yes | Flight number, prefixed with marketing carrier code | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@OriginAirportName | No | - | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@DestinationAirportName | No | - | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@FlightClass | No | Indicates the fare class of the leg | Generally a single letter, e.g “Y” |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]@JourneyMins | No | journey duration in minutes of the leg | - |
/PackageHolidays/PackageHoliday[*]/Flight/OutboundSubSegments[*]/BaggageAllowance | No | Same structure as OutboundBaggageAllowance | - |
/PackageHolidays/PackageHoliday[*]/Flight/HomeboundSubSegments[*] | No | Same structure as OutboundSubSegments, only set if inbound segment is a multileg | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*] | No | Contains additional flight details | Generally only populated for MIX trips. |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@Direction | Yes | outbound or inbound | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@Supplier | Yes | FAB Supplier Code | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@MarketingCarrier | No | Marketing carrier code of first leg | Can be IATA or ICAO, depending on the supplier’s preference |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@FareType | No | Published Private NoFrills | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@FareClass | No | Generally a single letter indicating the fare class | Sometimes delimited with a ` |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@ITFare | No, default false | boolean indicating if this flight is an IT (Inclusive Tour) fare and therefore should only be used when using the flight as part of an “inclusive package”. | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]@CAT35Fare | No, default false | boolean indicating if this flight is a CAT35 fare | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]/CostDetails | No, only populated where enabled and supported | Contains a richer breakdown of the flight costs | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]/CostDetails/Charge[*] | No | A charge or cost detail | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]/CostDetails/Charge[*]@Amount | Yes | The charge amount i.e cost | Will be per passenger |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]/CostDetails/Charge[*]@Currency | Yes | ISO 4217 alphabetic currency of Amount | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]/CostDetails/Charge[*]@PaxType | No | Indicates which passenger type the charge/cost applies to; Adult or Youth or Child or Infant. | - |
/PackageHolidays/PackageHoliday[*]/Flight/FlightJourneyDetails[*]/CostDetails/Charge[*]@Type | Yes | Type of charge; Fare or SuppsTaxes or Baggage or EstimatedPaymentCardCharge or SupplierBookingFee | Fare may include tax/discounts/fees if discrete values are not known |
/PackageHolidays/PackageHoliday[*]/Flight/BookingCharges | No, only populated where enabled and supported | Contains a richer breakdown of the booking costs | Similar to CostDetails but for Charges that apply to the whole flight booking |
/PackageHolidays/PackageHoliday[*]/Flight/BookingCharges/Charge[*] | No | A charge or cost detail | - |
/PackageHolidays/PackageHoliday[*]/Flight/BookingCharges/Charge[*]@Amount | Yes | The charge amount i.e cost | Will be per booking |
/PackageHolidays/PackageHoliday[*]/Flight/BookingCharges/Charge[*]@Currency | Yes | ISO 4217 alphabetic currency of Amount | - |
/PackageHolidays/PackageHoliday[*]/Flight/BookingCharges/Charge[*]@Type | Yes | Type of charge; Fare or SuppsTaxes or Baggage or EstimatedPaymentCardCharge or SupplierBookingFee | Fare may include tax/discounts/fees if discrete values are not known |
Last modified May 1, 2024