XML Samples
Universal API Sessions
The following table contains sample requests and responses for various shared session processing.
The sample XML transactions provided in the Travelport Universal API help are provided for various functions. These sample transactions replace the samples previously included within individual topics. The samples do not include sample application code. However, a Universal API Sample Site, as well as a github repository and instructions for step-by-step tutorials, are available.
Please note Sample Providers and Sample Suppliers associated to a specific sample may be representative for that sample, but may not be the only providers and supplier for whom that sample is valid. If a sample does or does not apply to other providers, it is noted in the Comments column.
The following sample flows contain common transaction sequences for various providers and suppliers. Required and optional status for transaction may vary depending on the desired business process.
For more efficient maintenance, samples do not indicate the Universal API release or the schema version in the file name. Version control for samples uses:
- The schema versions are indicated in the namespace for each sample request and response. For example:
<air:AirPriceRsp xmlns:air="http://www.travelport.com/schema/air_v50_0" xmlns:common_v50_0="http://www.travelport.com/schema/common_v50_0"> - Comments at the top of each sample request indicate:
- The associated release.
- A brief description of the transaction.
- A date stamp for the date when the sample was generated. If a sample is modified in the same release, the date stamp can be used to confirm the exact date of creation for the sample. For example:
<!-- Release 6.0-->
<!-- Timestamp: 23 Nov 2013-->
<!-- Air Booking For Galileo(1G) with Connection Request-->
- Date stamps are also included:
- In eachdescription on the Sample topic page as Created or Updated. Any updates from the initially created sample are listed in a corresponding pop-up box.
- On the All Sample Files Zip file name to indicate the latest date that an update was made to a sample contained in the Zip.
For sample transaction requests, values for credentials, credit cards, and other sensitive data are replaced with generic equivalents. When testing with sample requests, please replace:
- OriginApplication="UAPI" with your assigned OriginApplication, if applicable. If you have not been assigned another OriginApplication value, retain the "UAPI" value.
- TargetBranch=“TRGT_BRCH” with your assigned Target Branch/Work Area Branch (WAB).
- PseudoCityCode=“PCC” with your assigned pseudo city code.
- CreditCard @Name @Number @CVV with your own test credit card data.
Other values that are not validated by Universal API, such as LoyaltyCard @CardNumber, may be kept or replaced with your own test data.
Samples List
The Air session samples presumes a sessionless shop and price requests have been performed.
Description |
Request |
Response |
---|---|---|
Air | ||
Start Session on Galileo (BookingStartReq) |
||
Add Traveler (BookingTravelerReq) |
2. Add traveler-Req | 2. Add traveler-Rsp |
Display current state of the transient UR (Galileo PNR) (BookingDisplayReq) NOTE: This is an optional step that can be performed at any time. |
||
Add a segment (BookingAirSegmentReq) | 6. Add Segment-Req | 6. Add Segment-Rsp |
Add a segment (BookingAirSegmentReq) - /AddAirSegment @NumberInParty allows booking of segments without adding traveler names first. | 6.1 Add Segment-NumPartyReq | 6.1 Add Segment-NumPartyRsp |
Add Fare Information (BookingPricingReq) | 7. Add Fare-Req | 7. Add Fare-Rsp |
Auto Pricing (BookingPricingReq) | 7.1. 1G Autoprice-Req | 7.1. 1G Autoprice-Rsp |
Auto Pricing with Branded Fares on 1P | 7.2._1P_Autoprice_Branded_Fare-Req | 7.2._1P_Autoprice_Branded_Fare-Rsp |
Add Action Status (BookingPnrElementReq) |
8. ADD_Action status-Req | 8. ADD_Action status-Rsps |
Add Form of Payment (FOP) (BookingPnrElementReq) |
||
Add Unassociated Remarks (BookingPnrElementReq) | 10. ADD_Unassociated_Remarks-Req | 10. ADD_Unassociated_Remarks-Rsp |
Add Associated Remark (BookingAirPnrElementReq) |
||
Update Unassociated Remarks (BookingPnrElementReq) |
||
Update FOP (BookingPnrElementReq) |
14. Update_FOP-Req | 14. Update_FOP-Rsp |
Update Associated Remark (BookingAirPnrElementReq) |
15. Update_Associated Remark-Req |
15. Update_Associated Remark-Rsp |
Delete Form of Payment (FOP) (BookingPnrElementReq) |
17. Delete_FOP-Req | 17. Delete_FOP-Rsp |
Delete Associated Remark (BookingAirPnrElementReq) |
||
Delete Unassociated Remark (BookingPnrElementReq) |
||
Delete Price (BookingPricingReq) |
||
Delete Segment (BookingAirSegmentReq) | 21. Segment_Delete-Req | 21. Segment_Delete-Rsp |
Booking Display | 22. BookingDisplay4-Req | 22. BookingDisplay4-Rsp |
Booking End (BookingEndReq) |
||
Universal Record Retrieve Note: This is a standard UR Retrieve |
||
Seat Assignment - Add Generic (BookingSeatAssignmentReq) | 26. Booking Seat Assignment-Add Generic Req | 26. Booking Seat Assignment-Add Generic Rsp |