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 |
|---|---|---|---|---|
<TicketExchangeRS> | The ticket exchange response. | 1 | ||
@Version | Message version. | 0..1 | 2.2 | |
@TypeOfExchange | The type of exchange that to be performed. Possible values: E = Even exchange A = Add / collect exchange R = Residual exchange | 0..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. | |
@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 | |
</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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<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 | |
<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 | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<RecordLocator/> | The record locator of the PNR for which the ticket to be exchanged has been issued. | 1 | ||
<Traveler> | Traveler details group | 1 | ||
<TravelerElementNumber/> | Element number of traveler associated to this item. | 1 | 1 | |
<TravelerName> | Name group | 1 | ||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<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> | ||||
<ExchangeRequestNumber> | The number of the exchange request as stored by the GDS. Needed for the subsequent TicketIssueRQ. | 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. | |
</ExchangeRequestNumber> | ||||
<ResidualValues> | 0..1 | |||
@NumberOfDecimals | The number of decimals of all amounts shown in this group. | 1 | 2 | |
@Amount | The total unused amount (UnusedBaseFare + UnusedTaxes). | 1 | 24800 | |
<UnusedBaseFare/> | The unused base fare amount. | 0..1 | 23000 | |
<UnusedTaxes/> | The total amount of unused taxes. | 0..1 | 1800 | |
</ResidualValues> | ||||
<Refund> | 0..1 | |||
@NumberOfDecimals | The number of decimals of all amounts shown in this group. | 1 | 2 | |
@Amount | The total amount that is to be refunded (BaseFare + Taxes). | 1 | 24800 | |
<BaseFare/> | The base fare amount that is being refunded. | 0..1 | 23000 | |
<Taxes/> | The total amount of taxes that is being refunded. | 0..1 | 1800 | |
</Refund> | ||||
<AdditionalCollection> | 0..1 | |||
@NumberOfDecimals | The number of decimals of all amounts shown in this group. | 1 | 2 | |
@Amount | The total amount that is to be collected. | 1 | 16200 | |
<BaseFare/> | The base fare amount that is to be collected. | 0..1 | 15000 | |
<Taxes/> | The total amount of taxes that is to be collected. | 0..1 | 1200 | |
</AdditionalCollection> | ||||
<ValidatingCarrier/> | 0..1 | |||
<ReportingTo/> | Whether the agency reports to ARC or BSP. | [ARC] [BSP] | 0..1 | |
</TicketExchangeRS> |
| 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