Displaying Ticket Information

Displaying ticket information is typically included as a follow-on to an Air Booking response. Electronic tickets can be displayed to obtain:

Several steps may be involved in displaying the electronic ticket. They include:

  1. Display the list of document numbers.
  2. Select a ticket from the list.
  3. Display the details for that specific Electronic Ticket Record (ETR).

Schema

Displaying Ticket Information transactions are located in AirReqRsp.xsd:

Request

The AirRetrieveDocumentReq transaction is used to:

The above tasks can be used in any combination to display more information, e.g., to display ticket information with canned remarks and agency information from the PNR.

There are two options in retrieving E-ticket information.

Option 1:

By including an AirReservationLocatorCode in the request:

XML Sample with minimum attributes.

<air:AirRetrieveDocumentReq xmlns:air="http://www.travelport.com/schema/air_v50_0" 
xmlns:com="http://www.travelport.com/schema/common_v50_0" ProviderCode="1G" 
ReturnPricing="true" TargetBranch="PXXXXXX" AuthorizedBy="TEST">
 <com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
 <air:AirReservationLocatorCode>13G0OA</air:AirReservationLocatorCode>
</air:AirRetrieveDocumentReq>

 

Note: The AirReservationLocatorCode element is used to retrieve all ETRs and TCRs information from a single booking file or Universal Record. AirReservationLocatorCode can be found in UniversalRecordRetrieveRsp. See example below:

 

Option 2:

By including one or more TicketNumber or TCRNumber element in the request.

Sample 1: One TicketNumber element request
<air:AirRetrieveDocumentReq xmlns:air="http://www.travelport.com/schema/air_v50_0" 
xmlns:com="http://www.travelport.com/schema/common_v50_0" ProviderCode="1G" 
ReturnRestrictions="true" ReturnPricing="true" TargetBranch="PXXXXXXX" AuthorizedBy="TEST">
 <com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
 <com:TicketNumber>7959904180751</com:TicketNumber>
</air:AirRetrieveDocumentReq>

 

Sample 2: Multiple TicketNumber element request
<air:AirRetrieveDocumentReq xmlns:air="http://www.travelport.com/schema/air_v50_0" 
xmlns:com="http://www.travelport.com/schema/common_v50_0" ProviderCode="1G" 
ReturnRestrictions="true" ReturnPricing="true" TargetBranch="PXXXXXXX" AuthorizedBy="TEST">
 <com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
 <com:TicketNumber>7959904180751</com:TicketNumber>
 <com:TicketNumber>7959904180752</com:TicketNumber>
 <com:TicketNumber>7959904180753</com:TicketNumber>
 <com:TicketNumber>0819904180733</com:TicketNumber>
</air:AirRetrieveDocumentReq>
 

Note: Ticket numbers must be from a single air reservation/PNR or Universal Record. Universal API does not allow a mix of ETR TicketNumbers and TCRNumber elements in the AirRetrieveDocumentReq.

To display Miscellaneous Change Order (MCO), RetrieveMCO="true" must be included in AirRetrieveDocumentReq.

<air:AirRetrieveDocumentReq xmlns:air="http://www.travelport.com/schema/air_v50_0" 
xmlns:com="http://www.travelport.com/schema/common_v50_0" RetrieveMCO="true" ProviderCode="1G" 
ReturnRestrictions="true" ReturnPricing="true" TargetBranch="PXXXXXXX" AuthorizedBy="TEST">
 <com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
 <com:TicketNumber>7959904180751</com:TicketNumber>
</air:AirRetrieveDocumentReq>

See Miscellaneous Change Orders for details.

.

Response

AirRetrieveDocumentRsp returns PNR information such as UniversalRecordLocator, ProviderCode. ProvideLocatorCode, AgencyInfo, BookingTravelerName, FormOfPayment type, SupplierLocator SupplierCode, PlatingCarrier, and the AirReservationLocatorCode.

Based on AirRetrieveDocumentReq option selected, it may include a complete list of all ETRs in PNR and other information in the PNR obtained during PNR import and synch.

Credit Card information is located in AirRetrieveDocumentRsp/ETR/FormOfPayment:

An enhancement in Universal API release 20.4 allows the ability to show credit/debit card information when retrieving e-ticket and EMD information through Universal API to reconcile data with BSP.

For example, in an AirDocumentRetrieve request, when credit/debit card information is present in the booking, Universal API returns the entire credit/debit card number in full.

This function will only be effective if the customer has opted in for the unmask functionality where the agency or the Sign-On level allows. Otherwise, credit/debit card information will remain masked.

For example: sample

Credit Card number is masked in AirRetrieveDocumentRsp without activation.

Credit Card number is unmasked in AirRetrieveDocumentRsp when unmask functionality is activated.

This functionality is applicable in Air Retrieve Document, Air Merchandising Fulfillment, and EMD Issuance / Retrieve. Release 20.4

It is highly recommended that the Universal Record (UR) is retrieved to get all ticketing data in parallel, and ticketing details synchronized:

The synchronization may involve "full" synchronization to initially populate the ETR data or "limited" synchronization to only refresh status. In addition to the ETR, other PNR fields must be synchronized to pick up the changes as a result of ticketing.

If a request to display ETRs using the TicketNumber is made and no associated air reservation is located, the ETR data is returned but no synchronization of the ticketing data occurs (informational retrieve only).

Note: If no air reservation exists, or PNR is purged, AirRetrieveDocumentRsp will display limited information

<air:AirRetrieveDocumentRsp TransactionId="C7DACFF50A0D6A7E5A240F747797DB18" ResponseTime="205" 
xmlns:air="http://www.travelport.com/schema/air_v50_0" 
xmlns:common_v50_0="http://www.travelport.com/schema/common_v50_0">
 <air:ETR TotalPrice="EUR783.25" BasePrice="EUR561.00" Taxes="EUR222.25" 
IssuedDate="2021-06-29T00:00:00.000+10:00" 
 ProviderCode="1G" IATANumber="02345243" PseudoCityCode="XB7" 
CountryCode="AU" PlatingCarrier="LH">
  <common_v50_0:BookingTraveler>
   <common_v50_0:BookingTravelerName First="PACOMR" Last="PAQUITO"/>
  </common_v50_0:BookingTraveler>
  <common_v50_0:FormOfPayment Key="LGWoGq+pWDKAMgFFvAAAAA==" Type="Cash" 
Reusable="false" ProfileKey="Z5KO4sdoT9q8Cl51b3R3aw=="/>
  <common_v50_0:Payment Key="LGWoGq+pWDKANgFFvAAAAA==" Type="Itinerary" 
Amount="EUR783.25" FormOfPaymentRef="LGWoGq+pWDKAMgFFvAAAAA=="/>
  <air:FareCalc>FRA LH MUC 277.00 LH FRA Q7.00 277.00 EUR561.00END XT 
30.66OY58.93RD90.00YQ19.00YR</air:FareCalc>
  <air:Ticket TicketNumber="2209904173595" TicketStatus="N">
   <air:Coupon CouponNumber="1" MarketingCarrier="LH" MarketingFlightNumber="114" 
Origin="FRA" Destination="MUC" DepartureTime="2021-06-29T17:15:00.000+02:00" 
StopoverCode="true" BookingClass="Y" FareBasis="YDELGTG0" Status="O"/>
   <air:Coupon CouponNumber="2" MarketingCarrier="LH" MarketingFlightNumber="95" 
Origin="MUC" Destination="FRA" DepartureTime="2021-07-12T08:00:00.000+02:00" 
StopoverCode="true" BookingClass="Y" FareBasis="YDELGTG0" Status="O"/>
  </air:Ticket>
  <air:AirPricingInfo Key="LGWoGq+pWDKAOgFFvAAAAA==" TotalPrice="EUR783.25" 
BasePrice="EUR561.00" Taxes="EUR222.25" PricingMethod="Auto" Ticketed="true">
   <air:FareInfo Key="LGWoGq+pWDKARgFFvAAAAA==" FareBasis="YDELGTG0" 
PassengerTypeCode="ADT" Origin="FRA" Destination="MUC" 
EffectiveDate="2021-06-29T00:00:00.000+10:00"/>
   <air:FareInfo Key="LGWoGq+pWDKASgFFvAAAAA==" FareBasis="YDELGTG0" 
PassengerTypeCode="ADT" Origin="MUC" Destination="FRA" 
EffectiveDate="2021-06-29T00:00:00.000+10:00"/>
   <air:TaxInfo Category="DE" Amount="EUR23.66" Key="LGWoGq+pWDKAPgFFvAAAAA=="/>
   <air:TaxInfo Category="XT" Amount="EUR198.59" Key="LGWoGq+pWDKAQgFFvAAAAA=="/>
   <air:FareCalc>FRA LH MUC 277.00 LH FRA Q7.00 277.00 EUR561.00END 
XT 30.66OY58.93RD90.00YQ19.00YR</air:FareCalc>
  </air:AirPricingInfo>
 </air:ETR>
</air:AirRetrieveDocumentRsp>

 

An ETR may contain:

Document numbers which were issued outside the Universal API are also synchronized; when the PNR is imported or synchronized, all document numbers are brought into the Universal Record (UR). When tickets are issued through the UR, those documents are noted and synchronized. When documents are issued outside the UR, they are synchronized into the UR. Only new tickets are synchronized.

 

Errors and Warnings

Common causes of errors are:

Additionally, if a ticket has been final or closed so long on the vendor side that it cannot be retrieved, a "Ticket Number Not Found" message is sent in the response to indicate a final status. If a subsequent retrieval is successful without error, Universal API restores the ticket coupon status as indicated by the Host.

Note: Overall ticket status is determined by the status of the associated coupons within the ETR. A ticket reaches final status when all coupons have reached final status.

E-Ticket Status:

Code="P" Description="Partially Refunded"

Code="A" Description="Airport Controlled"

Code="S" or "F" Description="Used"

Code="N" Description="Unused"

Code="U" Description="Unticketed"

Code="T" Description="Ticketed"

Code="V" Description="Voided"

Code="R" Description="Refunded"

Code="X" Description="eXchanged"

Code="Z" Description="Unknown/Archived/Carrier Modified"

Code="O" Description="Open"

E-Ticket Coupon Status:

Code="A" Status="Airport Controlled"

Code="C" Status="Checked In"

Code="F" Status="Flown/Used"

Code="L" Status="Boarded/Lifted"

Code="O" Status="Open"

Code="P" Status="Printed"

Code="R" Status="Refunded"

Code="E" Status="Exchanged"

Code="V" Status="Void"

Code="Z" Status="Archived/Carrier Modified"

Code="U" Status="Unavailable"

Code="S" Status="Suspended"

Code="I" Status="Irregular Ops"

Code="D" Status="Deleted/Removed"

Code="X" Status="Unknown"

Exceptions

The following items do not display as part of the AirRetrieveDocumentReq request:

Ticket Info Display does not support MCO data.

Apollo allows agents in the United States to issue paper tickets, so the TkType might be set as P, even though Universal API does not support issuing paper tickets.

  • Universal.xsd adds schema element (/TaxInfo) and three attributes (@BasePrice @TotalPrice @Taxes) to the ETR element to reflect the "Auditor" data, returning the Base Fare for Bulk Tickets.
  • AirRetrieveDocumentRsp/ETR/AuditData/TaxInfo and @BasePrice @TotalPrice @Taxes