Using Multiple Schema Versions
Travelport Universal API allows schema versions from multiple releases to be used when more than one product (for example, Air or Vehicle) is included in the request and the response creates a Universal Record. If only one product is included in a request, all schema versions must be from a single release.
Note: It is a best practice to use schema versions from a single release.
Universal API only accepts requests that use:
- Schema versions that are within three consecutive releases.
- Versions of the Common and Universal schema from the most recent release that is referenced by the other schema in the request.
How To
When sending a request that includes multiple schemas:
- Use the SupportedVersions element to reference other schema versions in the request. SupportedVersions is required if versions from multiple releases are desired in the request.
- The client can upgrade from Air v50.0 and Common v50.0 to the 21.1 release schema versions of Air v51.0 and Common v51.0.
- The client application has the option to upgrade the vehicle and/or hotel schema to version 51.0.
- However, the client application does not have to upgrade either the hotel or the vehicle schema, and can continue to use Hotel v50.0 and Vehicle v50.0 from the 20.2.2 release.
For example, a client application uses Release 20.2.2 schema for Air, Hotel, Vehicle, and Common (v50.0).
Important! Schemas do not need to be from the three most recent releases, just three consecutive releases.
The following example request shows the placement of the SupportedVersions element.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<univ:SupportedVersions airVersion="air_v51_0" hotelVersion="hotel_v50_0" xmlns:univ="http://www.travelport.com/schema/universal_v51_0"/>
</soap:Header>
<soap:Body>
<univ:UniversalRecordRetrieveReq TargetBranch="TRGT_BRCH" UniversalRecordLocatorCode="H9T41W" xmlns:univ="http://www.travelport.com/schema/universal_v51_0" xmlns:common="http://www.travelport.com/schema/common_v51_0">
<common:BillingPointOfSaleInfo OriginApplication="UAPI"/>
</univ:UniversalRecordRetrieveReq>
</soap:Body>
</soap:Envelope>
Errors and Warnings
If a request is sent with a range of schema versions that crosses more than three releases, a schema validation error is returned.
<faultstring>[Error] :3:362: cvc-complex-type.2.4.a: Invalid content was found starting with element 'hotel:HotelReservation'.
One of '{"http://www.travelport.com/schema/air_v51_0":AirReservation,
"http://www.travelport.com/schema/hotel_v59_0":HotelReservation,
"http://www.travelport.com/schema/hotel_v49_0":HotelReservation,
"http://www.travelport.com/schema/hotel_v48_0":HotelReservation,
"http://www.travelport.com/schema/hotel_v47_0":HotelReservation,
"http://www.travelport.com/schema/hotel_v46_0":HotelReservation,
"http://www.travelport.com/schema/vehicle_v41_0":VehicleReservation,
"http://www.travelport.com/schema/vehicle_v40_0":VehicleReservation,
"http://www.travelport.com/schema/vehicle_v39_0":VehicleReservation,
"http://www.travelport.com/schema/vehicle_v38_0":VehicleReservation,
"http://www.travelport.com/schema/vehicle_v37_0":VehicleReservation,
"http://www.travelport.com/schema/passive_v41_0":PassiveReservation,
"http://www.travelport.com/schema/passive_v40_0":PassiveReservation,
"http://www.travelport.com/schema/passive_v39_0":PassiveReservation,
"http://www.travelport.com/schema/passive_v38_0":PassiveReservation,
"http://www.travelport.com/schema/passive_v37_0":PassiveReservation,
"http://www.travelport.com/schema/rail_v41_0":RailReservation,
"http://www.travelport.com/schema/rail_v40_0":RailReservation,
"http://www.travelport.com/schema/rail_v39_0":RailReservation,
"http://www.travelport.com/schema/rail_v38_0":RailReservation,
"http://www.travelport.com/schema/rail_v37_0":RailReservation,
"http://www.travelport.com/schema/common_v41_0":ProviderARNKSegment,
"http://www.travelport.com/schema/universal_v41_0":SegmentContinuityInfo,
"http://www.travelport.com/schema/common_v40_0":XMLRemark,
"http://www.travelport.com/schema/common_v40_0":GeneralRemark,
"http://www.travelport.com/schema/common_v40_0":AccountingRemark,
"http://www.travelport.com/schema/common_v40_0":UnassociatedRemark,
"http://www.travelport.com/schema/common_v40_0":Postscript,
"http://www.travelport.com/schema/common_v40_0":AgencyInfo,
"http://www.travelport.com/schema/common_v40_0":AppliedProfile,
"http://www.travelport.com/schema/common_v40_0":AgencyContactInfo,
"http://www.travelport.com/schema/common_v40_0":CustomerID,
"http://www.travelport.com/schema/common_v40_0":CommissionRemark, "http://www.travelport.com/schema/common_v19_0":InvoiceRemark,
"http://www.travelport.com/schema/universal_v41_0":ChangedKeyStatus,
"http://www.travelport.com/schema/common_v40_0":ReviewBooking}' is expected.</faultstring>