Retrieving a Universal Tape with a Known Locator

ClosedYou are here

UniversalRecord.xsd

Create Reservation > Universal Record Recollect OR
Universal Record Import > Universal Record Retrieve

If the Universal Record locator lawmaking is known, a Universal Record can exist retrieved by using the Universal Record Recall request. Whenever possible, any PNR data stored in the Universal Record is validated against the PNR data in the provider'due south system.

Notes: If the UR locator lawmaking is non known, meet Searching for Universal Records.

Schema

See the following transactions for Retrieving a Universal Record:

  • UniversalRecordRetrieveReq
  • UniversalRecordRetrieveRsp

Request

  1. Ship UniversalRecordRetrieveReq with the following minimum information:.

    • Credentials required for admission. To retrieve a Universal Record, the UserID in the Credentials must match the credentials used to create the Universal Record or be an ID that has branch access to the original ID.

    • A valid @UniversalRecordLocatorCode.

  2. Enter @TravelerLastName and ProviderReservation @ProviderCode and @ProviderLocatorCode to recollect a PNR and utilize the traveler last name for validation.

    3. Notes: @TravelerLastName is an attribute of UniversalRecordRetrieveReq.

    • With the release of Universal API 20.iv.2, Import Booking and Booking Call up support requests when the booking is a group (eastward.m., ten passengers or more). The universal tape locator and bones booking details are returned in the response.

      • Multiple retrieval of the PNRs is restricted due to the extended time it takes to retrieve group bookings, and an mistake message displays: "Retrieve Grouping Booking already in progress. Please try again later."

      • When the UR Import is successful, the associated cache, and expiration timeframe, is cleared.

    Closed ProviderReservationInfo

    To remember the PNR and validate with a final name, the following data is required:

    • @ProviderCode: Supported for 1G, 1V, 1P.
    • @ProviderLocatorCode: The provider's PNR record locator. See the additional information returned in the response section when the @ProviderLocatorCode is added in the request.

    If a lucifer is found to an existing PNR, Universal API returns the Universal Tape that corresponds to the PNR. If a match is not found, Universal API returns an error. If a record exists, merely a friction match is not plant, an error is returned: No matching traveler found.

    If the PNR is already associated to a Universal Record (UR), the UR is retrieved. If the PNR is not associated to an existing UR, and new UR is created.

    This functionality is not supported RCS. Nevertheless, if a Universal Record contains aggregated content from a GDS provider (1G, 1V, 1P) and non-GDS provider (RCS), the not-GDS data is synchronized with the provider.

    Notation: Prior to Universal v49.0 with Universal API release nineteen.2.ane, ACH was non supported: Release 19.ii

    • When creating a booking, sometimes the booking is created on the vendor organization, only external issues prevented a Universal Record to be created via Universal API.

    • Universal v49.0 provides the ability to call back a booking on a vendor arrangement in ACH and add together to a workflow.

    • This reduces the number of orphan bookings and also allows customers the ability to meliorate service their bookings, because they are now attainable through a Travelport product.

    This functionality is available on Universal Record Retrieve with Universal v49.0 and higher up. To retrieve the ACH PNR, the following attributes are required:

    • @TravelerLastName
    • ProviderReservation @ProviderCode and @ProviderLocatorCode

    The post-obit example shows URRetrieve request to call up ACH orphan PNR, with the required highlighted fields, along with ProviderCode and ProviderLocatorCode:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
                    <soapenv:Body>
                    <univ:UniversalRecordRetrieveReq TargetBranch="123"                TravelerFirstName="Juan" TravelerLastName="Exam"                xmlns:univ="http://www.travelport.com/schema/universal_v49_0" xmlns:com="http://www.travelport.com/schema/common_v49_0">
                    <com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
                    <univ:ProviderReservationInfo ProviderCode="ACH" ProviderLocatorCode="123ABC"                SupplierCode="XX"/>
                    </univ:UniversalRecordRetrieveReq>
                    </soapenv:Body>
    </soapenv:Envelope>

  3. Enter @ViewOnlyInd to view a PNR in Universal Record format without saving it as a Universal Tape.

    4. ClosedShow details

    A PNR can exist viewed in UR format without saving information technology as a Universal Tape. In the request:

    • Set @ViewOnlyInd to "true".
    • Include ProviderReservationInfo/@ProviderCode and @ProviderLocatorCode.

    If the PNR is not part of an existing UR, information technology is retrieved and returned in the response, just not saved in the Universal API database. If the PNR is part of an existing UR, ViewOnlyInd is ignored and the UR is retrieved and synchronized with the PNR.

    Each fourth dimension a request is sent to view a PNR, Universal API retrieves the latest details of the PNR from the provider and returns them in UR format in the response.

    If @ViewOnlyInd is not sent in the request, the aspect is considered "false" and Universal API retrieves the UR and synchronizes it with the PNR.

  4. Enter @RetrieveProviderReservationDetails to display provider details.

    5. ClosedTestify details

    RetrieveProviderReservationDetails is a Boolean attribute.

    • When set to false (default), the response displays provider details using UniversalRecord/ProviderReservationInfo/ProviderReservationDetails.
    • When set to true, ProviderReservationDisplayDetailsList displays in the response in UniversalRecord/ProviderReservationInfo. This chemical element displays some details of the PNR elements that are not otherwise returned in the Universal Record.

    Universal versions prior to v29.0 will not render the ProviderReservationDisplayDetailsList element.

  5. Optionally, set @ReturnUnmaskedData="true" Release twenty.3

Response

During the retrieval procedure, Universal API synchronizes any PNR information in the Universal Record with the bachelor data from the respective providers' latest versions of the PNR. Nevertheless, Universal API'southward power to update a given Universal Record and associated PNRs is dependent on the provider's or supplier's support of this functionality. Suppliers such as Low Price Carriers in ACH and rail providers in RCS exercise not typically back up stiff modify functionality, and may synchronize only a limited amount of the PNR data.

UniversalRecordRetrieveRsp returns the requested Universal Tape (UR) and synchronizes data in the UR with the provider PNR.

  • Every bit of Universal v48.0, the @Number, @TicketIssueDate, @TicketingAgentSignOn, and @IATANumber return in a single response every bit function of /TicketInfo and /ConjunctedTicketInfo in UniversalRecordRetrieveRsp/UniversalRecord/AirReservation/DocumentInfo/. Release 19.i

  • Schedule changes tin can be accepted for one or more air segments in the Universal Tape. Ticket data displays regardless of modifications to segments or the filed fare, cancellation of the filed fare, or cancellation of the Universal Record.

  • Synchronization of the Payment element in the UR Retrieve response is non supported. If a booking that incurred a charge is modified outside of Universal API, the original Payment data remains in Universal API, and may not lucifer the updated Payment data in the carrier's organization.

  • Fare Guarantee information to help identify the source of the quoted fare may be returned. See Fare Guarantees for details.

  • When whatever Universal request causes synchronization of Universal Record with host PNR, if the hotel segment in the Universal Record does not have property address, phone number, or property proper name, Universal API adds these details to the hotel reservation based on the hotel holding number in the Universal Record. This data is added in the UniversalRecord/HotelReservation/HotelProperty element.

  • If the Universal Record was imported and that PNR's owning PCC did not exist in Universal API, a dynamic target branch was automatically created for that PCC. The dynamic target branch information displays in UniversalRecord/AgencyInfo/AgentAction. For more information well-nigh how the dynamic target branch is created, see Importing PNRs.

  • The land code of the active PCC is returned every bit of Universal v48.0 to differentiate ARC (used for 1V reconciliation) PCCs from BSP (use for 1G reconciliation) PCCs, and from Worldspan (1P) PCCs. With this information, Travelport can enable the correct processing of reissues in Galileo, in United states PCCs, so that when repricing, results display in a netted (ARC) or non-netted (BSP) format. Release 19.1

  • For Galileo or Apollo, if invoice data is present, it is returned in the UniversalRecord/InvoiceData chemical element.

  • For Galileo or Worldspan, if the PNR has associated Miscellaneous Change Orders (MCOs), basic MCO information is imported. Meet Miscellaneous Change Orders for details.

  • The @NameNumber aspect ensures the Universal Tape Retrieve and Booking Think (ETR) transactions add the power to brandish Passenger proper name number for each passenger (Booking Traveler), which enables the ability to work with the booking in other channels. Release eighteen.3

    • This information returns in all responses where Booking Traveler information is returned.

    • This characteristic allows customers to identify the specific passenger location in a booking to exist used when cryptic entries must be used in back-end processing.

    • When a PNR is dissever, the Booking Traveler chemical element nonetheless stays in the UR. The name number is updated to reflect the GDS values and the proper noun number of the passenger, who are removed from the PNR, and is removed from the I Booking Traveler.

    • Example:<com:BookingTraveler Primal="Qm9va2luZ1RyYXZlbGVyMQ==" TravelerType="CNN" NameNumber="i.one">

ClosedTicketInfo

When the Universal Record is retrieved and synchronized with the PNR, the ticket number from the PNR is added to UniversalRecord/DocumentInfo/TicketInfo @Number and a reference to the associated pricing information (i.eastward., the Stored Fare) is added to UniversalRecord/DocumentInfo/TicketInfo @AirPricingInfoRef, if the pricing information has an associated ticket number. The clan of ticket number and pricing information ensures that any TargetBranch who can call back the UR tin meet the Ticket number, even if that TargetBranch cannot view ticket details and ETR retrieve fails. Boosted Net Ticket Details from the PNR are as well synchronized and displayed in the Universal Record in UniversalRecord/AirReservation/AirPricingInfo/FareInfo:

  • Tour Code

  • Car Code

  • Value Code (never populated)

  • Commission (optional). Only fare-level commissions are supported as ticketing modifiers, so @Level must be "Fare". @Blazon tin be either "Flat" or "PercentBase". If "Flat", @Amount must be present and CommPercentage="9999999". If "PercentBase", @Amount=0 and CommPercentage=one to 100.

Closed ProviderLocatorCode

When the ProviderLocatorCode is included in the request:

  • For new tickets, Universal API determines the ticket condition, and returns the status in the UniversalRecordRetrieveRsp/UniversalRecord/AirReservation/DocumentInfo/TicketInfo@Status. The ticket status for existing tickets, including coupon data, is also returned in TicketInfo@Status.

  • For Exchanged tickets, along with the status information update, UniversalRecordRetrieveRsp, UniversalRecordImportRsp, and AirRetrieveDocumentRsp retrieves the original ticket number in the path /UniversalRecord/AirReservation/DocumentInfo/TicketInfo/ExchangeTicket@Number.

    • The status of the new exchanged ticket is 'O' – Open for use. Only, the remember response also contains the original ticket number information.

    • The status of the original ticket number is 'E' – Exchanged.

Closed FormOfPayment

If the FOP found in the Universal Tape is non returned in the PNR, Universal API validates whether the FOP in the Air Reservation is referenced in EMDSummaryInfo Payment. If information technology is, Universal API removes PROVIDERRESERVATIONINFOID from the FOP and displays the FOP in the Air Reservation without ProviderReservationInfoRef. If the FOP in the Air Reservation is not referenced in EMDSummaryInfo Payment, the FOP is removed from the UR.

Notation: In Universal v32.0, when a Universal Record (UR) containing a Miscellaneous Grade of Payment was returned in the UniversalRecord element in any Universal API response, the MiscFormOfPayment@Text aspect was partially masked.

  • Although this the correct response when the MiscFormOfPayment@Category = 'FreeFormCreditCard' it hampered the user's power to obtain consummate information in other scenarios. For example:

    • When the Category was Exchange and Text contained the exchanged TicketNumber, the exchanged TicketNumber was masked.

    • When the Text aspect is masked only when in that location is any SSR present in the PNR. Fifty-fifty when MiscFormOfPayment@Category = 'FreeFormCreditCard' the Text attribute is unmasked if there is NO SSR present in the PNR.

  • With Universal v33.0, Universal API at present:

    • Partially masks MiscFormOfPayment@Text when MiscFormOfPayment@Category = 'FreeFormCreditCard' or 'CreditCard' regardless of whether there is an SSR present.

    • Unmask MiscFormOfPayment@Text when MiscFormOfPayment@Category Not = 'FreeFormCreditCard' or 'CreditCard' regardless of whether there is an SSR present.

ClosedOptional Services

Updated seat consignment values that have been synchronized with the carrier'due south arrangement are returned. If a seat assignment is added or modified exterior of Universal API, the synchronized response reflects the modification in Universal API when the UR is retrieved.

When a UR that contains an ATPCO-filed Optional Service is retrieved or synchronized, and the ASVC SSR Status has changed, @ServiceStatus is updated to lucifer the ASVC SSR.

When Optional Services are sold through Last Entry (native manner), Electronic Miscellaneous Documents (EMDs) issued for the Optional Services by the provider are synchronized with the Universal Record (UR) when the UR is retrieved or imported. The issuance number and coupon number from the provider EMD are stored in the UR in AirReservation/OptionalService/ServiceData in @EMDSummaryRef and @EMDCouponRef.

In OptionalServices/OptionalServicesTotal:

  • Universal API returns the total for the Optional Services, including taxes.
  • For ATPCO-filed Optional Services, the total of all Optional Services is added by Universal API and returned in OptionalServicesTotal.
  • When ACH LCC and API carrier Optional Services are returned from multiple carriers and the currency codes are the same, Universal API returns BasePrice, Taxes, Fees, and TotalPrice in OptionalServices/OptionalServicesTotal.
  • When ACH LCC and API carrier Optional Services are returned from multiple carriers and the currency codes are the different, Universal API does non return BasePrice, Taxes, or TotalPrice in OptionalServices/OptionalServicesTotal. Instead, the ApproximateTotalPrice and ApproximateBasePrice are returned in OptionalServicesTotal based on the default currency code of the TargetBranch (WAB).
  • If Optional Services are returned from multiple providers in the response, Universal API returns OptionalServices/OptionalServicesTotal with the combined toll.
  • If Optional Services are returned from multiple providers in the response and the currency codes are different, the ApproximateTotalPrice and ApproximateBasePrice are returned in OptionalServicesTotal based on the default currency code of the TargetBranch (WAB).

A cancelled OptionalService is deleted from the Universal Record when the Universal Record is synchronized, and is no longer returned in the Universal Record Retrieve response with @ServiceStatus="Canceled".

ClosedHow CurrencyType Affects Price

The CurrencyType in AirPricingModifiers is passed to the provider, which impacts the currency that is returned for Equivalent Base Toll, Base Price, Taxes, and Full Price. The CurrencyType modifier specifies the currency that is to be used for settlement. The provider may restrict which currencies are available based on a variety of factors including origin, destination, and agency location. The requested currency is reflected in the EquivalentBasePrice, BasePrice, Taxes, and TotalPrice, if it is available.

ClosedViewing a PNR without creating a UR

When @ViewOnlyInd="true" is sent in the request, the following elements or attributes of UniversalRecordRetreiveRsp/UniversalRecord contain the static value of "999999":

  • @LocatorCode
  • /AirReservation @LocatorCode
  • /HotelReservation @LocatorCode
  • /VehicleReservation @LocatorCode
  • /PassiveReservation @LocatorCode
  • /RailReservation @LocatorCode

If the PNR is part of an existing UR, ViewOnlyInd is ignored and a alert is returned: "'ViewOnly' retrieval of a PNR already existing in a UR is not possible. Sync is washed"

If ViewOnlyInd="true" and the UniversalRecordLocatorCode is provided, ViewOnlyInd is ignored and a alert is returned: "'ViewOnly' retrieval of an UR is non possible. Sync is done"

The AgencyInfo chemical element that contains AgentAction is non returned in the response.

If a Dynamic WAB is created equally part of a view-only retrieve request, it is non stored.

ClosedOB Fees

The OB fees for a Universal Record are returned after the Universal Record is ticketed with a credit card or debit card form of payment. Refer to OB Fees for more information about these fees and their subcodes.

Closed ACH Taxes and Fees Breakup

For ACH carriers that include the taxes and fees inside the base fare at the itinerary level, Universal API provides a breakup of the taxes and fees included in the base of operations fare when this information is provided by the carrier. In AirCreateReservationRsp/UniversalRecord/AirReservation and /AirReservation/AirPricingInfo, each TaxInfo or FeeInfo element contains the attribute @Text, which returns whatsoever freeform text information provided past the supplier, and the element IncludedInBase, which provides the breakdown of the taxes and fees. IncludedInBase has the attribute @Corporeality, which shows the corporeality included in the base fare for the specific fee or tax. This information is provided by default anytime information technology is available from the ACH carrier.

Troubleshooting

If you lot receive the faultNo provider reservation to import when trying to call back or import a PNR that does have a segment, information technology means that the segment is in a not-standard format that Universal API does not recognize. You can force the import/retrieve of the PNR by adding a memory segment in a format that Universal API recognizes (such equally a TVL segment).

Exceptions

ClosedGalileo

The following data is not validated against the Galileo system when a UR is retrieved:

  • Phone numbers for non-primary booking travelers. Galileo associates phone numbers with a PNR, not with a specific traveler.

  • Electronic mail addresses for non-master booking travelers. Galileo associates email addresses with a PNR, not with a specific traveler.

  • Form of payment. In Galileo, the credit card course of payment is masked when a PNR is retrieved. Therefore, the last iv unmasked digits of the credit card are compared against the last 4 digits of the booking credit card.

ClosedWorldspan

  • Form of payment. In Worldspan, the credit carte du jour form of payment is masked when a PNR is retrieved. Therefore, the concluding 4 unmasked digits of the credit bill of fare are compared against the last four digits of the booking credit card. If they match, the booking credit carte du jour is used.
  • Universal API does not return the FareRuleKey in the Worldspan UniversalRecordRetrieveRsp.

ClosedACH

For a more than consummate listing of functionality available from diverse ACH carriers, run across ACH Carriers Functionality. Because functionality for carriers may exist subject to change, ever confirm functionality straight with the ACH carrier before implementation.

  • Grade of payment. For all ACH carriers, if the credit card returned in the recollect is different, a alert message is provided. However, the new card is not added because it is masked in the ACH Remember.

  • Jet2 (LS) has very express remember capability. Price, course of payment, and Booking Traveler address details are not returned.

  • easyJet (U2) does not:

    • Support Recall after cancel. An mistake is returned.

    • Render full details on Optional Services booked straight with the carrier.

  • ApproximateBasePrice and ApproximateTotalPrice are impacted by the CurrencyType.

  • If the sum of the passenger level fees is different than the itinerary level fees returned by ACH in Universal v.xxx.0 and greater, merely the fee blazon is the aforementioned, a alert is returned: Passenger type level fees are informational but, and may non match with those returned at the itinerary level.

  • Universal API xix.two.1 release provides the ability to retrieve a booking on a vendor system in ACH and add to a workflow. This reduces the number of orphan bookings and as well allows customers the ability to meliorate service their bookings, because they are at present accessible through a Travelport product. Release 19.2

ClosedRCS

  • For rails segments, the post-obit data is synced when the UR is retrieved:

  • Client Loyalty information. The customer loyalty information is also saved in the UR History.

  • For rail segments, the following data is not validated against the RCS system when a UR is retrieved:

    • Booking Traveler name.

    • Booking Traveler phone number.

    • Booking Traveler electronic mail accost.

    • Booking Traveler address.

    • Form of payment. A warning message is returned to the client if the form of payment in the Universal Record does not match the form of payment constitute in the rail benefactor'south booking.

    • Payment

  • "Businessi" is ignored and Beneif is returned in the CabinClass aspect of RailFare or RailAvailInfo, and besides render a warning in the response.

  • If RCS does not return FareClass in the response, CabinClass="Economy" volition be mapped. In older schemas, CabinClass= "Standard" is mapped.

  • With Rail v35.0 and Universal v35.0 and later, because the class code and cabin grade can differ for each train segment, the @ClassCode and @CabinClass are returned in the Track Create Reservation Response, Universal Tape Retrieve Response, and Runway Exchange Response (/UniversalRecord/RailReservation/RailJourney/RailSegment @ClassCode and @CabinClass).