Developer Docs
  • Our Products
    • Channel Manager
      • Integration and Onboarding Flow
      • RG Bridge - Supply (Push)
        • Integration Overview
          • Vision of Integration
            • Commercial value and business case
          • Information Data flow
            • One way integration
            • Two Way integration – ARI Broadcast and Reservation fetch
            • Information delivery mechanism
          • Technical feasibility of integration
            • Test property setup
            • Sample reservation data
          • RG Bridge Setup
          • Contract
          • Project Plan
          • Certification
          • Monitoring and after sales support
          • Integration checklist
        • Interface Specifications – Availability and Rates Notification Service
          • RG Bridge Integration Process
          • Intended Audience
          • Typographical Conventions
          • Technical Overview
          • Operations
            • Availability Notification
              • OTA_HotelAvailNotifRQ
                • Change in Inventory count
                • Change in availability status and Restrictions
              • OTA_HotelAvailNotifRS
              • XML Usage Specification
            • Rate Change Notification
              • OTA_HotelRateAmountNotifRQ
              • XML Usage Description
              • OTA_HotelRateAmountNotifRS
              • XML Usage Specification
            • Points to remember
        • Interface Specifications – Reservation Notification Service
          • RG Bridge integration process
          • Intended audience
          • Typographical conventions
          • Technical overview
          • Operations
            • Reservation Notification
              • OTA_HotelResNotifRQ
              • XML Usage specification
              • Sample Reservation Messages
              • OTA_HotelResNotifRS
              • XML Usage specification
          • Points to remember
          • Code Lists
      • RG Bridge - Reservation Retrieval (Pull)
        • Technical overview
        • Operations
          • Reservation Retrieval
            • OTA_ReadRQ
            • XML Usage specification
            • OTA_ResRetrieveRS
            • XML Usage specification
          • Reservation Confirmation
            • OTA_NotifReportRQ
            • XML Usage specification
            • OTA_NotifReportRS
            • XML Usage specification
        • Code Lists
      • Direct Connect - Demand (Push)
        • Introduction
        • Interface Specifications – ARI Service
          • Technical Overview
          • Operation: Property List
            • HotelPropertyListGetRQ
            • HotelPropertyListGetRS
            • Test Use Cases
            • FAQ
          • Operation: Product List
            • HotelProductListGetRQ
            • HotelProductListGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Get
            • HotelARIGetRQ
            • HotelARIGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Update
            • HotelARIUpdateRQ
            • HotelARIUpdateRS
            • Test Use Cases
            • FAQ
          • Points to remember
          • Code Lists
        • Interface Specifications – Reservation Notification Service
          • Technical overview
            • Communication protocols
            • General design
            • Authentication
          • Operation: Reservation
            • OTA_HotelResNotifRQ
            • OTA_HotelResNotifRS
            • Test use cases
            • FAQ
    • Smart Distribution
      • Onboarding process
      • Certification - Demand
      • Authentication Method
      • Book and Cancel Reservation
        • Transaction Header Formats
        • Book API
          • Book Reservation
          • Cancel Reservation
          • Booking Reservation Request Message Format
          • Booking Reservation Response Message Format
          • Cancel Reservation Request Message Format
      • Multiavailability (Enhanced Shopping Transaction)
        • Transaction Header Formats
        • Enhanced Shopping (EST) – Detailed Rate Information
          • Requesting Specific Rates
          • UltraDirect Account Author Negotiated Rate Processing
          • Unavailable Properties
          • UltraDirect Cache Processing
          • Enhanced Shopping Transaction Request Header Format
          • Enhanced Shopping Transaction Response Message Format
      • Pre-Book
        • Transaction Header Formats
        • Pre Book API
          • Pre-Book Request message format
          • Pre-Book Response message format
      • Property list and Booking Summary
        • PropertyList API
        • Booking Summary API
  • Content
    • Integration Process
    • Certification - Demand
    • Content Retrieve
      • SOAP/HTTP
        • SOAP Envelop
        • SOAP Body
        • Date and Time
        • Specifications for Currency Amounts
      • Transaction Specifications
      • Content Retrieval Request
      • Content Retrieval Response
    • Content Update
      • Overview
      • Transaction List
      • Transaction Flow
      • Batch processing
        • File naming convention
      • Multi-lingual capabilities
      • Associating media to textual content
      • Managing images
      • GDS content updates
      • Office of Foreign Assets Control (OFAC)
      • Interface requirements
        • SOAP envelope
        • Standard element formats
      • Transaction specifications
        • Data mapping of elements
        • Area Information
        • Affiliation information
        • Media information
        • Contact information
        • TPA extensions
        • GDS information
        • Response message
      • Codes lists
        • Credit Card
        • Error and Warning codes
        • Spoken Language
        • State and Country
      • Supported language codes
      • Client application generation using WSDL tool
  • UltraDirect
    • Integration Process
    • Certification
    • Ultradirect transaction sets - XML
      • Transaction header formats
      • Booking transactions
        • Booking request message format..
        • Request message format - Cancel
        • Request message format - Commit/Rollback
        • Request message format - Modify
        • Response message format - Booking
      • Enhanced shopping (EST)
        • Requesting Specific Rates
        • Request message format
        • Response message format.
      • Rate and availability transactions
        • Standard multi-availability
          • Request & Response message format
      • Rate Rules
        • Request message format
        • Response message format
      • Reference data transactions
        • Request message format..
        • Response message format..
      • Single property availability
        • Request message format
        • Response message format
    • XML ultradirect specifications
      • Overview
        • Transaction list
      • Interface requirements
      • Transaction meta data
    • Error Codes..
    • UltraDirect Transaction Samples and Usage
      • Using UltraDirect (Seamless, a real-time transaction)
      • EST (Enhanced Shopping Transaction)
      • Rate Rules
      • Book Reservation
      • Cancellation
      • Book Reservation with session control
      • Modification
      • Booking Storage and Retrieval
      • List of Test Credit Cards
      • Test properties in UAT
      • Guarantee Type and Method Combinations
    • xml ultradirect codes
  • Get in Touch
    • Questions?
Powered by GitBook
On this page
  1. UltraDirect
  2. UltraDirect Transaction Samples and Usage

Book Reservation

This request is used to request that a definitive booking be made for one particular rate and room combination.

Example Booking request:

<HotelML xmlns="
http://www.xpegs.com/v2001Q3/HotelML
">
<Head>
<Process DataPath="/HotelML/Form/BookReservation" Function="TI_BookReservationV1_1" Token="1259151426733"/>
<Route Destination="00" Source="XX"/>
</Head>
<Form>
<BookReservation CurrencyCode="EUR" GuaranteeMethod="CreditCard" GuaranteeType="Guarantee" InDate="2011-12-10" OutDate="2011-12-12" PropertyCode="XX;04988" RatePlanCode="LV7" RatePlanType="BusinessStandard" RoomRate="2950.00" RoomTypeCode="A03">
<AgentInfo Number="12345678" Type="TIDS"/>
<CreditCard ExpirationDate="2015-12" IssuedName="RateGain Test" Number="4321432143214327" TypeIdentifier="VI"/>
<Guest FirstName="RateGain" LastName="Test" NumberOfAdults="1" NumberOfRooms="1" Primary="true" Remarks="This is a test booking" ServiceRequest="This is a test booking">
<Email Address="
test@RateGain.com
"/>
<Phone Number="0203948890"/>
<PostalAddress City="London" CountryCode="GB" Line1="2 Kew Bridge Rd" PostalCode="TW8 0JF" StateCode="UZ"/>
</Guest>
</BookReservation>
</Form>
</HotelML>
  • This example uses GuaranteeType="Guarantee" and the GuaranteeMethod="CreditCard”.

  • GuaranteeType="Deposit" is used for deposit rates (i.e. when the Deposit indicator is returned in the EST response).

  • See appendix A for guarantee type and method combinations.

  • The Remarks and ServiceRequest attributes should contain the exact same information as some CRSs may only look at one of these RateGain will pass a maximum of 189 characters for these fields, however, the CRS may have a lower character limit.

  • RoomRate attribute is optional – IF included, the value must be the same as the BookableRate value from the EST response.

  • Additional character restrictions:

  • Phone field - up to 20 characters – no dashes, spaces or periods

  • First and Last name combined should not be more than 99 characters

  • Email address field - up to 315 characters

  • Postal Elements including address, city, state, country, postal code - up to 315 characters combined

  • Credit Card field - up to 21 characters - no dashes, spaces or periods

  • Credit Card Issued Name field - up to 99 characters

  • Agency ID field –8 characters - no dashes, spaces, or periods

Example Booking response:

HotelML xmlns="
http://www.xpegs.com/v2001Q3/HotelML
">
<Head>
<Route Destination="XX" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.2.8.1" DataPath="/HotelML" StartTime="2009- 11-25T12:17:06.741+00:00" Success="true" TotalProcessTime="1150"/>
</Route>
</Head>
<Reservation BookedRate="2950.00" ConfirmationNumber="3365389728" CurrencyCode="EUR" HotelComments="THANK YOU FOR CHOOSING XX." HotelRoomType="A03LV7" InDate="2011-12-10" NumberOfPersons="1" OutDate="2011-12-12" PropertyCode="XX;04988" RateGuaranteed="true" RatePlanCode="LV7" RoomTypeCode="A03" Token="1259151426733">
<CancelPolicy Description="4PM CXL ON ARR DATE"/>
<GuaranteePolicy Description="CREDIT CARD GUARANTEE"/>
<Guest FirstName="RateGain" LastName="Test" NumberOfAdults="1" NumberOfRooms="1" Primary="true" Remarks="This is a test booking" ServiceRequest="This is a test booking">
<Email Address="
test@RateGain.com
"/>
<Phone Number="0203948890"/>
<PostalAddress City="London" CountryCode="GB" Line1="2 Kew Bridge Rd" PostalCode="TW8 0JF" StateCode="-Select-"/>
</Guest>
</Reservation>
</HotelML>
PreviousRate RulesNextCancellation

Last updated 2 months ago