Retrieving a Universal Record with a Known Locator
If the Universal Record locator code is known, a Universal Record can be retrieved by using the Universal Record Retrieve request. Whenever possible, any PNR data stored in the Universal Record is validated against the PNR data in the provider's system.
Notes:
-
If the UR locator code is not known, see Searching for Universal Records.
-
You can retrieve bookings by other locators, such as the host locator. E.g.,
-
Copy
Retrieve Booking by Host Locator - 1G
<UniversalRecordRetrieveReq xmlns="http://www.travelport.com/schema/universal_v42_0" TraceId="" AuthorizedBy="Travelport" TargetBranch="P1234567">
<BillingPointOfSaleInfo xmlns="http://www.travelport.com/schema/common_v42_0" OriginApplication="uAPI" />
<ProviderReservationInfo xmlns="http://www.travelport.com/schema/universal_v42_0" ProviderCode="1G" ProviderLocatorCode="ABC123" />
</UniversalRecordRetrieveReq>
Schema
See the following transactions for Retrieving a Universal Record:
Request
Note: Universal API supports retrieval of group bookings. This is limited functionality. This functionality is controlled by a PCC switch. Please contact your Travelport representative or open an Incident Report to activate this enhancement.
- Send UniversalRecordRetrieveReq with the following minimum information:.
Credentials required for access. 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.
-
Enter @TravelerLastName and ProviderReservation @ProviderCode and @ProviderLocatorCode to retrieve a PNR and use the traveler last name for validation.
-
With the release of Universal API 20.4.2, Import Booking and Booking Retrieve support requests when the booking is a group (e.g., 10 passengers or more). The universal record locator and basic 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 error message displays: "Retrieve Group Booking already in progress. Please try again later."
-
When the UR Import is successful, the associated cache, and expiration timeframe, is cleared.
-
-
Enter @ViewOnlyInd to view a PNR in Universal Record format without saving it as a Universal Record.
-
Enter @RetrieveProviderReservationDetails to display provider details.
- Optionally, set @ReturnUnmaskedData="true" Release 20.3
- Optionally, set @ReturnAmenities="true" to return Routehappy content. Release 24.3
Notes: @TravelerLastName is an attribute of UniversalRecordRetrieveReq.
Response
During the retrieval process, Universal API synchronizes any PNR data in the Universal Record with the available data from the respective providers' latest versions of the PNR. However, Universal API's ability 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 Cost Carriers in ACH and rail providers in RCS do not typically support strong modify functionality, and may synchronize only a limited amount of the PNR data.
UniversalRecordRetrieveRsp returns the requested Universal Record (UR) and synchronizes data in the UR with the provider PNR.
-
As of Universal v48.0, the @Number, @TicketIssueDate, @TicketingAgentSignOn, and @IATANumber return in a single response as part of /TicketInfo and /ConjunctedTicketInfo in UniversalRecordRetrieveRsp/UniversalRecord/AirReservation/DocumentInfo/. Release 19.1
-
Schedule changes can be accepted for one or more air segments in the Universal Record. Ticket information 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 not 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 match the updated Payment data in the carrier’s system.
-
The applied residency type returns in booking and ticketing retrieve responses, so that the nationality from the applied residency type by passenger line or data can be applied in a future exchange. This is useful because of taxes based on nationality. For example, Mexico has a tax for foreigners and Argentina has two taxes for residents. Release 23.1AirSolutionsChangedInfo/AirPricingSolution/AirPricingInfo/PassengerType @ResidencyType
-
Fare Guarantee information to help identify the source of the quoted fare may be returned. See Fare Guarantees for details.
-
When any 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 name, Universal API adds these details to the hotel reservation based on the hotel property number in the Universal Record. This information 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 about how the dynamic target branch is created, see Importing PNRs.
-
The country code of the active PCC is returned as 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 US 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 element.
-
For Galileo or Worldspan, if the PNR has associated Miscellaneous Change Orders (MCOs), basic MCO information is imported. See Miscellaneous Change Orders for details.
- The @NameNumber attribute ensures the Universal Record Retrieve and Booking Retrieve (ETR) transactions add the ability to display Passenger name number for each passenger (Booking Traveler), which enables the ability to work with the booking in other channels. Release 18.3
This information returns in all responses where Booking Traveler information is returned.
This feature allows customers to identify the specific passenger location in a booking to be used when cryptic entries must be used in back-end processing.
When a PNR is split, the Booking Traveler element still stays in the UR. The name number is updated to reflect the GDS values and the name number of the passenger, who are removed from the PNR, and is removed from the I Booking Traveler.
Example:
<com:BookingTraveler Key="Qm9va2luZ1RyYXZlbGVyMQ==" TravelerType="CNN" NameNumber=”1.1”>
Troubleshooting
If you receive the error No provider reservation to import when trying to retrieve or import a PNR that does have a segment, it means that the segment is in a non-standard format that Universal API does not recognize. You can force the import/retrieve of the PNR by adding a retention segment in a format that Universal API recognizes (such as a TVL segment).
Exceptions