API Information

Response Format
XML
Service Action Code
GroupedItineraryResponse
Current Version
3.0.0
Target Audience
TN
Environment
Production
Documentation
Go to the Shop Across Passenger Type GIR documentation

What's New

  • GroupedItineraryResponse has been modified to return additional information in the response: • Baggage Allowance and Charges - Allows you to manage baggage information at the request level. • Override Electronic Ticket Validation - Allows you to select a validating carrier and override the local settlement validation method and Interline Electronic Ticketing (IET) validation.

Business Value

  • Each of these enhancements enable greater personalization and efficiency to further refine the search. Results are more relevant options, which drives higher booking conversion.

New Features

In the Response

Required

Parameter: Charge/@Ref

Type: nonNegativeInteger

Description: Reference to Baggage Charge ID.

Sample Value:

<GroupedItineraryResponse> <ItineraryGroup> <Itinerary> <PricingInformation> <Fare> <PassengerInfo> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment ID="0"/> <Segment ID="1"/> <Allowance Ref="3"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment ID="0"/> <Segment ID="1"/> <Charge Ref="2"/> </BaggageInformation> </PassengerInfo> </Fare> </PricingInformation> </Itinerary> </ItineraryGroup> </GroupedItineraryResponse>
Parameter: ID

Type: nonNegativeInteger

Description: Baggage Charge ID.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Note: “ID” is required within the “BaggageChargeDesc” element.
Parameter: EquivalentAmount

Type: MonetaryAmountType

Description: Equivalent amount for baggage charges.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Note: “EquivalentAmount” is required within the “BaggageChargeDesc” element.
Parameter: EquivalentCurrency

Type: CurrencyCodeType

Description: Equivalent currency for baggage charges.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Note: “EquivalentCurrency” is required within the “BaggageChargeDesc” element.
Parameter: ValidatingCarrierDesc/@ID

Type: nonNegativeInteger

Description: Validating carrier ID.

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="1" SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="QR"> <Country Code="DE"/> <Country Code="GR"/> </Default> <Alternate Code="EK"> <Country Code="DE"/> <Country Code="FR"/> </Alternate> </ValidatingCarrierDesc> </GroupedItineraryResponse>

Optional

Parameter: ProvisionType

Type: BaggageProvisionType

Description: “ProvisionType” indicates baggage information. Valid values are: • “A” - Checked Baggage Allowance. • “C” - Day of Check-in Charges.

Sample Value:

<GroupedItineraryResponse> <ItineraryGroup> <Itinerary> <PricingInformation> <Fare> <PassengerInfo> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment ID="0"/> <Segment ID="1"/> <Allowance Ref="3"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment ID="0"/> <Segment ID="1"/> <Charge Ref="2"/> </BaggageInformation> </PassengerInfo> </Fare> </PricingInformation> </Itinerary> </ItineraryGroup> </GroupedItineraryResponse>
Parameter: AirlineCode

Type: AirlineCodeType

Description: “AirlineCode” indicates the carrier whose baggage provisions apply.

Sample Value:

<GroupedItineraryResponse> <ItineraryGroup> <Itinerary> <PricingInformation> <Fare> <PassengerInfo> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment ID="0"/> <Segment ID="1"/> <Allowance Ref="3"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment ID="0"/> <Segment ID="1"/> <Charge Ref="2"/> </BaggageInformation> </PassengerInfo> </Fare> </PricingInformation> </Itinerary> </ItineraryGroup> </GroupedItineraryResponse>
Parameter: Description1

Type: String

Description: Baggage text information for allowance.

Sample Value:

<GroupedItineraryResponse> <BaggageAllowanceDesc ID="1" Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Parameter: Description2

Type: String

Description: Baggage text information for allowance.

Sample Value:

<GroupedItineraryResponse> <BaggageAllowanceDesc ID="1" Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Parameter: BaggageChargeDesc

Type: Complex

Description: Charge information for the first two checked bags (if applicable).

Sample Value:

N/A
Note: If the “BaggageChargeDesc” element is applicable, the “ID”, “EquivalentAmount,” and “EquivalentCurrency” parameters are required.
Parameter: FirstPiece

Type: Byte

Description: Specify first baggage piece for which the specified charge information applies.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Note: “FirstPiece” can be the same as “LastPiece” if the specified charge applies to one piece only.
Parameter: LastPiece

Type: Byte

Description: Specify last baggage piece for which the specified charge information applies.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Note: “LastPiece” can be the same as “FirstPiece” if the specified charge applies to one piece only.
Parameter: Description1

Type: String

Description: Baggage text information for charges.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Parameter: Description2

Type: String

Description: Baggage text information for charges.

Sample Value:

<GroupedItineraryResponse> <BaggageChargeDesc ID="1" EquivalentAmount="79.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 81 LINEAR INCHES/208 LINEAR CENTIMETERS"/> </GroupedItineraryResponse>
Parameter: SettlementMethod

Type: String (Length 3 characters)

Description: The “SettlementMethod” parameter describes the settlement method verified for the validating carrier(s).

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="1" SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="QR"> <Country Code="DE"/> <Country Code="GR"/> </Default> <Alternate Code="EK"> <Country Code="DE"/> <Country Code="FR"/> </Alternate> </ValidatingCarrierDesc> </GroupedItineraryResponse>
Parameter: NewVcxProcess

Type: Boolean

Description: “NewVcxProcess” indicates whether IET validation was requested (by IETValidation Ind set as “true" or “false” in the request).

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="1" SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="QR"> <Country Code="DE"/> <Country Code="GR"/> </Default> <Alternate Code="EK"> <Country Code="DE"/> <Country Code="FR"/> </Alternate> </ValidatingCarrierDesc> </GroupedItineraryResponse>
Parameter: Default/@Code

Type: CarrierCode

Description: This parameter indicates the default carrier code for Settlement Method and IET validation check.

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="1" SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="QR"> <Country Code="DE"/> <Country Code="GR"/> </Default> <Alternate Code="EK"> <Country Code="DE"/> <Country Code="FR"/> </Alternate> </ValidatingCarrierDesc> </GroupedItineraryResponse>
Parameter: Alternate/@Code

Type: CarrierCode

Description: This parameter indicates the alternate carrier code for Settlement Method and IET check.

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="1" SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="QR"> <Country Code="DE"/> <Country Code="GR"/> </Default> <Alternate Code="EK"> <Country Code="DE"/> <Country Code="FR"/> </Alternate> </ValidatingCarrierDesc> </GroupedItineraryResponse>
Parameter: Country/@Code

Type: String

Description: Returns the country code in which IET validation was done for the default or alternate Validating Carrier. The format is a two-character country code as defined by ISO.

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="1" SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="QR"> <Country Code="DE"/> <Country Code="GR"/> </Default> <Alternate Code="EK"> <Country Code="DE"/> <Country Code="FR"/> </Alternate> </ValidatingCarrierDesc> </GroupedItineraryResponse>
Note: This schema applies if no settlement method with IET validation check was requested: |-|SettlementValidation Ind="false"/|--| |-|IETValidation Ind="true"/|--|
Parameter: Country

Type: String

Description: Country code for which settlement method and IET validation was checked (other than the original POS). Format is a two-character country code as defined by ISO.

Sample Value:

<GroupedItineraryResponse> <ValidatingCarrierDesc ID="3" SettlementMethod="BSP" Country="DE" NewVcxProcess="true"> <Default Code="HR"/> </ValidatingCarrierDesc> </GroupedItineraryResponse>
Note: This schema applies if a settlement method with IET validation check was requested: |-|SettlementValidation Ind="true"/|--| |-|IETValidation Ind="true"/|--| |-|Country Code="PL"/|--|