v6.1.0 | May 1, 2020
- The Alternate Date API Request has been enhanced with the following changes:
- Deleted Passenger Type Code. NOTE: The below optional parameter is no longer available for our customers with version 5.2.0 or later: PassengerType/@Code - more information available in SAN 15673 from 10th SEP 2019.
- The Alternate Date API OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
- ElapsedTime attribute has been added at the ScheduleDesc and LegDesc levels.
- The MandatoryInd indicates mandatory Offer Items that cannot be removed from the Offer. Added at the Fare and Passenger Information levels.
- New attribute LastTicketTime added at FareType level.
- The Parameters FareAmount and FareCurrency at FareComponentDesc level have been changed to optional.
- The Operating Carrier Code has been changed from required to optional.
API Information
What's New
- The Alternate Date API Request has been enhanced with the following changes:
- Deleted Passenger Type Code. NOTE: The below optional parameter is no longer available for our customers with version 5.2.0 or later: PassengerType/@Code - more information available in SAN 15673 from 10th SEP 2019.
- The Alternate Date API OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
- ElapsedTime attribute has been added at the ScheduleDesc and LegDesc levels.
- The MandatoryInd indicates mandatory Offer Items that cannot be removed from the Offer. Added at the Fare and Passenger Information levels.
- New attribute LastTicketTime added at FareType level.
- The Parameters FareAmount and FareCurrency at FareComponentDesc level have been changed to optional.
- The Operating Carrier Code has been changed from required to optional.
Business Value
- Each of these enhancements enable greater personalization and efficiency to further refine the search.
New Features
In the Response
Optional
- Parameter: elapsedTime
-
Type: integer
Description: This information allows customers to display travel time for NDC and ATPCO Offers.
Sample Value:
OTA Response format:
<PricedItinerary>
<AirItinerary DirectionInd="Return"/>
<OriginDestinationOptions>
<OriginDestinationOption ElapsedTime="290"/>
</OriginDestinationOptions>
</PricedItinerary>
GIR Response format:
<LegDesc ID="1" ElapsedTime="471">
<Schedule Ref="35"/>
<Schedule Ref="34"/>
</LegDesc>Note: The elapsedTime at OriginDestinationOption in OTA Response format. The elapsedTime at legDescs level in GIR format. This parameter is available on both, NDC and ATPCO path.
In the Response
Optional
- Parameter: elapsedTime
-
Type: integer
Description: This information allows customers to display travel time for NDC and ATPCO Offers.
Sample Value:
OTA Response format:
<FlightSegment DepartureDateTime="2020-05-19T11:15:00"
ArrivalDateTime="2020-05-19T12:35:00" StopQuantity="0"
FlightNumber="2131" ResBookDesigCode="Q" ElapsedTime="80">
<DepartureAirport LocationCode="CBR"/>
<ArrivalAirport LocationCode="MEL"/>
<Equipment AirEquipType="DH4"/>
<MarketingAirline Code="QF"/>
<MarriageGrp>I</MarriageGrp>
<DepartureTimeZone GMTOffset="10"/>
<ArrivalTimeZone GMTOffset="10"/>
<TPA_Extensions>
<eTicket Ind="true"/>
</TPA_Extensions>
</FlightSegment>
GIR Response format:
<ScheduleDesc ID="35" DotRating="6" Frequency="SM*W*F*" Stops="0"
ETicketable="true" TotalMilesFlown="2401" ElapsedTime="321">
<Departure Airport="LAX" City="LAX" State="CA" Country="US"
Time="06:00:00-08:00" Terminal="0"/>
<Arrival Airport="PHL" City="QPH" State="PA" Country="US"
Time="14:21:00-05:00" Terminal="0"/>
<Carrier Marketing="AA" MarketingFlightNumber="814" Operating="AA"
OperatingFlightNumber="814" Alliances="OW ">
<Equipment Code="321" TypeForFirstLeg="N" TypeForLastLeg="N"/>
</Carrier>
</ScheduleDesc>Note: The elapsedTime at FlightSegment in OTA Response format. The elapsedTime at the scheduleDescs level in GIR format. This parameter is available on both NDC and ATPCO paths.
In the Response
Optional
- Parameter: mandatoryInd
-
Type: boolean
Description: If set to 'true', indicates mandatory Offer Items that cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.
Sample Value:
OTA Response format:
<AirItineraryPricingInfo FareReturned="true" PricingSource="ADVJR1" PricingSubSource="NDC_CONNECTOR">
<Offer MandatoryInd="true" OfferId="dg7d9d79cd96p8926k8jt45sc0-43" Source="NDC" TimeToLive="900"/>
</AirItineraryPricingInfo>
GIR Response format:
<PricingInformation PricingSubsource="NDC_CONNECTOR">
<Offer MandatoryInd="true" ServiceId="dg7d9d79cd96p8926k8q95jjb0-5-1-1"
OfferId="dg7d9d79cd96p8926k8q95jjb0-5" TimeToLive="900" Source="NDC"/>
</PricingInformation>Note: Mandatory indicator at the Fare level. Applicable for ATPCO and NDC content.
In the Response
Optional
- Parameter: mandatoryInd
-
Type: boolean
Description: If set to 'true', indicates mandatory Offer Items that cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.
Sample Value:
OTA Response format:
<PTC_FareBreakdowns>
<PTC_FareBreakdown>
<OfferItem MandatoryInd="true"
OfferItemId="dg7d9d79cd96p8926k8jt45sc0-45-1"
ServiceId="dg7d9d79cd96p8926k8jt45sc0-45-1-1"/>
<PassengerTypeQuantity Code="ADT" Quantity="1"/>
</PTC_FareBreakdown>
</PTC_FareBreakdowns>
GIR Response format:
<PricingInformation PricingSubsource="NDC_CONNECTOR">
<Offer OfferId="dg7d9d79cd96p8926k8q95jjb0-5" TimeToLive="900" Source="NDC"/>
<Fare ValidatingCarrierCode="AA" ETicketable="true">
<PassengerInfo OfferItemId="dg7d9d79cd96p8926k8q95jjb0-5-1" MandatoryInd="true"
ServiceId="dg7d9d79cd96p8926k8q95jjb0-5-1-1" PassengerType="ADT" PassengerNumber="1">
</PassengerInfo>
</Fare>
</PricingInformation>Note: Mandatory indicator at the Passenger Information level. Applicable for ATPCO and NDC content.
In the Response
Optional
- Parameter: lastTicketTime
-
Type: string
Description: New attribute added at the Fare level.
Sample Value:
OTA Response format:
<AirItineraryPricingInfo PricingSource="ADVJR1" PricingSubSource="MIP"
FareReturned="true" LastTicketDate="2020-02-15" LastTicketTime="10:28">
</AirItineraryPricingInfo>
GIR Response format:
<Itinerary ID="3" PricingSource="ADVJR1">
<PricingInformation PricingSubsource="MIP">
<Fare ValidatingCarrierCode="LO" VITA="true" ETicketable="true" LastTicketDate="2020-04-07" LastTicketTime="20:19" GoverningCarriers="LO">
</Fare>
</PricingInformation>
</Itinerary>Note: Pattern: HH_MM
Functional Updates And Enhancements
In the Response
Optional
- Parameter: fareAmount
-
Type: decimal
Description: An existing Fare Component parameter is now optional.
Sample Value:
<FareComponentDesc ID="17" GoverningCarrier="AA" FareAmount="67.72" FareCurrency="USD" FareBasisCode="OVAHZSB3/DRB" FarePassengerType="ADT" TicketDesignator="DRB" PublishedFareAmount="67.72" OneWayFare="true" PrivateFare="true" Directionality="FROM" Direction="WH" NotValidBefore="2020-12-25" NotValidAfter="2020-12-25" ApplicablePricingCategories="10 15 18 25" FareComponentReferenceID="1" VendorCode="ATP" FareTypeBitmap="0A" FareType="EOU" FareTariff="770" FareRule="XX26">
<Segment/>
<Segment/>
<Brand Code="BASIC" BrandName="BASIC ECONOMY" ProgramID="164434" ProgramCode="AADOM"
ProgramDescription="AABFDOM1S" ProgramSystemCode="A"/>
</FareComponentDesc>Note: Changed from required to optional. The example presents GIR Response format.
In the Response
Optional
- Parameter: fareCurrency
-
Type: CurrencyCode
Description: An existing Fare Component parameter is now optional.
Sample Value:
<FareComponentDesc ID="17" GoverningCarrier="AA" FareAmount="67.72" FareCurrency="USD" FareBasisCode="OVAHZSB3/DRB" FarePassengerType="ADT" TicketDesignator="DRB" PublishedFareAmount="67.72" OneWayFare="true" PrivateFare="true" Directionality="FROM" Direction="WH" NotValidBefore="2020-12-25" NotValidAfter="2020-12-25" ApplicablePricingCategories="10 15 18 25" FareComponentReferenceID="1" VendorCode="ATP" FareTypeBitmap="0A" FareType="EOU" FareTariff="770" FareRule="XX26">
<Segment/>
<Segment/>
<Brand Code="BASIC" BrandName="BASIC ECONOMY" ProgramID="164434" ProgramCode="AADOM"
ProgramDescription="AABFDOM1S" ProgramSystemCode="A"/>
</FareComponentDesc>Note: Changed from required to optional. The example presents GIR Response format.
In the Response
Optional
- Parameter: Operating
-
Type: CarrierCode
Description: Operating airline code.
Sample Value:
<ScheduleDesc ID="41" DotRating="5" Frequency="*M*W*F*" Stops="0" ETicketable="true" TotalMilesFlown="213" ElapsedTime="87">
<Departure Airport="DCA" City="WAS" State="DC" Country="US" Time="19:35:00-05:00" Terminal="C" />
<Arrival Airport="JFK" City="NYC" State="NY" Country="US" Time="21:02:00-05:00" Terminal="8" />
<Carrier Marketing="AA" MarketingFlightNumber="4454" Operating="AA" OperatingFlightNumber="4454" CodeShared="REPUBLIC AIRWAYS AS AMERICAN EAGLE" Alliances="OW ">
<Equipment Code="E75" TypeForFirstLeg="N" TypeForLastLeg="N" />
</Carrier>
</ScheduleDesc>Note: Parameter already present in the schema, changed from required to optional. For the NDC offers, the operating carrier value is optional and very often might not appear in the response.
v5.2.0 | July 23, 2019
- No changes for this functionality in this Release. Only schema version upgrade to 5.2.0.
API Information
What's New
- No changes for this functionality in this Release. Only schema version upgrade to 5.2.0.
v4.3.0 | September 20, 2018
- No changes for this functionality in this Release. Only schema version upgrade to 4.3.0.
API Information
What's New
- No changes for this functionality in this Release. Only schema version upgrade to 4.3.0.
Business Value
- This enhancement enables greater personalization and efficiency of response structure in case of AirStreaming functionality.
New Features
In the Request
Optional
- Parameter: AirStreaming
-
Type: mixed
Description: New parameter to activate the AirStreaming functionality which allows to receive a chunked response. Attribute MaxItinsPerChunk is set individually by the customers and configures what is the maximum amount of itineraries per one chunk in the below example the value is set to max. 10 Itineraries per chunk. There are 2 types of streaming available, therefore the Method of AirStreaming is equal either to “Services” or “WholeResponse”.
Sample Value:
|-|IntelliSellTransaction|--| |-|AirStreaming Method="Services" MaxItinsPerChunk="10"/|--||-|/IntelliSellTransaction|--|Note: This feature requires some development work on the customer’s side, therefore more information is available in dedicated DAG Document. The same document describes 2 available types of AirStreaming. Functionality is available in XML over the REST Endpoints. Applies to BargainFinderMax, Alternate Airport Shop, and Alternate Dates services.
v4.2.0 | June 27, 2018
- Alternate Date has been enhanced with the following new optional search parameters:
- Long Connect – To specify the number or percentage of itineraries with long connections to be returned.
- AirShoppingRuleManager – To specify and invoke the traveler persona rules.
- Additionally, the following information will be returned in the BargainFinderMax response:
- Forced Stopover Indicator – New indicator at the segment level to denote stopover point.
API Information
What's New
- Alternate Date has been enhanced with the following new optional search parameters:
- Long Connect – To specify the number or percentage of itineraries with long connections to be returned.
- AirShoppingRuleManager – To specify and invoke the traveler persona rules.
- Additionally, the following information will be returned in the BargainFinderMax response:
- Forced Stopover Indicator – New indicator at the segment level to denote stopover point.
Business Value
- Each of these new parameters power new ways to market, shop and convert lookers to bookers.
New Features
In the Request
Optional
- Parameter: NumberOfSolutions
-
Type: CountOrPercentage
Description: Indicator to specify the desired number of solutions to be returned in the response either in percentage or a number.
Sample Value:
|-|TravelPreferences ValidInterlineTicket="true"|--||-|TPA_Extensions|--| |-|TripType Value="OneWay"/|--| |-|LongConnectTime Enable="true" Min="781" NumberOfSolutions="23%"/|--| |-|JumpCabinLogic Disabled="true"/|--||-|/TPA_Extensions|--||-|/TravelPreferences|--|
In the Request
Required
- Parameter: TravelerPersona@Name
-
Type: String
Description: New parameter to specify the traveler persona as created via the Air Shopping Rules Manager.
Sample Value:
|-|IntelliSellTransaction|--| |-|RequestType Name="50ITINS"/|--| |-|TravelerPersona Name=”ABCTRAVEL”/|--||-|/IntelliSellTransaction|--|Note: The name of the ‘Travel Persona’ is to be used with the Air Shopping Rules Manager application, only. The applicable rules associated to the travel persona will be invoked by Bargain Finder Max.
In the Response
Optional
- Parameter: RequestedStopover Ind
-
Type: Boolean
Description: Indicator to identify which segment is the one departing from the stopover point in the BargainFinderMax response (within one leg).
Sample Value:
|-|FlightSegment DepartureDateTime="2018-08-12T16:50:00" ArrivalDateTime="2018-08-12T20:20:00" StopQuantity="0" FlightNumber="872" ResBookDesigCode="V" ElapsedTime="150"|--| |-|DepartureAirport LocationCode="LHR" TerminalID="5"/|--| |-|ArrivalAirport LocationCode="KRK"/|--| |-|OperatingAirline Code="YY" FlightNumber="872"/|--| |-|Equipment AirEquipType="320"/|--| |-|MarketingAirline Code="YY"/|--| |-|MarriageGrp|--|O|-|/MarriageGrp|--| |-|DepartureTimeZone GMTOffset="1"/|--| |-|ArrivalTimeZone GMTOffset="2"/|--| |-|TPA_Extensions|--| |-|eTicket Ind="true"/|--| |-|Mileage Amount="889"/|--| |-|RequestedStopover Ind="true"/|--| |-|/TPA_Extensions|--||-|/FlightSegment|--|
v4.1.0 | March 27, 2018
- Alternate Date has been enhanced to enable more flexibility within the request and return additional information in the response as follows:
- Return only options with at least one free bag.
- Search by fare basis code(s).
- Exclude Codeshare flights.
- Additionally the following information will be returned in the response:
- More details in the Selling Fare Data applicable to Agency Retailer.
- Extended Ancillary Fee Groups with ancillary subcode(s), type(s) and hints for up to 10 standard bags.
API Information
What's New
- Alternate Date has been enhanced to enable more flexibility within the request and return additional information in the response as follows:
- Return only options with at least one free bag.
- Search by fare basis code(s).
- Exclude Codeshare flights.
- Additionally the following information will be returned in the response:
- More details in the Selling Fare Data applicable to Agency Retailer.
- Extended Ancillary Fee Groups with ancillary subcode(s), type(s) and hints for up to 10 standard bags.
Business Value
- These enhancements drive greater transparency for baggage allowance and charges, a more streamlined workflow with multiple fares per itinerary and more targeted results with the shop by fare basis code, and a better schedule filtering options with the exclude codeshares parameter.
New Features
In the Request
Optional
- Parameter: FreePieceRequired
-
Type: Boolean
Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search, at the leg level.
Sample Value:
|-|OriginDestinationInformation RPH="1"|--| |-|DepartureDateTime|--|2018-09-20T00:00:00|-|/DepartureDateTime|--| |-|OriginLocation LocationCode="LHR"/|--| |-|DestinationLocation LocationCode="JFK"/|--| |-|TPA_Extensions|--| |-|SegmentType Code="O"/|--| |-|Baggage FreePieceRequired="true"/|--| |-|/TPA_Extensions|--||-|/OriginDestinationInformation|--||-|TravelPreferences|--| |-|TPA_Extensions|--| |-|/TPA_Extensions|--| |-|Baggage FreePieceRequired="false" RequestType="A"/|--||-|/TravelPreferences|--|Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.
In the Request
Optional
- Parameter: FreePieceRequired
-
Type: Boolean
Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search for the whole journey.
Sample Value:
|-|TravelPreferences|--| |-|TPA_Extensions|--||-|Baggage RequestType="A" FreePieceRequired="true"/|--| |-|/TPA_Extensions|--||-|/TravelPreferences|--|Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a bag.
In the Request
Optional
- Parameter: FreePieceRequired
-
Type: Boolean
Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search, at the leg level.
Sample Value:
|-|FlexibleFares|--| |-|FareParameters|--| |-|Leg Num="1"|--| |-|Baggage FreePieceRequired="true"/|--| |-|/Leg|--| |-|Leg Num="2"|--| |-|Baggage FreePieceRequired="false"/|--| |-|/Leg|--| |-|/FareParameters|--||-|/FlexibleFares|--|Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.
In the Request
Optional
- Parameter: FreePieceRequired
-
Type: Boolean
Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search for the MFPI group.
Sample Value:
|-|FlexibleFares|--| |-|FareParameters|--| |-|Baggage FreePieceRequired="true"/|--| |-|Leg Num="1"|--| |-|Cabin Type="Y"/|--| |-|/Leg|--| |-|Leg Num="2"|--| |-|Cabin Type="Y"/|--| |-|/Leg|--| |-|/FareParameters|--||-|/FlexibleFares|--|Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.
In the Request
Optional
- Parameter: FareBasis Code
-
Type: FareBasisType
Description: Fare basis code(s) to be used in a search, at the leg level, in the multiple fares per itinerary group definition.
Sample Value:
|-|FlexibleFares|--| |-|FareParameters|--| |-|ClassOfService Code="U"/|--| |-|Leg Num="1"|--| |-|ClassOfService Code="Q"/|--| |-|FareBasis Code="YCA-"/|--| |-|/Leg|--| |-|/FareParameters|--||-|/FlexibleFares|--|Note: Multiple fare basis code can be requested at the leg level in each multiple fares per itinerary group. Allows wildcards.
In the Request
Optional
- Parameter: FareBasis Code
-
Type: FareBasisType
Description: Ffare basis code(s) to be used in a search, for the whole itinerary, in the multiple fares per itinerary group definition.
Sample Value:
|-|FlexibleFares|--| |-|FareParameters|--| |-|PassengerTypeQuantity Code="NEG" Quantity="2"/|--| |-|FareBasis Code="LLX-"/|--| |-|FareBasis Code="-1S5"/|--| |-|/FareParameters|--||-|/FlexibleFares|--|Note: Multiple fare basis codes can be requested in each multiple fares per itinerary group. Allows wildcards.
In the Request
Optional
- Parameter: CodeShareIndicator
-
Type: CodeShareIndicator
Description: Ability to filter out codeshare flights. This new option is available with two attributes: “ExcludeCodeshare” removes codeshare flights. The same Marketing/Operating (base flights), can be combined with “KeepOnlines” to also return the online flights that are codeshare, for more diversity.
Sample Value:
|-|TravelPreferences|--| |-|TPA_Extensions|--| |-|CodeShareIndicator ExcludeCodeshare="true" KeepOnlines="false"/|--| |-|/TPA_Extensions|--||-|/TravelPreferences|--|
In the Response
Optional
- Parameter: NoMarkupBaseFare
-
Type: Boolean
Description: Applicable to Agency Retailer subscribers. Indicates the original base selling fare, which can include any Fare Retailer Net fare Markups plus any Fare Retailer Handling Fees. Excludes all Fare Retailer Selling rule adjustments.
Sample Value:
|-|NoMarkupBaseFare Amount="161.00" CurrencyCode="USD"/|--|
In the Response
Optional
- Parameter: HiddenHandlingFee
-
Type: Boolean
Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer hidden Handling fee rule was applied.
Sample Value:
|-|SellingFareData LayerTypeName="ART" HiddenHandlingFee="true"|--| |-|HandlingMarkupSummary TypeCode="A" Description="3PCT" ExtendedDescription="HAND BSE" MonetaryAmountValue="0.56" HiddenHandlingFee="true"/|--| |-|HandlingMarkupSummary TypeCode="C" Description="HAND PTK" ExtendedDescription="HAND PTK" MonetaryAmountValue="15.00" HiddenHandlingFee="true"/|--| |-|HandlingMarkupSummary TypeCode="E" Description="2PCT" ExtendedDescription="HAND TTL" MonetaryAmountValue="0.97" HiddenHandlingFee="true"/|--||-|/SellingFareData|--|
In the Response
Optional
- Parameter: NonHiddenHandlingFee
-
Type: Boolean
Description: Applicable to Agency Retailer subscribers. Indicates whether Fare Retailer non-hidden Handling Fee rule was applied.
Sample Value:
|-|SellingFareData LayerTypeName="ART" NonHiddenHandlingFee="true"|--| |-|HandlingMarkupSummary TypeCode="B" Description="5PCT" ExtendedDescription="HAND BSE" MonetaryAmountValue="1.00" NonHiddenHandlingFee="true"/|--||-|/SellingFareData|--|
In the Response
Optional
- Parameter: FareRetailerRule
-
Type: Boolean
Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer-Selling level rule was applied.
Sample Value:
|-|HandlingMarkupSummary TypeCode="J" Description="ADJT AMT" ExtendedDescription="ADJT AMT" MonetaryAmountValue="6.04" FareRetailerRule="true"/|--|
In the Response
Optional
- Parameter: AncillaryTypeCode
-
Type: String
Description: AncillaryTypeCode that corresponds to a type of ancillary, type F or P (treated as F) and is being displayed for all the ancillary groups.
Sample Value:
|-|AncillaryFeeGroup Code="BG" Name="BAGGAGE"|--| |-|AncillaryFeeItem Amount="25.00" Description="1ST ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CC" BaggageID="1"/|--| |-|AncillaryFeeItem Amount="45.00" Description="2ND ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CD" BaggageID="2"/|--| |-|AncillaryFeeItem Amount="45.00" Description="3RD OR MORE ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CE" BaggageID="3"/|--| |-|AncillaryFeeItem Amount="30.80" Description="RUCKSACK OR KNAPSACK" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0EB" BaggageID="4"/|--||-|/AncillaryFeeGroup|--|Note: If one of the records is F type and another P (treated as F) and both have the same subcode, P type will take precedence.
In the Response
Optional
- Parameter: Subcode
-
Type: String
Description: Optional service industry subcodes that are being displayed for all ancillary groups.
Sample Value:
|-|AncillaryFeeGroup Code="BG" Name="BAGGAGE"|--| |-|AncillaryFeeItem Amount="25.00" Description="1ST ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CC" BaggageID="1"/|--| |-|AncillaryFeeItem Amount="45.00" Description="2ND ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CD" BaggageID="2"/|--| |-|AncillaryFeeItem Amount="45.00" Description="3RD OR MORE ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CE" BaggageID="3"/|--| |-|AncillaryFeeItem Amount="30.80" Description="RUCKSACK OR KNAPSACK" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0EB" BaggageID="4"/|--||-|/AncillaryFeeGroup|--|Note: List of standard ATPCO subcodes: 0CC, 0CD, 0CE, 0CF, 0CG, 0CH, 0CI, 0CJ, 0CK, 0EN.
In the Response
Optional
- Parameter: BaggageID
-
Type: BaggageIDType
Description: Baggage ID number that follows the current hierarchy in sorting Air Extras.
Sample Value:
|-|AncillaryFeeGroup Code="BG" Name="BAGGAGE"|--| |-|AncillaryFeeItem Amount="25.00" Description="1ST ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CC" BaggageID="1"/|--| |-|AncillaryFeeItem Amount="45.00" Description="2ND ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CD" BaggageID="2"/|--| |-|AncillaryFeeItem Amount="45.00" Description="3RD OR MORE ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CE" BaggageID="3"/|--| |-|AncillaryFeeItem Amount="30.80" Description="RUCKSACK OR KNAPSACK" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0EB" BaggageID="4"/|--||-|/AncillaryFeeGroup|--|
In the Response
Optional
- Parameter: Code
-
Type: PassengerCodeType
Description: Passenger type code related to a specific baggage sequence order with applicable hints.
Sample Value:
|-|OrderStandardBag|--| |-|PassengerBags Code="ADT"|--| |-|BaggageSequenceOrder BaggageID="1" StandardBag="1"/|--| |-|BaggageSequenceOrder BaggageID="2" StandardBag="2"/|--| |-|BaggageSequenceOrder BaggageID="3" StandardBag="3"/|--| |-|/PassengerBags|--||-|/OrderStandardBag|--|
In the Response
Required
- Parameter: BaggageID
-
Type: BaggageIDType
Description: Baggage ID number for the applicable baggage hints.
Sample Value:
|-|OrderStandardBag|--| |-|PassengerBags Code="ADT"|--| |-|BaggageSequenceOrder BaggageID="1" StandardBag="1"/|--| |-|BaggageSequenceOrder BaggageID="2" StandardBag="2"/|--| |-|BaggageSequenceOrder BaggageID="3" StandardBag="3"/|--| |-|/PassengerBags|--||-|/OrderStandardBag|--|
In the Response
Required
- Parameter: StandardBag
-
Type: Short
Description: Standard baggage hint: for example, “1” is the first standard baggage, “2” is the second standard baggage, etc.
Sample Value:
|-|OrderStandardBag|--| |-|PassengerBags Code="ADT"|--| |-|BaggageSequenceOrder BaggageID="1" StandardBag="1"/|--| |-|BaggageSequenceOrder BaggageID="2" StandardBag="2"/|--| |-|BaggageSequenceOrder BaggageID="3" StandardBag="3"/|--| |-|/PassengerBags|--||-|/OrderStandardBag|--|
v3.3.0 | September 28, 2017
- Alternate Date has been enhanced to return additional information in the response as follows:
- New indicator in the response to advise baggage allowance is not permitted
API Information
What's New
- Alternate Date has been enhanced to return additional information in the response as follows:
- New indicator in the response to advise baggage allowance is not permitted
Business Value
- These enhancement drive greater transparency for baggage allowance and charges.
New Features
In the Response
Optional
- Parameter: NoChargeNotAvailable
-
Type: CharacterType
Description: This attribute will be returned in the response whenever there are no charge or charges are unavailable when requesting baggage information. The response might contain one of the below possible description: X - Service not available F - no charge for service (free) and an EMD is not issued to reflect free service E - No charge for service (free) and an EMD is issued to reflect the fee service. G - No charge for service (free), booking is not required and an EMD is not issued to reflect free service. H - No charge for service (free), booking is not required, and an EMD is issued to reflect the free service.
Sample Value:
|-|BaggageInformation ProvisionType="C" AirlineCode="S7"|--| |-|Segment Id="0"/|--| |-|Charge EquivalentAmount="0" EquivalentCurrency="RUB" Description1="UP TO 70 POUNDS/32 KILOGRAMS" Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS" NoChargeNotAvailable="X"/|--| |-|/BaggageInformation|--|
v3.2.0 | June 15, 2017
- Alternate Date has been enhanced to enable more flexibility within the request and return options to provide additional information in the response as follows: • Additional response element for Validating Carrier without BSP check.
API Information
What's New
- Alternate Date has been enhanced to enable more flexibility within the request and return options to provide additional information in the response as follows: • Additional response element for Validating Carrier without BSP check.