XML Samples
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.
The naming convention for samples uses:
- A unique three-digit number to identify the associated sample workflow. This number is arbitrary and does not indicate any priority or chronological relationship between sample workflows.
- A two-digit number for a "step" or chronological placement of the sample within the transaction flow.
- The two-character code for the associated provider. If more than one provider is associated with the transaction flow the codes are hyphenated; for example: 1G-ACH.
- A brief description of the transaction.
- A transaction request (Rq) or response (Rs) indicator.
For example: 004-04_1P_AirTicket_Rq
- 004 indicates that the transaction is part of Workflow 004-1P_Air_MinimumData (Air Flow with Minimum Data for United Flights on Worldspan).
- 04 is the fourth step in the workflow as Air Ticketing must be preceded by Availability, Pricing, and Booking.
- 1P is the Worldspan provider code.
- AirTicket indicates an Air Ticketing transaction.
- Rq is a request transaction. 004-04_1P_AirTicket_Rs is the corresponding response to this request.
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_v25_0" xmlns:common_v25_0="http://www.travelport.com/schema/common_v25_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 each Workflow description on the Sample topic page as Created or Updated. Any updates from the initially created sample workflow 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.
Click a box to see samples for a workflow.
Sample Archive
For previous versions, see the XML Sample Archive.