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 |
|---|---|---|---|---|
<SeatMapRS> | Seat availability response 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> | ||||
<FlightData> | Flight Details | 0..N | ||
<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> | ||||
<FlightGroup> | Flight group | 1 | ||
<Carrier> | Carrier group | 0..1 | ||
<AirlineCode/> | Airline code. | 0..1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | Flight number - an integer value within the range of [0,9999]. | 0..1 | 1234 | |
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
<ClassOfService/> | Class of service. | 0..1 | B | |
</Carrier> | ||||
<Departure> | Departure group | 0..1 | ||
<CityCode/> | City code. | 0..1 | MIA | |
<CityName/> | City name. | 0..1 | Miami | |
<Date/> | Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2002-02-22 | |
</Departure> | ||||
<Arrival> | Arrival group | 0..1 | ||
<CityCode/> | City code. | 0..1 | MIA | |
<CityName/> | City name. | 0..1 | Miami | |
<Date/> | Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2002-02-22 | |
</Arrival> | ||||
<Equipment> | Equipment group | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Name/> | Equipment name. | 1 | Boeing 747 series | |
</Equipment> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</FlightGroup> | ||||
<SeatDisplay> | Each SeatDisplay element represents a separate section of the airplanes flight deck(s). Usually multiple SeatDisplay elements are only returned when different sections have different layouts of seat and aisle columns.However, some CRS may return separate seat map sections although the layout does not change (e.g. for parts of the flight deck which are separated by galleys/lavatories). | 0..N | ||
@CabinClass | Compartment within the aircraft. | 0..1 | Y | |
@Location | L = Lowerdeck. M = Maindeck. U = Upperdeck. | [L] [M] [U] | 0..1 | M |
<Columns> | Column code. Each Columns element represents a a column of seats. The actual aisles are not represented by Columns elements. | 1..N | B | |
@Position | Column position in the plane. Possible values are: W = next to window A = next to aisle C = center (in between two seats) WA = window on one side and aisle on the other side AW = aisle on one side and window on the other side | [W] [A] [C] [WA] [AW] | 1 | W |
</Columns> | ||||
<Rows> | Row information group. Shows the range of the rows in display. | 1 | ||
<First/> | First row number. | [1] to [99] | 1 | 8 |
<Last/> | Last row number. | [1] to [99] | 1 | 44 |
</Rows> | ||||
<OverwingRows> | If present shows the range ot the overwing rows (first/last). The values are within the row range as identified in the Rows element above. | 0..1 | ||
<First/> | First row number. | [1] to [99] | 1 | 20 |
<Last/> | Last row number. | [1] to [99] | 1 | 25 |
</OverwingRows> | ||||
</SeatDisplay> | ||||
<SeatDetails> | Seat details group | 0..1 | ||
@SeatCharacteristicType | If present, the SeatCharacteristicType specifies of which type the Seat/Characteristic values are. Values: PROVIDER : provider specific codes If attribute is not present, values returned are EDIFACT codes. | [PROVIDER] | 0..1 | PROVIDER |
<Row> | 1..N | |||
@Number | Row number. | 1 | 2 | |
<RowCharacteristic/> | Row Characteristic. EDIFACT standard. Possible values: 10 = Row designated for RBD A. 11 = Row designated for RBD B. 12 = Row designated for RBD C. 13 = Row designated for RBD D. 14 = Row designated for RBD F. 15 = Row designated for RBD H. 16 = Row designated for RBD J. 17 = Row designated for RBD K. 18 = Row designated for RBD L. 19 = Row designated for RBD M. 20 = Row designated for RBD P. 21 = Row designated for RBD Q. 23 = Row designated for RBD S. 24 = Row designated for RBD T. 25 = Row designated for RBD V. 26 = Row designated for RBD W. 27 = Row designated for RBD Y. B = Buffer row. C = Row with cabin facilities in a designated column. CC = Row with cabin facilities in an undesignated colum. CH = Chargeable Row E = Exit row. EC = Exit row with cabin facilities in a designated col. EL = Exit left. ER = Exit right. I = Indifferent row. K = Overwing row. L = Lowerdeck row. M = Maindeck row. MV = Row with movie screen. N = No-smoking row. S = Smoking row. U = Upperdeck row. X = Not overwing row. XC = Exit row with cabin facilities in an undesignated. Z = Row does not exist. | 0..N | ||
<Seat> | 0..N | |||
@Column | Seat column. | 1 | A | |
@Status | Seat status. Values are: A = Available T = Taken U = Unknown N = No seat at this place | [A] [T] [U] [N] | 1 | A |
@Amount | Seat Price. | 0..1 | 5 | |
<Characteristic/> | Seat Characteristic. Values are IATA PADIS 9825 standard codes unless specified otherwise by SeatDetails/@SeatCharacteristicType. Possible values for IATA PADIS 9825: 1 = Restricted Seat- General 2 = Leg rest available 3 = Individual video screen - Choice of movies 4 = Not a window seat 5 = Not an aisle seat 6 = Near galley seat 7 = Near toilet seat 8 = No seat at this location 9 = Center seat (not window, not aisle) 10 = Seat designated for RBD "A" 11 = Seat designated for RBD "B" 12 = Seat designated for RBD "C" 13 = Seat designated for RBD "D" 14 = Seat designated for RBD "F" 15 = Seat designated for RBD "H" 16 = Seat designated for RBD "J" 17 = Seat designated for RBD "K" 18 = Seat designated for RBD "L" 19 = Seat designated for RBD "M" 20 = Seat designated for RBD "P" 21 = Seat designated for RBD "Q" 22 = Seat designated for RBD "R" 23 = Seat designated for RBD "S" 24 = Seat designated for RBD "T" 25 = Seat designated for RBD "V" 26 = Seat designated for RBD "W" 27 = Seat designated for RBD "Y" 28 = Not fitted A = Aisle seat AA = All available aisle seats AB = Seat adjacent to bar AC = Seat adjacent to closet AG = Seat adjacent to galley AJ = Adjacent aisle seats AL = Seat adjacent to lavatory AM = Individual movie screen - No choice of movie selection AR = No seat - airphone AS = Individual airphone AT = Seat adjacent to table AU = Seat adjacent to stairs to upper deck AV = Only available seats AW = All available window seats B = Seat with bassinet facility BA = No seat - bar BK = Blocked Seat for preferred passenger in adjacent seat C = Crew seat CC = Center section seat(s) CH = Chargeable Seat CL = No seat - closet CS = Conditional seat - contact airline D = No seat - exit door DE = Deportee E = Exit row seat EA = S Not an exit seat EC = Electronic connection for lap top or FAX machine EK = Economy comfort seat EX = No seat - emergency Exit F = Added seat FC = Front of cabin class/compartment G = Seat at forward end of cabin GF = General facility GN = No seat - galley GR = Group seat - offered to travellers belonging to a group H = Seat with facilities for handicapped/incapacitated passenger I = Seat suitable for adult with an infant IA = Inside aisle seats IE = Seat not suitable for child J = Rear facing seat K = Bulkhead seat KA = Bulkhead seat with movie screen KN = Bulkhead, no seat L = Leg space seat LA = No seat - lavatory LB = Rear facing lie flat seat LE = Left facing lie flat seat more left angle LF = Front facing lie flat seat LG = No seat - luggage storage LH = Restricted seat - offered on long-haul segments LL = Left facing lie flat seat LR = Right Facing lie flat seat LS = Left side of aircraft LT = Right facing lie flat seat more right angle M = Seat without a movie view MA = Medically OK to travel MS = Middle seat N = No smoking seat O = Preferential seat OW = Over wing seat(s) P = Extra seat for comfort - arm rest can be raised PC = Pet cabin Q = Seat in a quiet zone RS = Right side of aircraft S = Smoking seat SC = Skycouch SO = No seat - storage space ST = No seat - stairs to upper deck T = Rear/Tail section of aircraft TA = No seat - table U = Seat suitable for unaccompanied minors UP = Upper deck V = Seat to be left vacant or offered last : W = Window seat WA = Window and aisle together X = No facility seat (indifferent seat) Z = Buffer zone seat 1A = Seat not allowed for infant 1B = Seat not allowed for medical 1C = Seat not allowed for unaccompanied minor 1D = Restricted recline seat 1M = Seat with movie view 1W = Window seat without window 3A = Individual video screen - No choice of movie 3B = Individual video screen - Choice of movies, games, information, etc. 6A = In front of galley seat 6B = Behind galley seat 7A = In front of toilet seat 7B = Behind toilet seat 700 = Individual video screen - services unspecified 701 = No seat - access to handicapped lavatory 702 = Undesirable seat | 0..N | 1W | |
<ServiceElementNumber> | Element number of service element corresponding to this seat option. | 0..1 | 1 | |
</ServiceElementNumber> | ||||
</Seat> | ||||
</Row> | ||||
</SeatDetails> | ||||
<Screen/> | For the airlines that are not supported through Sabre formatted interface, the response screens will be displayed here. | 0..1 | Any Seat Map post response screen | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<OptionalServices> | This node is returned when merchandizing options are available for any of the selected flights. Only returned if FlightPriceRQ/PricingInfo/@RequestOptions=Y. | 0..N | ||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Images> | contains any images used for the services offered | 0..1 | ||
<Image> | Image in base64 code | 1..N | ||
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
@Caption | The caption used for this image | 0..1 | ||
</Image> | ||||
<Media> | Image or media available at an URL | 1..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
<Preview> | Preview of the referenced media content (e.g. thumbnail of the picture). | 0..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
</Preview> | ||||
<Description> | Media content description (e.g. exterior view). | 0..1 | ||
@Type | OTA code type. PIC .. Content Code | [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 3 | |
@Description | OTA code name. | 0..1 | Pool view | |
</Description> | ||||
<Caption/> | Title for the media. | 0..1 | Exterior | |
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
</Media> | ||||
</Images> | ||||
<Service> | Service Details | 1..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. | |
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 1 | |
@Airline | This is the airline code of the Marketing carrier, the carrier actually offering the service. | 1 | ||
@TypeValue | EMD Type Value as defined by ATPCO 1 = Standalone 2 = Associated to a flight 3 = Standalone associated to a ticket (but not flight) 4 = no EMD, carrier directed type 5 = E-Ticket | 0..1 | ||
@SaleStatus | Allowed Values: "Offered" "Pending" "Booked" "Issued" "Canceled" "Issued" represents those services which have been issued and have a valid EMDInfo node "Booked" represent items sold/booked but not yet issued Values are returned in the response | [Offered] [Booked] [Issued] [Pending] [Canceled] | 0..1 | |
@ServiceType | The ATPCO defined code for the type of service (also referred to as 'Flight/Ticket/Merchandise Byte 21)': F = Flight (TypeValue=2) R = Rule Buster (Type Value = 5) T = Ticket (TypeValue=3 if EMD-S is issued, 4 if other) M = Merchandise (TypeValue=1 if EMD-S is issued, 4 if other) | 0..1 | ||
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. A = Air Transportation B = Surface Transportation/Non Air services C = Baggage D = Financial Impact E = Airport Services F = Merchandise G = in-flight Services I = Individual Airline Use | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
@ServiceCode | Additional unique ATPCO code. | 0..1 | OC | |
@FareBrand | Service is part of a bundle associated to this fare brand | 0..1 | ||
@Status | Values are: NN = "Requested" HK = "Confirmed" | [NN] [HK] | 0..1 | |
@DealID | This ID represents an airline promotion for a special target market and applies only for FQTV numbers identified for this promotion | 0..1 | ||
@Type | Indicator if this option is a discount or a surcharge; Values are: "Discount" 1) "Surcharge" "Included" 2) "Not applicable" 3) 1) only applicable when using methof F, applying option directly to a fare (not used in an EMD solution) 2) This item is free of charge due to FQTV status or chosen Price Class 3) This item is not available/applicable due to FQTV status or chosen Price Class. Sample: Earning extra miles may only be allowed for a Top tier FQTV status and is not applicable for any other traveler. | [Discount] [Surcharge] [Included] [Not applicable] | 1 | |
@FQTVAirline | The 2-character airline code of the Frequent Flyer membership | 0..1 | AA | |
@FQTVStatus | The status (tier level) of the traveler's FQTV account. This is available as a query results against the airline's FQTV database. Samples: AA(American AAdvantage): -- Gold -- Platinum -- Executive Platinum LH (Miles and More): -- Frequent Traveller -- Senator -- HON Circle EK (Emirates Skywards): -- Silver -- Gold | 0..1 | ||
@FQTVNumber | This is the actual FrequentFlyer number associated to the FQTVStatus. This will allow the POS GUI to associate the actual traveler with the respective option/price | 0..1 | ||
@NotValidBefore | Option is not available/usable until the date entered | 0..1 | ||
@NotValidAfter | Option is not available/usable after the date entered | 0..1 | ||
@Slice | In case of a "Change Of Gauge" flight, this determines to which slice of the flight the option belongs. Default = 0 (or absence) | 0..1 | YY 465 SFO FRA with change of gauge in ORD Slice 0 = SFO to ORD Slice 1 = ORD to FRA | |
@CanDeselect | Any service tagged with a "Y" setting here can be deselected. This attribute is set by the merchandizing engine for services which are typically included in a Price Class or CoS but may not be desired by the traveler, e.g. Premium Drinks on the flight. Allowed value: "Y" | [Y] | 0..1 | |
@MaxQuantity | Will determine what the maximum number can be for the Quantity. | 0..1 | 5 | |
@Quantity | This attribute provides how many service/items of the same type have been ordered, 1 being the default. | 0..1 | 3 | |
<ElementNumber> | Element number. | 0..1 | 1 | |
</ElementNumber> | ||||
<SegmentIDRef/> | ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. | 0..N | F1 | |
<TravelerIDRef/> | Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. | 0..1 | T1 | |
<ServiceLocation/> | Optionally used for non-flight related services, such as airline lounge pass, pre-paid booklets for drinks/meals or WiFi. This is the 3-letter IATA city- or airport code related to the service. For example, an airport lounge pass may only be valid for one location. | 0..1 | DFW | |
<ServiceDate/> | Service date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2010-12-25 | |
<Description/> | Title description (Commercial Name) of offered service. | 1 | "3rd Bag Fee" UI tip: You may build a one line description to display by stringing the following values together: "Description"+"ServiceLocation"+"ServiceDate"+"DescriptionVariable" which could be displayed as sampled here: 'Airline Lounge Pass DFW 10May' where 'Airline Lounge Pass' is the "Description", 'DFW' the "ServiceLocation" and '10May' the "ServiceDate" or Premium Seat 9D where 'Premium Seat' is the "Description" and '9D' the "DescriptionVariable" | |
<DescriptionVariable/> | This value is used to provide a variable value for an selected service. Sample: for a Premium Seat this will be a seat number; for a annual pass of onboard WiFi this will be the credentials, etc. Examples: "9D" "UID: GO8978 PW: 1234" | 0..1 | ||
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
<ServicePrice> | Price for this service; not to be used for 'included' options (no charge options) This node uses the Currency/Decimals of the FareGroup root level | 0..1 | ||
@Total | Total amount for the chosen quantity of this service. Total = base price + total amount of taxes. | 1 | 7500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | Base (net) price of Service | 1 | ||
@Amount | Net price of service | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<ItemPrice> | Recommended to provide at all times, however if quantity is greater than 1 ItemPrice is mandatory | 0..1 | ||
@Total | Total amount for this service based on FQTV status and chosen Price Class. Total = base price + total amount of taxes. | 1 | 7500 | |
<BasePrice> | Base (net) price of Option | 1 | ||
@Amount | Net price of option. | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
</ItemPrice> | ||||
</ServicePrice> | ||||
<TicketByDate/> | Ticket by date in ISO 8601 (yyyy-mm-dd) format. | 0..1 | 2001-12-25 | |
<Penalties> | Option Penalty group | 0..1 | ||
@Refundable | Indicates if option is refundable. Values are: Y = Option refundable N = Option not refundable | [Y] [N] | 0..1 | Y |
@Reusable | Indicates if option is reusable. Values are: Y = Funds are reusable N = Funds are not reusable (default) | [Y] [N] | 0..1 | Y |
<Change> | Change penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..2 | 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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..2 | 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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</Penalties> | ||||
<Commission> | Commission amount or percentage for this option | 0..1 | ||
@Type | Commission type. Values are: P = Percent, A = Amount | [P] [A] | 1 | A |
</Commission> | ||||
<Endorsement> | Endorsements for this service. | 0..N | NONREF | |
<Text/> | Endorsement text. | 1 | ||
</Endorsement> | ||||
<ValidatingCarrier/> | Validating carrier code. Standard IATA 2-letter alphanumeric code. Allows to override the Validating Carrier assigned to the entire FareGroup | 0..1 | AF | |
<ReferenceKey/> | Unique reference key. If present in pricing response messages, must be included. | 0..1 | ||
<Attributes> | ATPCO S5 record attributes | 0..1 | ||
<Group> | Sample codes: BG = Baggage FF = Frequent Flyer GT = Ground Transportation and Non Air Services IE = In-flight entertainment LG = Lounge MD = Medical ML = Meal/Beverage PT = Pets RO = Rule Override SA = Prereserved Seat Assignment SB = Standby ST = Store TS = Travel Services UN = Unaccompanied Travel (Escort) UP = Upgrades WF = WiFi | 1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Group> | ||||
<SubGroup> | Sample codes for group "BG": CT = Container PP = Pre-paid excess baggage Sample codes for group "GT": BU = Bus LI = Limo, etc Sample codes for group "IE": IT = Internet access TV = Television, etc | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</SubGroup> | ||||
<Desc1> | Description codes. Examples: 05 = up to 5 kg 1Y = One Year AI = Aisle B1 = First Bag etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc1> | ||||
<Desc2> | Description codes. Examples: HT = Hot KO = Kosher etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc2> | ||||
</Attributes> | ||||
<BookingInstructions> | Contains instructions how to book this service with respective source | 0..1 | ||
<SSRCode/> | Special service request code. IATA standard. | 0..N | VGML | |
<OSIText/> | 0..N | |||
<UpgradeMethod> | Allowed Values: A = AutoUpgrade S = SSR request | 0..1 | ||
@NewClass | Instructs which new class to book | 0..1 | ||
</UpgradeMethod> | ||||
<Text/> | Any freeflow to instruct DC | 0..N | ||
</BookingInstructions> | ||||
<InstantPurchase/> | Instant Purchase indicator. CC = Purchase is immediately charged to CC AP = Purchase is using AirPass credit(s) PP = Purchase is charged via PayPal N = Not an instant purchase TT = Purchase is immediate after Ticketing time AU = EMD will be automatically issued without sending EMDIssueRQ | [CC] [AP] [PP] [N] [TT] [AU] | 0..1 | TT |
</Service> | ||||
</OptionalServices> | ||||
</FlightData> | ||||
</SeatMapRS> |
| 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