Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<RefundQuoteRS> | Refund quote response. | 1 | ||
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<ForInfo> | Information group | 0..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<ForInfo> | Information group | 0..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<RefundType/> | Determines whether a refund is allowed. Values are: 0 = Requested part of itinerary is fully refundable 1 = Requested part of itinerary is partially refundable 2 = Requested part of itinerary is non-refundable | [0] [1] [2] | 1 | 0 |
<GuaranteeIndicator/> | Provider-specific indicator to which extent refund is guaranteed. Values for Amadeus are: *ATC Refund based on CAT 33 filling and original TST is automatic C: ATC Refund based on CAT 33 filing and not manually modified P: ATC Refund based on CAT 33 filing manually updated (fare paid, fare used, cancellation penalty or taxes) N: ATC Refund based on CAT 33 filing manually updated (any data but fare paid, fare used, cancellation penalty or taxes) *ATC Refund based on CAT 33 filing and original TST is manual Q: ATC Refund based on CAT 33 filing and not manually modified P: ATC Refund based on CAT 33 filing manually updated (fare paid, fare used, cancellation penalty or taxes) R: ATC Refund based on CAT 33 filing manually updated (any data but fare paid, fare used, cancellation penalty or taxes) *ATC Refund not based on CAT 33 filling (CAT 16 or fictitious CAT 33) U: ATC Refund not based on CAT 33 filing and not manually modified Y: ATC Refund not based on CAT 33 filing and manually updated (fare paid, fare used, cancellation penalty or taxes) Z: ATC Refund not based on CAT 33 filing and manually updated (any data but fare paid, fare used, cancellation penalty or taxes) *ATC Refund Involuntary: I: ATC Invluntary Refund (not manually modified) B: ATC Invluntary Refund (Modify data returned by ATC Involuntary Refund) D: ATC Invluntary Refund (Modify any data except for that returned by ATC) | 0..1 | ||
<RecordLocator> | The record locator of the PNR for which the refund applies. | 1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
</RecordLocator> | ||||
<Traveler> | Traveler details group | 0..N | ||
<TravelerElementNumber/> | Element number of traveler associated to this item. | 0..1 | 1 | |
<TravelerName> | Name group | 1 | ||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<NativeGivenName/> | This field contains the given (first) name as it is returned from the GDS (free form text which contains given name, initial and title). In addition the given name as it comes from the GDS is parsed according to the GDS convention and the content is returned in sibling elments GivenName, Initial and Title. NOTE: client applications which implement their own parsing algorithm should use the content of this field! EXAMPLE: JOHN A MR | 0..1 | ||
</TravelerName> | ||||
</Traveler> | ||||
<TicketData> | Ticket numbers of tickets for which the refund quote applies (may be left out for ticketless providers). | 0..1 | ||
<Ticket> | Ticket Numbers and Coupons that will be refunded | 1..4 | ||
@Number | The ticket number of the ticket to be refunded. | 1 | 0012345467891 | |
<CouponNumber/> | The number of the refundable coupons. | 1..4 | 1 | |
</Ticket> | ||||
<OriginalIssueData> | 1 | |||
<TktIssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<TktIssueTime/> | Time in ISO 8601 format (hh:mm). | 0..1 | 14:00 | |
<IATA/> | IATA number of the agency originating the request. | 1 | 123456 | |
<PseudoCityCode> | Pseudo City Code of the agency requesting the void/cancel. Used to verify if it has the authority for this request. | 1 | LNJ2 | |
</PseudoCityCode> | ||||
<Commission> | The commision that was originally collected (if any) | 0..1 | 200 | |
@Type | The type of commission: Percentage (P) or Amount (A). | 1 | A | |
@NumberOfDecimals | The number of decimals if the commission type is A. | 0..1 | 2 | |
</Commission> | ||||
</OriginalIssueData> | ||||
</TicketData> | ||||
<SegmentIDRef/> | Element number(s) of segments that will be refunded by this Quote. In case only part of the itinerary can be refunded, only the refundable segments will be referenced here. Only returned for ticketless providers! | 0..N | ||
<OriginalData> | 0..1 | |||
<FormOfPayment> | Form of Payment(s) used on the original ticket. | 1 | ||
<CreditCard> | 0..N | |||
@ActualAmount | Actual amount charged to this FOP. | 0..1 | 200000 | |
@RefundAmount | Amount being refunded this FOP. | 0..1 | 200000 | |
<CCCode/> | Credit card code. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCCode/> | Credit card code. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX | |
<CCExpiration> | Credit card expiration group | 1 | ||
<Month/> | Credit card expiration month. | 1 | 02 Can be returned encrypted by GDS/CRS. Example: XX | |
<Year/> | Last two digits of the credit card expiration year. | 1 | 06 Can be returned encrypted by GDS/CRS. Example: XX | |
</CCExpiration> | ||||
<CCExpiration> | Credit card expiration group | 1 | ||
<Month/> | Credit card expiration month. | 1 | 02 Can be returned encrypted by GDS/CRS. Example: XX | |
<Year/> | Last two digits of the credit card expiration year. | 1 | 06 Can be returned encrypted by GDS/CRS. Example: XX | |
</CCExpiration> | ||||
</CreditCard> | ||||
<Other> | Other payment information. | 0..N | "CHECK", "CASH" | |
@ActualAmount | Actual amount charged to this FOP. | 0..1 | 200000 | |
@RefundAmount | Amount being refunded this FOP. | 0..1 | 200000 | |
</Other> | ||||
<DirectDebit> | Direct Debit payment | 0..1 | ||
@ActualAmount | Actual amount charged to this FOP. | 0..1 | 200000 | |
@RefundAmount | Amount being refunded this FOP. | 0..1 | 200000 | |
<SEPA> | SEPA debit withdrawal | 1 | ||
@Type | Specifies SEPA Direct Debit transaction type. Values are: B2B = SEPA Direct Debit B2B COR = SEPA Direct Debit CORE/COR1 | [B2B] [COR] | 0..1 | B2B |
<IBAN/> | IBAN number of the account from which the amount is to be withdrawn. | 1 | ||
<AccountHolderName/> | Name of the account holder. | 0..1 | ||
</SEPA> | ||||
</DirectDebit> | ||||
</FormOfPayment> | ||||
<FareData> | Orignal Base Fare, Taxes, and Total Fare | 1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Price> | Price group | 1 | ||
@Total | Total fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 230000 | |
<BaseFare> | 1 | |||
@Amount | Total base fare amount that includes surcharges (if any). | 1 | 200000 | |
<Surcharges> | Sourcharges group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 1..N | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
</Surcharge> | ||||
</Surcharges> | ||||
</BaseFare> | ||||
<Taxes> | Tax break down information group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<FareRules> | Fare rules information | 0..1 | ||
<FareCalculation/> | Fare Calculation line | 1 | ||
<Remark/> | Free form text remark. FUTURE USE. | 0..N | ||
<TourCode/> | Tour code identifier. | 0..1 | ITGF12 (Galileo / Apollo) | |
</FareRules> | ||||
<Commission> | Represents the commission to be returned to airline | 0..1 | ||
@Type | The type of commission: Percentage (P) or Amount (A). | 1 | A | |
</Commission> | ||||
</FareData> | ||||
<OptionalServices> | Only returned for ticketless provides, where cancellation and refund of the booking also includes cancellation and possibly refund of booked optional services. | 0..1 | ||
@Total | Total fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 230000 | |
</OptionalServices> | ||||
</OriginalData> | ||||
<RefundData> | Data specific to the monetary refund | 1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<FareData> | Base Fare, Taxes, and Total Fare data to be refunded | 0..1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Price> | Price group | 1 | ||
@Total | Total fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 230000 | |
<BaseFare> | 0..1 | |||
@Amount | Total base fare amount that includes surcharges (if any). | 1 | 200000 | |
<Surcharges> | Sourcharges group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 1..N | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
</Surcharge> | ||||
</Surcharges> | ||||
</BaseFare> | ||||
<Taxes> | Tax break down information group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<FareRules> | Fare rules information | 0..1 | ||
<FareCalculation/> | Fare Calculation line | 1 | ||
<Remark/> | Free form text remark. FUTURE USE. | 0..N | ||
<TourCode/> | Tour code identifier. | 0..1 | ITGF12 (Galileo / Apollo) | |
</FareRules> | ||||
<Commission> | Represents the commission to be returned to airline | 0..1 | ||
@Type | The type of commission: Percentage (P) or Amount (A). | 1 | A | |
</Commission> | ||||
</FareData> | ||||
<FeesAndPenalties> | Total fees and penalties | 0..1 | ||
@Amount | Total fees and penalties amount. | 1 | 30000 | |
<Tax> | Tax break down information group. Non-refundable taxes (treated as a penalty). Tax break-down needed for some settlement authorities such as BSP | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
</Tax> | ||||
<CancellationPenalty/> | The amount that is to be paid as cancellation penalty. | 0..1 | 100 | |
</FeesAndPenalties> | ||||
<OptionalServices> | Only returned for ticketless provides, where cancellation and refund of the booking also includes cancellation and possibly refund of booked optional services. | 0..1 | ||
@Total | Total fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 230000 | |
</OptionalServices> | ||||
<TotalRefund> | The total refund amount | 0..1 | ||
@Amount | Amount EXCLUDING any fees and penalties. | 1 | ||
@Refund | Amount INCLUDING any fees and penalties. This is the exact amount returned as a refund. | 0..1 | ||
</TotalRefund> | ||||
</RefundData> | ||||
<RefundQuoteID/> | Quote response ID from the pricing engine - passed to TicketRefundRQ | 1 | ||
<Itinerary> | 0..1 | |||
<Segment> | 1..N | |||
@FareBasisCode | Fare basis code. | 0..1 | Y26 | |
@TicketDesignator | Ticket designator for the fare | 0..1 | ||
@BaggageAllowance | Baggage allowance. PC = per piece 1PC = 1 piece 2PC = 2 pieces nn = per weight (nn is the weight limit). | 0..1 | 2PC | |
@StopOverIndicator | Indicates if stopover is permitted w/ the fare. Uses industry values to refelct the status. Values are X, O When X is the value - the departure city of the segment was considered a transfer point at time of fare calculation. If the passenger to stop in that city, the fare must be recalculated; the fara may or may not permit stopovers. Code O is used to denote that stopover is permitted. | [X] [O] | 0..1 | |
<Ticket> | Ticket information on which current segment appears. Not returned for ticketless providers. | 0..1 | ||
@TicketNumber | Ticket number on which the segment is ticketed. In case of a conjunctive ticket, the actual ticket number is returned. | 1 | ||
<TicketCoupon> | Coupon number and status under which current segment appears on given ticket. | 1 | ||
@CouponNumber | Flight coupon number | 1 | ||
@CouponStatus | The IATA coupon status code. Possible values: A .. AIRPORT CONTROL C .. CHECKED IN E .. EXCHANGED / REISSUED F .. FLOWN/USED G .. CONVERTED TO FIM I .. IRREGULAR OPERATIONS L .. LIFTED/BOARDED N .. COUPON NOTIFICATION O .. OPEN FOR USE P .. PRINTED R .. REFUNDED S .. SUSPENDED T .. PAPER TICKET U .. UNAVAILABLE V .. VOID X .. PRINT EXCHANGE Z .. CLOSED UNK .. UNKNOWN (this means coupon status could not be determined from airline for various reasons. This should be rechecked manually with airline.) | [A] [C] [E] [F] [G] [I] [L] [N] [O] [P] [R] [S] [T] [U] [V] [X] [Z] [UNK] | 0..1 | |
</TicketCoupon> | ||||
</Ticket> | ||||
<ARNK/> | Arrival unknown segment. | 1 | ||
<Flight> | Flight segment data | 1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@MarriedSegment | Indicator to mark a group of married segments. The first Flight in a group of married segments is marked with value "B" (begin), the last Flight with value "E" (end). These two and all Flight elements in between in document order form a group of married segments. | [B] [E] | 0..1 | B |
@VendorLocator | Record locator in the carrier system. Is different from SourceRef since SourceRef could reflect a GDS PNR record locator in multy source environment, whereas this element is the record locator as created in airlines system. | 0..1 | ||
@CnxxIndicator | If attribute CnxxIndicator is returned and value is "Y", the arrival point of this flight segment is a connecting point to the next flight segment, not a stop over point. If the value is "N", the arrival point of this segment is a stop over (or final destination) point. If attribute is not returned this information is not available. Values: Y = Yes N = No | [N] [Y] | 0..1 | Y |
<Departure> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd | 1 | 2008-12-12 | |
<Time/> | Time in ISO 8601 hh:mm format. | 0..1 | 14:00 | |
<Terminal/> | Airport terminal. | 0..1 | 2B | |
</Departure> | ||||
<Arrival> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd. | 0..1 | 2008-12-12 | |
<ChangeOfDay/> | Number of days between departure and arrival. If not present - no change of day - same day as departure. | 0..1 | 1 | |
<Time/> | Time in ISO 8601 hh:mm format. | 0..1 | 14:00 | |
<Terminal/> | Airport terminal. | 0..1 | 2B | |
</Arrival> | ||||
<Carrier> | 1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
</Carrier> | ||||
<OperatingCarrier> | 0..1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
<Comment/> | Free form text additional flight information. | 1 | ||
</OperatingCarrier> | ||||
<CheckIn> | Check In information. Usually associated with code share flights where operating carrier is different from marketing carrier. The this group displays information where passengers should check-in. | 0..1 | ||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
</CheckIn> | ||||
<Equipment> | 0..1 | |||
<Code/> | Aircraft equipment code. | 1 | 772 | |
<Name/> | Equipment (aircraft) name - vendor, model. | 1 | ||
</Equipment> | ||||
<NumberOfStops/> | Number of stops for this flight. | 0..1 | 1 | |
<Meals/> | Indicates what types of meals are served. Meal codes are IATA standard. Values are: B = Breakfast K = Continental breakfast V = Refreshment for purchase L = Lunch D = Dinner S = Snack or brunch O = Cold meal H = Hot meal M = Meal (non-specific) R = Refreshment complimentary C = Alcoholic beverages complimentary F = Food for purchase P = Alcoholic beverages for purchase Y = Duty free sales available G = Food and/or Beverage for purchase N = No meal service | [B] [K] [V] [L] [D] [S] [O] [H] [M] [R] [C] [F] [P] [Y] [G] [N] | 0..N | B |
<ClassOfService/> | Class of service. | 1 | B | |
<ClassOfService/> | Class of service. | 1 | B | |
<Cabin/> | Cabin code. Values are: P = Premium First class F = First class J = Premium Business class C = Business class W = Premium Economy class Y = Coach class | [P] [F] [J] [C] [W] [Y] | 0..1 | Y |
<Information> | Free form additional information for the flight - if any available. | 0..1 | ||
<Text/> | Information text or error text. | 1 | Free flow text. Example: Invalid flight number | |
<Text/> | Information text or error text. | 1 | Free flow text. Example: Invalid flight number | |
</Information> | ||||
<SeatLocation/> | Seat assignment location. | 0..1 | 03A | |
</Flight> | ||||
<Open> | Open segment data | 1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<OpenDeparture> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd | 0..1 | 2008-12-12 | |
</OpenDeparture> | ||||
<OpenArrival> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd. | 0..1 | 2008-12-12 | |
</OpenArrival> | ||||
<Carrier> | 1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
</Carrier> | ||||
<OperatingCarrier> | 0..1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
<Comment/> | Free form text additional flight information. | 1 | ||
</OperatingCarrier> | ||||
<ClassOfService/> | Class of service. | 1 | B | |
<ClassOfService/> | Class of service. | 1 | B | |
</Open> | ||||
</Segment> | ||||
</Itinerary> | ||||
</RefundQuoteRS> |
| Column | Description |
|---|---|
| Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server