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 |
---|---|---|---|---|
<EMDIssueRS> | EMD (Electronic Miscellaneous Document) Issue 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> | ||||
<EMDImage> | 0..N | |||
@MonetaryType | Characterizes this EMD as a DEBIT (charge to collect) or a CREDIT (i.e. credit for future air travel due to residual value of an unused ticket) transaction Note: Only an EMD-S may be of type=CREDIT; an EMD-A must always be of type=DEBIT Possible values: DEBIT CREDIT | 1 | ||
@ValidatingCarrier | The 2-character airline code of the carrier validating this Ticket/Document. | 0..1 | EK, AA | |
@DocumentNumber | The EMD DocumentNumber. If part of a conjunctive set this is the actual number within the set. | 1 | 0159622222201 | |
@DocType | This is the TRNC Code (Transaction Code) as per ARC/BSP. Possible values: CANN - Cancellation CANX - Cancellation EMDA - EMD-Associated EMDS - EMD-Standalone MD50 - Miscellaneous Document TASF - Travel Agent Service fee TKTT - Ticket | [CANN] [CANX] [EMDA] [EMDS] [MD50] [TASF] [TKTT] | 1 | TKTT |
@DocName | Document Name. Possible values: EDOC - External Document EMDA - EMD-Associated EMDS - EMD-Standalone MD50 - Miscellaneous Document TASF - Travel Agent Service fee TKTT - Ticket | [EDOC] [EMDA] [EMDS] [MD50] [TASF] [TKTT] | 1 | |
@Status | Possible values are: - ISSUED - VOIDED - EXCHANGED - REFUNDED | [ISSUED] [VOIDED] [EXCHANGED] [REFUNDED] | 1 | |
@Conjunctive | Possible values are: "Y" or "N" | [Y] [N] | 0..1 | |
@First | The 14-digit EMD DocumentNumber (13-digit plus check digit) of the very first ticket of the set. - only possible for EMD-A - | 0..1 | 00159622222201 | |
@Last | The 14-digit EMD DocumentNumber (13-digit plus check digit) of the very last ticket of the set. - only possible for EMD-A - | 0..1 | 00159622222234 | |
@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. | |
@EMDSource | ARC/BSP processing facility | 0..1 | ||
@CountryRef | Country reference. | 0..1 | 30-63908514-3 | |
@InternationalDomestic | Indicates if this EMD is an International or Domestic itinerary. Values "I" or "D". | [I] [D] | 0..1 | |
<EMDIdentification> | EMD information group | 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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<RecordLocator/> | PNR record locator from where this EMD is issued from. | 1 | ||
<CRSID/> | CRS identification. | 0..1 | 1G | |
<AgencyData> | This is the data of the PNR OWNING agency, e.g. the one who created the PNR or the one who owns that PNR after a full transfer of ownership | 0..1 | ||
<SignOn/> | Agent sign on. | 0..1 | ||
<DutyCode/> | Agent duty code | 0..1 | ||
<Agency/> | Agency that issued the EMD. | 0..1 | Corporate Corner | |
<IATA/> | Agency IATA number | 0..1 | ||
</AgencyData> | ||||
<IssuingPCC/> | Issuing Agency's PCC ID, | 0..1 | AAL1 | |
<IssuingIATA/> | Issuing Agency's IATA number | 0..1 | 12345678 | |
<IssuingAgent/> | Booking Agent Identification, Agent ID. | 0..1 | RI17 | |
<IssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<IssueTime/> | Time in ISO 8601 format (hh:mm:ss). | 0..1 | 14:00:32 | |
<IssuePlace/> | Identifies location where document was issued by its 3-letter airport/city code. | 0..1 | ||
<IssueCountry/> | Identifies country where document was issued by a two letter country code. | 0..1 | US | |
</EMDIdentification> | ||||
<SettlementAuthority> | Settlement Information | 0..1 | ||
<Entity/> | Settlement authority this EMD is to be reported to. Allowed values: ARC BSP DIR - requires Airline OTH - for unique other Note: Value 'OTH' may be used in non-BSP/non-ARC markets | 1 | ARC | |
<AirlineCode/> | The 2-character airline code of the carrier this EMD is directly settled with. This is NOT necessarily identical to the 'ValidatingCarrier'. This option is used when 'Entity' value = DIR. | 0..1 | AA | |
</SettlementAuthority> | ||||
<GroupName/> | Used instead of a TravelerName if e.g. issued for a 'Group' deposit payment. | 1 | CASTLE TOUR 23 Note: Choice only available for EMD-S, not allowed for EMD-A | |
<Traveler> | Traveler details group | 1 | ||
@Type | Passenger type. Values are: ADT = Adult, INS = Infant occupying seat, CHD = Child, YTH = Youth, MIL = Military, GOV = Government, SRC = Senior Citizen, STD = Student ( | 1 | ADT) | |
<ElementNumber> | 1 | |||
@TattooNumber | Tattoo number. | 0..1 | 2 | |
@TattooQualifier | Tattoo qualifier. | 0..1 | ST | |
</ElementNumber> | ||||
<TravelerName> | 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 | 1 | ||
<Initial/> | Traveler middle initial (only one letter). | 0..1 | G | |
<Title/> | Traveler title. | 0..1 | MISS, MRS, THEREVCON | |
<DateOfBirth/> | Traveler birth date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<Age/> | Traveler age. | 0..1 | 01 | |
<NameRemark/> | Free text name remark. | 0..1 | A123456 | |
</TravelerName> | ||||
<Infant> | 0..1 | |||
<ElementNumber> | 1 | |||
@TattooNumber | Tattoo number. | 0..1 | 2 | |
@TattooQualifier | Tattoo qualifier. | 0..1 | ST | |
</ElementNumber> | ||||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<AgeInMonths/> | 1 | |||
<DateOfBirth/> | Traveler birth date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
</Infant> | ||||
</Traveler> | ||||
<FrequentTravelerGroup> | One or more frequent traveler numbers. | 0..N | ||
<FFCompanyCode/> | IATA airline code of the frequent flyer program. | 1 | AA | |
<FFNumber/> | Frequent flyer ID. Alphanumeric. | 1 | ||
<FFFlyingCompany/> | 0..1 | |||
</FrequentTravelerGroup> | ||||
<ReasonCode/> | Each EMD shall be issued with a single Reason Code (RFIC) The IATA TktHandbook states that there can only by ONE Reason Code (RFIC) per EMD - see chapter 5. ATPCO uses this code RFIC plus a set of SubCodes describing the service/reason for issuance. Valid RFIC codes (ATPCO) are: A = Air Transportation (not applicable here as it can not be issued on an EMD) B = Surface Transportation/ Non-Air Services C = Baggage D = Financial Impact E = Airport Services F = Merchandise G = In-Flight Services I = Individual Airline Use X = automated service fee (TASF) Note: At timeof creation there were discrepancies between the RFIC codes published and used by ATPCO (downloaded from web) and the RFIC codes published by IATA in Ticketing Handbook 40th edition. Codes need to be validated once industry standard are finalized | 1 | ||
<FormOfPayment> | The form of payment used to settle the charges or refund the balances of this EMD. | 0..1 | ||
<CreditCard> | 0..N | |||
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual amount charged to credit card. | 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 | |
<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> | ||||
<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> | ||||
<CardholderFirstName/> | Credit card holder's first name. | 0..1 | JOHN | |
<CardholderLastName/> | Credit card holder's last name. This is only required for Sabre. | 0..1 | SMITH | |
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
</CreditCard> | ||||
<Other> | Other payment information. | 0..N | "CHECK", "CASH" | |
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual amount charged to credit card. | 0..1 | 200000 | |
</Other> | ||||
</FormOfPayment> | ||||
<ESAC/> | Electronic Settlement Authorization Code. When an agent voids an e-ticket through the GDS, the carrier's e-ticket database is updated with a status of void and an ESAC assigned by the carrier is automatically loaded into the IAR sales report with the void transaction. This void process keeps the Carrier's e-ticket database and IAR in sync. | 0..1 | ||
<Services> | Services purchased with this EMD If EMD-S only a single coupon is issued If EMD-A up to 4 coupons per EMD document can be issued. | 1 | ||
<EMDCoupon> | Break-down and description of each individual service/coupon | 1..4 | ||
@CouponNumber | EMD 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] | 1 | |
@NotValidBefore | If the fare does not permit travel to be commenced or completed before a certain date. | 0..1 | ||
@NotValidAfter | Date by which travel must be commenced/completed. | 0..1 | ||
@FCICode | 0: System auto priced 1: Agent priced | 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. | 1 | ||
@ServiceCode | Additional unique ATPCO code. | 0..1 | OC | |
@SubCode | Industry or RFIS (Reason For Issuance) Sub Codes for Optional Services are sourced by ATPCO. ATPCO also recommeds the RFIC (Reason for Issuance Code) association for each defined sub code. The following list is a sample of Sub Codes followed by recommended RFIC: 0AD/G = Pillow/Blanket 0AE/G = Headset 0AG/E = Executive Lounge 0AQ/G = Lunch 0AY/C = Small Pet in Hold 0A5/A = Pre-Reserved Aisle Seat 0A6/A = Pre-Reserved Window Seat 0BJ/A = Upgrade 0BD/F = Adult Polo Shirt-LG 0B4/G = Oxygen 0B5/A = Seat Assignment 0B6/A = Sleeper/Berth Note: There are discrepancies between the RFIC published and used by ATPCO (downloaded from web) and the RFIC codes published in IATA Ticketing Handbook 40th edition | 1 | ||
<ElementNumber> | The PNR element number of this service as used in the EMDIssueRQ and referencing to the service element at time of issuance only. PNR History, etc. Note: This value is only valid and allowed in the EMDIssueRS as an immediate result from the EMDIssueRQ. As the PNRElementNumbers of the driving PNR can be changed after issuance they cannot be treated as a reliable reference in the EMDImageRS (only valid in EMDIssueRS). | 1 | ||
@TattooNumber | Tattoo number. | 0..1 | 2 | |
@TattooQualifier | Tattoo qualifier. | 0..1 | ST | |
</ElementNumber> | ||||
<ServicePrice> | Break down of the individual charge for this service/coupon | 0..1 | ||
@Total | Total price for this charge. Total price = BaseValue amount + Taxes amount. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | 1 | |||
@Amount | Total BaseValue amount | 1 | 1750 | |
<FiledIn> | This group represents the price filed in a currency different from the currency of a point of sale. | 0..1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Amount> | Base Fare Amount as originally filed. | 1 | ||
</Amount> | ||||
</FiledIn> | ||||
</BasePrice> | ||||
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount (= sum of all tax elements) | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<Quantity/> | Quantity for this item. Recommended to be provided at all times, however mandatory only if quantity is greater than 1 | 0..1 | ||
<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 | |
@Unit | Values = P (Pieces) OR K (Kilos) OR L (Pounds ) | 0..1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<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> | ||||
<Commission> | The commission taken on this service. | 0..1 | 10 | |
@Type | Whether the commission is in percent or an amount. Possible values: P, A. | [A] [P] | 1 | A |
</Commission> | ||||
<ServiceLocation/> | Optionally used for non-flight related services, such as airline lounge pass, pre-paid booklets for drinks/meals or WiFi (typically for an EMD-S or MCO) 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 (typically for an EMD-S or MCO). | 0..1 | 2002-12-25 | |
<Description/> | Description of service Examples: (a) Hoover Dam Tour (b) Seat Assignment (c) Executive Lounge Access 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" | 0..1 | ||
<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> | ||||
<Association> | ticket number and flight coupon number to which this service is associated MANDATORY for EMD-A, mandatory or optional for EMD-S depending on the service | 0..1 | ||
@AssociationStatus | Indicates association status between EMD and a ticket. Values: A (Associated) or D (Disassociated) | 0..1 | ||
<TicketNumber/> | 13-digit ticket number. If part of a conjunctive set this is the actual number within the set. EMD-S: can be associated EMD-A: must be assocaited | 0..1 | ||
<CouponData> | 0..4 | |||
@CouponNumber | The single digit coupon number of the ticket image associated to this service. EMD-A: single coupon association mandatory, no multiple coupons can be associated to an EMD-A. Depending on the service, the EMD-S may not have any association to a coupon, may have a single association or may even have multiple coupon associations. | 0..1 | ||
@BoardingPoint | The (departure) airport code where passenger is boarding according to the associated E-Ticket coupon number. | 0..1 | JFK | |
@OFFPoint | The (destination) airport code where passenger is deplaning according to the associated E-Ticket coupon number. | 0..1 | FRA | |
<Flight> | Associate the flight(s) covered by the service of this coupon | 1..N | ||
<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> | ||||
<ClassOfService/> | Class of service. | 0..1 | B | |
</Flight> | ||||
</CouponData> | ||||
</Association> | ||||
<InReferenceTo> | references the exchanged document to support this item | 0..1 | ||
<DocNumber/> | The 13-digit document number (no check digit) of an 'accountable' document such as eCert, voucher, MCO, EMD, etc | 1 | 0061234567890 | |
<DocIssuePlace/> | Three letter IATA code of the town where the ticket originally has been issued. | 0..1 | MIA | |
<DocIssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
</InReferenceTo> | ||||
<Validity> | Validity dates for this service | 0..1 | ||
<NBDA/> | Specifies the "Not Valid Before Date" for this service in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2013-12-25 | |
<NADA/> | Specifies the "Not Valid After Date" for this service in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2013-12-25 | |
</Validity> | ||||
<Remarks/> | EMD-S use ONLY Remarks that are to be printed on the EMD-S receipt. | 0..1 | Check with tour guide upon arrival | |
<TourCode/> | EMD-S use ONLY Tour code as required | 0..1 | ||
<Operator/> | EMD-S use ONLY The name of the service operator providing the service charged. | 1 | CAHTYS CARAVANS | |
<CarrierCode/> | Carrier Code of airline providing the service | 1 | ||
<Penalties> | Option Penalty group | 0..1 | ||
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
@Reusable | Indicates if option is reusable. Values are: Y = Funds are reusable N = Funds are not reusable (default) | [Y] [N] | 0..1 | Y |
@ConsumedAtIssuance | Applicable to EMDS only. When set, coupon is considered used at issuance and cannot be refunded or exch | [Y] [N] | 0..1 | |
@NonEndorsable | Indicates if the EMD is endorsable or not. Values areL | 0..1 | N | |
@NonInterlinable | Indcates if the EMD is interlinable or not. | 0..1 | N | |
<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> | 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> | ||||
<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> | ||||
</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> | 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> | ||||
<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> | ||||
</Cancel> | ||||
</Penalties> | ||||
</EMDCoupon> | ||||
</Services> | ||||
<FCICode/> | 0: System auto priced Cash or check 1: Agent priced Cash or Check 2: System auto priced Credit card with manual approval code 3: Agent priced Credit card with manual approval code 4: No fare option Cash or check Same as agent priced 5: No fare option Credit card Same as agent priced 6: System auto priced Credit card with approval through the system (ECCP) 7: Agent priced Credit card with approval throughthe system (ECCP) 8: Agent priced Cash, check or credit card with manual approval 9: Auto Pricing | [0] [1] [2] [3] [4] [5] [6] [7] [8] [9] | 1 | |
<Endorsement> | Endorsements for this document (at document level). this node may contain aggregated service level endorsements as well | 0..1 | NONREF | |
<Text/> | Freeflow text. | 1..N | ||
</Endorsement> | ||||
<EMDTotal> | Sum of all individual charges (final amount to be charged or debited with this EMD) *** NOT COMPLETE *** Note: Current structure covers the need for regular EMD-A and EMD-S issued. It needs to be further build out to accommodate Penalties and Fees when EMD-S is used to refund RESIDUAL values of a ticket | 1 | ||
@Total | Total amount debited or credited with this EMD. This is the sum of all 'BaseValue' .../EMDTotal/TotalValue/@Amount plus the sum of all taxes .../EMDTotal/Taxes/@Amount | 0..1 | 10675 | |
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BaseTotal> | Consolidated amount of all base fee amounts charged with this EMD | 1 | ||
@Amount | Sum of all 'BaseValue' amounts | 1 | 9550 | |
<FiledIn> | This element represents the BasePrice filed in a currency different from the currency of a point of sale. | 0..1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Amount/> | Base Fare Amount as originally filed. | 1 | ||
</FiledIn> | ||||
</BaseTotal> | ||||
<TaxTotal> | Tax group consolidating all taxes collected with this EMD for all services | 0..1 | ||
@Amount | Sum of all taxes | 1 | 1125 | |
<Tax> | Tax break down of all collected taxes | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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 | |
@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. Value is "PD" | [PD] | 0..1 | |
<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> | ||||
</TaxTotal> | ||||
<Commission> | The TOTAL commission claimed for all services charged with this EMD. | 0..1 | 10 | |
@Type | Whether the commission is in percent or an amount. Possible values: P, A. | 1 | A | |
@NumberOfDecimals | If and only if the commission type is A, specify the number of decimals here. | 0..1 | 2 Note: Need and logic NEEDS to be verified. Is the decimal needed for type 'P' or 'A'? The node is copied over from TicketExchangeRQ | |
@Amount | Populated by the EMDServer with the actual calculated amount of the commission | 0..1 | ||
</Commission> | ||||
<FeeGroup> | Fees claimed for all services charged with this Ticket. | 0..1 | ||
@Amount | Total fee amount for the Fare | 1 | 200000 | |
<Fee> | 1..N | |||
@ServiceCode | Additional unique ATPCO code. Please refer to FLX Codeset document for acceptable values. | 0..1 | OC | |
@SubCode | ATPCO RFISC (ReasonForIssuance Subcode). Example of RFISC: 0CC | 0..1 | ||
@Refundable | Indicates if fee is refundable. Values are: Y = Fee refundable N = Fee not refundable. If attribute is not there then default is Y. | 0..1 | ||
<Amount/> | Fee amount. | 1 | 2000 | |
<Description/> | Title description (Commercial Name) of Fee. | 0..1 | "Credit Card Fee" | |
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
</Fee> | ||||
</FeeGroup> | ||||
<FeeCalculation/> | Fee Calculation line. Will be provided on an EMD for the entire EMD itinerary when there is no specific value assigned to each individual coupon. | 0..1 | LAX BB AKL BB CHC70.00 BB AKL BB LAX70.00USD140.00END | |
</EMDTotal> | ||||
<TicketReference/> | The ticket reference for this EMD. This is NOT the association mandatory for EMD-As which is to be mapped to the TicketNumber element at the ServiceElement level 13-digit ticket number. In case of conjunctive set this is the first (primary) ticket number of the set. | 0..1 | ||
<TravelStats> | Statistical data as needed for BSP and/or ARC reporting | 0..1 | ||
<PurposeCode/> | Purpose Code. Valid values: 1 = Business 2 = Pleasure 3 = Charter Canadian requirement | 0..1 | ||
<DestinationCode/> | 1 = Mexico, Costa Rica, Central America, Canal zone 2 = Islands and countries of the Caribbean, Bermuda, including PR, VI 3 = South America 4 = Europe incl Morocco, Tunisia, Algeria, Greenland 5 = Africa 6 = Middle East (western Asia) 7 = Asia including India 8 = Australia, New Zealand. Pacific islands incl Hawaii, excluding Guam 0 = United States (wholly within the USA) or trans- border Canada - USA (or vice-versa) Canadian requirement | 0..1 | ||
</TravelStats> | ||||
<Vouchers> | This node contains information about any voucher that might exist in the reservation | 0..1 | ||
<CouponReference> | 1..N | |||
@CouponNumber | Coupon number that voucher is associated to. | 1 | ||
<VoucherImage> | 1 | |||
<TravelerElementNumber/> | Element number of traveler associated to this item. | 1 | 1 | |
<SegmentElementNumber/> | Segment element number associated to this item. | 1 | 1 | |
<VoucherNumber/> | Voucher Number for this voucher | 1 | 1 | |
<Image> | Encoded PDF image for the voucher | 1 | ||
@Encoding | Encoding method used | 1 | base64 | |
@Symbology | Symbology applied | 0..1 | PDF417 | |
@Format | Image format used | 1 | jpeg | |
</Image> | ||||
<WebLinks> | Links to associated promotional material | 0..1 | ||
<WebLink> | 1..N | |||
@Type | Indicates what the content of the web link is; these are possible values: "I" Image "V" Video "C" HTML or other webpages "D" Deeplink URL "R" RouteHappy content "T" Template Location | [I] [V] [C] [D] [R] [T] | 0..1 | |
</WebLink> | ||||
</WebLinks> | ||||
</VoucherImage> | ||||
</CouponReference> | ||||
</Vouchers> | ||||
</EMDImage> | ||||
</EMDIssueRS> |
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