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 |
|---|---|---|---|---|
<TicketIssueRQ> | 1 | |||
@version | Version number. | 0..1 | 1.0 | |
@ReValidate | If 'Y', revalidates the Fares before Issuing a Ticket, otherwise ignore. Default: N. | 0..1 | ||
@RePrice | Automatically re-price the itinerary in case the stored fare should not be valid any more. Possible values: Y, N Default: N | 0..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. | |
@IgnoreWarnings | If IgnoreWarnings is set to "Y", XX/1 will try to override CRS warning messages by re-issuing the ticketing command a second time. Should only be set if request sent without IgnoreWarnings="Y" fails with a warning and the client application has checked it is valid to ignore that warning. Default: N | [N] [Y] | 0..1 | Y |
@ExtendedFareRuleInfo | This attribute controls whether to use additional transactions to obtain detailed fare rule information, e.g. for refundability or changeability and corresponding penalties for all issued tickets. This can cause several additional requests being sent to the backend system. Values are: - Y: Return additional rule information, only use services that are free of charge. - C: Return additional rule information, use value added fare rule services that are chargeable if offered by provider. On Amadeus, this will call Amadeus MiniRules. - N: dont return additional rule informations (default). | [Y] [C] [N] | 0..1 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'. | 0..1 | ||
<FlightReq> | 1 | |||
<TktFlight> | Flight to be ticketed. | 1..16 | ||
@Element | PNR flight element number. | 1 | 1 | |
</TktFlight> | ||||
</FlightReq> | ||||
<TravelerReq> | 1 | |||
<TktTraveler> | 1..N | |||
@Element | PNR traveler element number. | 1 | 1 | |
@ManualPricingInd | In case of a manual fare, fare validation will not succeed and is omitted / the system response is ignored and ticket issued anyway. Possible values: Y / N. | 0..1 | N. | |
<TktFlight> | Flight to be ticketed. If ommited, request applies to all flights for the traveler. | 0..16 | ||
@Element | PNR flight element number. | 1 | 1 | |
</TktFlight> | ||||
</TktTraveler> | ||||
</TravelerReq> | ||||
<ExchangeReq> | 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. | |
<TktExchangeRequest> | 1 | |||
@ExchangeReqNumber | The number of the exchange request to be ticketed as returned by TicketExchangeRS | 1 | ||
</TktExchangeRequest> | ||||
</ExchangeReq> | ||||
<StoredFareReq> | 1 | |||
<TktStoredFare> | 1 | |||
@FareNumber | Number of FareGroup in PNR to be used for ticketing. | 1 | 2 | |
<TktTraveler> | In case the stored fare does not distinctly reference the travelers priced, but only the travelertypes, the travelers to be ticketed can be specified. If in this case this element is omitted, attempt to ticket all travelers in the PNR will be made. Currently only supported in WorldspanDIR. | 0..N | ||
@Element | PNR traveler element number. | 1 | 1 | |
@ManualPricingInd | In case of a manual fare, fare validation will not succeed and is omitted / the system response is ignored and ticket issued anyway. Possible values: Y / N. | 0..1 | N. | |
<TktFlight> | Flight to be ticketed. If ommited, request applies to all flights for the traveler. | 0..16 | ||
@Element | PNR flight element number. | 1 | 1 | |
</TktFlight> | ||||
</TktTraveler> | ||||
</TktStoredFare> | ||||
</StoredFareReq> | ||||
<InExchangeFor> | IMPORTANT: Currently only supported in - Sabre (only from a PhaseIV and only for BSP markets) - uAPI (Galileo) Instant exchange - assumes all preparation is done all fare information/pricing is stored in PNR and PNR is ready to be used for reissue. | 1 | ||
@Type | Type of exchange transaction. Values are: RI - Reissue RV - Revalidation Default: RI | [RI] [RV] | 0..1 | |
<Ticket> | Data of the ticket that is to be exchanged. In case of a conjunctive ticket, all ticket numbers must be supplied with the coupon numbers that are to be exchanged/refunded. Sabre automatically exchanges all unused coupons. | 1..4 | ||
@Number | 13-digit ticket or document number that you are exchanging. This includes the three-digit airline code and document number as frist 3 digits. | 1 | 0012345467891 | |
<CouponNumber/> | The number of the coupon to be exchanged. | 0..4 | 1 | |
</Ticket> | ||||
<TktStoredFare> | In case of a revalidation use case on Amadeus, there is no stored fare to refer to, as Amadeus does not store a regular TST for revalidations. Mandatory for all other uses cases and providers. | 0..1 | ||
@FareNumber | Number of FareGroup in PNR to be used for ticketing. | 1 | 2 | |
@ManualPricingInd | In case of a manual fare, fare validation will not succeed and is omitted / the system response is ignored and ticket issued anyway. Possible values: Y / N. | 0..1 | N. | |
@Tour | Tour Identifier: F - First Ticket R - Reissue (Exchange) I - Inclusive Tour (IT) Y - IT Ticket Reissue (Exchange) B - Bulk Tour (BT) W - Bulk Ticket Reissue (Exchange) | [F] [R] [I] [Y] [B] [W] | 0..1 | |
<EquivalentFareOriginalTicket> | In case of a manually priced fare (@ManualPricingInd = 'Y'), the client application has to provide the base fare amount of the original ticket that shall be credited for the new Ticket | 0..1 | ||
@Amount | 1 | |||
</EquivalentFareOriginalTicket> | ||||
<Penalty> | In case of a manually priced fare (@ManualPricingInd = 'Y'), the client application has to provide the penaly amount for the exchange. | 0..1 | ||
@Amount | 1 | |||
<Taxes> | 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> | ||||
<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> | ||||
@Paid | Indicator to represent that given tax is already paid. Will be used only in the new Ticket issued as part of exchange process is the BSP markets. Values: "PD", "RF" (.. if refunded). | [PD] [RF] | 0..1 | |
</Tax> | ||||
</Taxes> | ||||
</Penalty> | ||||
<TourCode/> | Tour identifier code if applicable and associated with the priced fare. | 0..1 | U46XIT | |
</TktStoredFare> | ||||
<TktTraveler> | If you have more than one person in the Passenger Name Record (PNR) you must name select. | 1 | ||
@Element | PNR traveler element number. | 1 | 1 | |
</TktTraveler> | ||||
<IATA/> | The IATA number of the agency originally issuing the ticket. | 0..1 | ||
<TktIssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<OriginalIssuePlace/> | Three letter IATA code of the town where the ticket originally has been issued. | 0..1 | MIA | |
<FormOfPayment> | Form of payment of the original ticket being exchanged. | 0..1 | ||
<CreditCard> | 0..N | |||
@PartialAmount | (Partial) Amount allocated to this FOP in case of a split payment. | 0..1 | 75000 | |
<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 | |
<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 113 or *CHECK, CASH | |
@PartialAmount | (Partial) Amount allocated to this FOP in case of a split payment. | 0..1 | 75000 | |
</Other> | ||||
</FormOfPayment> | ||||
<ReportingTo/> | Whether the agency reports to ARC or BSP. | [ARC] [BSP] | 0..1 | |
<Involuntary/> | Whether the exchange is an involuntary exchange driven by airline-side schedule changes. Values are: Y - Yes Examples: Y | [Y] [N] | 0..1 | |
</InExchangeFor> | ||||
<RecordLocator/> | The record locator of the PNR for which the ticket(s) are to be issued. | 1 | XQ23AX | |
<QualifierGroup> | Data sent in the QualifierGroup supplements or overwrites the content of the PNR, depending on the PNR already containing the respective data or not. | 0..1 | ||
<Commission> | 0..1 | |||
@Type | Commission type. Values: P = Percent A = Amount | [P] [A] | 1 | A |
@NumberOfDecimals | Number of decimals for amount value. | 0..1 | ||
</Commission> | ||||
<ValidatingCarrier/> | 0..1 | |||
<FormOfPayment> | Form of Payment Group Multiple form of payments supported by Sabre and Galileo: Sabre: In order to add two forms of payments in your ticketing entry: - You must be a BSP location. - Your location must have the two forms of payment indicator active in the validating carrier table. Only one FOP may be credit card. Note: Sabre does not accept two credit cards. - Your location must have the indicator "two forms of payment" active in your Travel Journal Record (TJR). Galileo: - up to 3 form of payments can be added for BSP locations. | 0..N | ||
<CreditCard> | 1 | |||
<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 | |
<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> | ||||
<SecurityID/> | Credit card security number for online transactions (referred to also as CVV2, CVC2, CSC or CID). This is a 3-digit (Visa, Master, Discover) or 4-digit (Amex) number. | 0..1 | 493 | |
<Authorization> | Credit card authorization group | 0..1 | ||
@Type | Credit card authorization type. Values are: A = authorize card only S = authorize card and store approval code in the PNR D = verify the address associated with this credit card and store the verification status in PNR. If no address associated - error message will be returned. | [A] [S] [D] | 1 | A |
<Amount> | Penalty amount in currency amount or percentage. | 1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] | 0..1 | MIN (MINIMUM PENALTY AMOUNT) MAX MAXIMUM PENALTY AMOUNT) |
</Amount> | ||||
<AirlineCode/> | Airline code. | 1 | AA | |
</Authorization> | ||||
<CardholderFirstName/> | Credit card holder's first name. | 0..1 | JOHN | |
<CardholderLastName/> | Credit card holder's last name. This is only required for Sabre. | 1 | SMITH | |
<CardholderIDRef/> | Reference to a traveler in PNR as cardholder. | 1 | ||
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
<ExtendedPayment> | Credit card extended payment. Values are: Y = Add extended payment N = Do not add extended payment | 0..1 | N | |
@NumberOfMonths | If and only if the value of the ExtendedPayment is set to Y. Identifies the period of extended payment in months. Usually credit card systems (or the travel agency) allows a payment to be extended over a certain number of months. The actual timeframe will vary depending on the credit card system. | 0..1 | 5 | |
@Code | Code necessary for a special form of payment (if ExtendedPayment=Y). For Amadeus: A credit card is used for an initial amount and uniform subsequent monthly installment amounts. The total of the installment amounts is expected in the PartialAmount attribute of the Other element, which has content INSTALLMENT in this case. The currency given in the same FormOfPayment element is used. | 0..1 | CM5 | |
</ExtendedPayment> | ||||
<Remark/> | Form of payment to be sent to history remark. Values are: Y = Yes, N = No. | [Y] [N] | 0..1 | Y |
<CCAddressGroup> | FOR FUTURE USE! (not supported for any GDS/CRS yet) | 0..1 | ||
<Address> | Street or PO Box address. | 1..2 | 5301 Blue Lagoon Drive | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</Address> | ||||
<City> | City name. | 1 | Miami | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</City> | ||||
<PostalCode> | Postal code or zip code. | 1 | 33126 | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</PostalCode> | ||||
<StateCode> | State code. | 0..1 | FL | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</StateCode> | ||||
<CountryCode/> | Country code. | 1 | US | |
</CCAddressGroup> | ||||
</CreditCard> | ||||
<Other/> | Other payment information. | 1 | CHECK, CASH | |
<Amount> | Sabre: For second form of payment an amount must be specified. Remaining amount is automatically taken from first form of payment. Galileo: For all form of payment an amount must be specified. The sum of amounts of all form of payments must match the price of the ticket. | 0..1 | ||
@CurrencyCode | Currency code. | 1 | USD | |
@NumberOfDecimals | Number of decimals for amount value. | 1 | ||
</Amount> | ||||
<Tax> | Sabre supports up to two taxes that can optionally be specified for second form of payment. | 0..N | ||
@CurrencyCode | Currency code. | 1 | USD | |
@NumberOfDecimals | Number of decimals for tax value. | 1 | ||
@Designator | Tax designator. | 1 | US | |
</Tax> | ||||
</FormOfPayment> | ||||
<AddressGroup> | Address group | 0..N | ||
@Use | Indicates use of address information. Values are: B = Billing D = Delivery A = Agency address (Sabre) H = Mailing home address (Amadeus) O = Mailing miscellaneous address (Amadeus) M = Mailing address (Amadeus, Sabre) T = Travel arranger As you can see B and D are supported by all GDS. See for GDS specific address types above. | [B] [D] [A] [H] [O] [M] [T] | 1 | D |
@SplitItems | Indicates if the address elements should be split in the reservation system across multiple lines (entries). Possible values are: Y = split entries N = do not split and keep all elements into one entry | [Y] [N] | 0..1 | N |
<TravelerIDRef/> | Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. | 0..N | T1 | |
<SegmentIDRef/> | ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. | 0..N | F1 | |
<OptionalCompanyName/> | Addressee's if the addressee as an organisation. | 0..1 | ||
<OptionalName/> | Addressee's name. | 1 | PASS Consulting | |
<Addressee> | 1 | |||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<Title/> | Traveler title. | 0..1 | MISS | |
<Gender/> | [F] [M] | 0..1 | ||
</Addressee> | ||||
<Address> | Street or PO Box address. | 1..2 | 5301 Blue Lagoon Drive | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</Address> | ||||
<City> | City name. | 1 | Miami | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</City> | ||||
<PostalCode> | Postal code or zip code. | 1 | 33126 | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</PostalCode> | ||||
<StateCode> | State code. | 0..1 | FL | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</StateCode> | ||||
<CountryCode> | Country code. | 1 | US | |
@SplitItemLine | Allows to specify how to group address items when SplitItems attribut is at Yes. All items with the same SplitItemLine value will be created in the same address element in the GDS. | 0..1 | 1 | |
</CountryCode> | ||||
</AddressGroup> | ||||
<TicketingInstructions> | Used to reference TicketInstructions from PNRViewRS/TicketInstructions that shall be used to drive the ticket(s). Currently only supports DocumentInsturctions on Worldspan (TicketInstructions with SecondaryAction/@Code = "*" ) | 0..N | ||
<ElementNumber> | 1..N | |||
@TattooNumber | Tattoo number. | 0..1 | 2 | |
@TattooQualifier | Tattoo qualifier. | 0..1 | ST | |
</ElementNumber> | ||||
</TicketingInstructions> | ||||
</QualifierGroup> | ||||
<DocumentGroup> | If not specified, the GDS specific standard documents are issued. On Apollo that are: MIR, Itinerary, Ticket, BoardingPass (if possible). | 0..1 | ||
<Invoice> | If 'Y', prints Invoice (MIR in Apollo / Galileo) only. Values are: Y = Yes, N = No. | 0..1 | ||
@JointDocument | Create joint document for all passengers. Values are: Y = Yes, N = No. | [Y] [N] | 0..1 | |
</Invoice> | ||||
<Itinerary> | If 'Y', prints Itinerary only. Values are: Y = Yes, N = No. | 0..1 | ||
@JointDocument | Create joint document for all passengers. Values are: Y = Yes, N = No. | [Y] [N] | 0..1 | |
</Itinerary> | ||||
<MiniItinerary> | If 'Y', prints Mini Itinerary only. TEMP NOTE: according to doc, galileo only supports either or | 0..1 | ||
</MiniItinerary> | ||||
</DocumentGroup> | ||||
<PrinterGroup> | The PrinterGroup specifies the printer(s) to print to. NOTE: The PrinterGroup is mandatory for all GDS, although it may not be required on other CRS! | 0..1 | ||
<PrinterDestination> | Documents are printed on this destination. If not given, the default printer is used. | 1..5 | ||
@Type | The type of printer. Values: B .. boarding pass I .. invoice / itinerary M .. mini itinerary T .. ticket printer H .. hardcopy / accounting printer PP .. PrinterProfile (Sabre only) | [B] [I] [M] [T] [H] [PP] | 1 | T |
@CountryCode | The ticket printer country code. Needed by Sabre. | 0..1 | AB | |
</PrinterDestination> | ||||
<STPDestination> | Documents are printed on this STP (Satellite Ticket Printer, means printer located in a different office location) destination. If not given, then default printer is used. | 0..1 | ||
@Type | The type of printer. Values: B .. boarding pass I .. invoice / itinerary M .. mini itinerary T .. ticket printer H .. hardcopy / accounting printer | 1 | T | |
<AccountID/> | Needed for Sabre | 1 | ||
<PseudoCityCode/> | Agency's pseudo city code. | 1 | LNJ2 | |
<STPID/> | The printer desination ID (LNIATA in Apollo / Galileo) | 1 | ||
</STPDestination> | ||||
</PrinterGroup> | ||||
</TicketIssueRQ> |
| 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