API Information

Response Format
XML
Service Action Code
GroupedItineraryResponse[object Object]
Current Version
4.2.0
Target Audience
TN
Environment
Production
Documentation
Go to the Alternate Airport Shop documentation

What's New

  • Alternate Airport Shop - GroupedItineraryResponse has been modified to return additional information in the response:
  • Forced Stopover Indicator – a new indicator at segment level to denote stopover point.
  • First and Second Bag - Extended Ancillary Fee Groups with ancillary sub code (s), type(s) and hints for up to 10 standard baggage’s.

Business Value

  • The new parameters added to the response will bring more transparency and accuracy to GroupItineraryResponse.

New Features

In the Response

Required

Parameter: BaggageID

Type: BaggageIDType

Description: A 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>
Note: [object Object]
Parameter: StandardBag

Type: Short

Description: Standard baggage hint: for example, “1” is the first standard baggage, “2” is the second standard baggage.

Sample Value:

<OrderStandardBag> <PassengerBags Code="ADT"> <BaggageSequenceOrder BaggageID="1" StandardBag="1"/> <BaggageSequenceOrder BaggageID="2" StandardBag="2"/> <BaggageSequenceOrder BaggageID="3" StandardBag="3"/> </PassengerBags> </OrderStandardBag>
Note: [object Object]

Optional

Parameter: RequestedStopover

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:

<LegDesc ID="1"> <Schedule Ref="5"/> <Schedule Ref="6" DepartureDateAdjustment="2" RequestedStopover="true"/> <Schedule Ref="10" DepartureDateAdjustment="2"/> </LegDesc>
Note: [object Object]
Parameter: AncillaryTypeCode

Type: String

Description: An 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.
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.
Parameter: BaggageID

Type: BaggageIDType

Description: A baggage ID number which 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>
Note: [object Object]
Parameter: Code

Type: PassengerCodeType

Description: A 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>
Note: [object Object]