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 |
|---|---|---|---|---|
<SalesReportRS> | Comment describing your root element | 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> | ||||
<Report> | 1 | |||
@AgencyName | Agency PNR belongs to. | 0..1 | XYZ GRP. | |
@PseudoCity | Pseudo city code. | 0..1 | LM21 | |
<ReportDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<ReportTime/> | Time in ISO 8601 format (hh:mm). | 0..1 | 14:00 | |
<Issuance> | 0..N | |||
@TicketInformation | Values are: A = Additional collection E= Even exchange NS = Net informed stored N = Net remit ticket - CreditCard FOP NR = Net remit ticket -Cash FOP P = Printed flight coupons from electronic ticket R = regenerated coupons from electronic ticket SF = selling fare V = Void transaction RF = Refund | [V] [SF] [R] [P] [NR] [N] [NS] [E] [A] | 0..1 | |
@AdditionalTicketInformation | Values are: ET = Electronic AV = Auto Void Indicator | [AV] [ET] | 0..1 | |
@ItineraryType | Values are: D = Domestic I = International | [I] [D] | 0..1 | |
@TicketStock | Values are: T = Agent Coupon A = Auditor's coupon B = Boarding pass (ARC Only) C = Charge form E = Exchange coupon for miscellaneous document F = flight Coupon S = Miscellaneous document tour order M = Paperless Service Fee P = passenger receipt V = Void a bad coupon in a batch while printing(for Abacus and Europe only) AT = Coupon Stock type is ATB2 DE = Coupon stock type is OPTAT AB = Coupon stock type is ATB or ATB1 | [AB] [DE] [AT] [V] [P] [M] [S] [F] [E] [C] [B] [A] [T] | 0..1 | |
@TicketPrinter | Used to return the address of the printer that prints the ticket | 0..1 | ||
@AgentSine | Agent sine responsible for ticket | 0..1 | ||
@StockItemCount | Returns the stock item count | 0..1 | ||
<RecordLocator/> | PNR record locator. | 0..1 | R1A3SK | |
<IssueTime/> | Local Time in pseudocity where agent issued ticket | 0..1 | ||
<DocumentType/> | Values are: T = TKT M = MCO | [M] [T] | 0..1 | |
<Payment> | 0..N | |||
@Form | Form of payment Values are: CA = Cash CH = Check CC = Credit Card MA = Miscellaneous Cash MR = Miscellaneous Credit MS = Miscellaneous EX = Exchange transaction IN = Invoice TP= TP Card NO= Non reference | [EX] [MR] [MA] [MS] [CC] [CH] [CA] [IN] [TP] [NO] | 0..1 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Amount/> | Amount. | 0..1 | 15000 | |
</Payment> | ||||
<Commission> | Commission percentage or amount. | 0..1 | 20.00 | |
@Type | Commission type. Values are: P = Percent, A = Amount | [A] [P] | 1 | A |
</Commission> | ||||
<PassengerName> | 0..1 | |||
<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 | 1 | ||
<Surname/> | Traveler family (last) name. | 0..1 | SMITH | |
</PassengerName> | ||||
<TicketingFees> | 0..1 | |||
<FeeInformation> | 0..1 | |||
@Amount | Amount. | 0..1 | 15000 | |
@GuaranteeType | Fee guarantee type | 0..1 | ||
</FeeInformation> | ||||
</TicketingFees> | ||||
<TicketingInfo> | 0..1 | |||
<Ticketing> | 0..N | |||
@TicketNumber | Ticket number (including the leading 3 digit airline code). | 0..1 | 2174851913640 | |
@UsedCount | 0..1 | |||
@CarrierType | Values are: ETR = Interactive carrier ETN = Non- Interactive carrier | [ETN] [ETR] | 0..1 | |
@StatusCode | Status code. | 0..1 | HK | |
@InvoiceNumber | Invoice number associated with the particular ticket. | 0..1 | 123456 | |
@ConjunctiveCount | Conjunctive ticket-related information | 0..1 | ||
</Ticketing> | ||||
</TicketingInfo> | ||||
<RefundInfo> | 0..1 | |||
<Refund> | 0..N | |||
@CancelledPseudoCityCode | Pseudo city code. | 0..1 | LM21 | |
@CancelledAgentSine | Agent Sine for Cancellation | 0..1 | ||
<IssueDate/> | Refund IssueDate Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<CancelledTime/> | local time Time in ISO 8601 format (hh:mm). | 0..1 | 14:00 | |
<RefundIndicator/> | Values are: ER = Electronic ticket | 0..1 | ||
</Refund> | ||||
</RefundInfo> | ||||
</Issuance> | ||||
</Report> | ||||
</SalesReportRS> |
| 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