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 with session control

This section introduces an optional element to the standard booking request, invoking a transaction “session”. This allows for a maximum of 15 minutes during which details of the reservation or associated travel plans can be confirmed before the transaction must be either committed or ignored. During this 15 minute period, rates and availability are frozen as quoted.

Not all CRSs support session control.

Example Session Booking request:

<HotelML xmlns="
http://www.xpegs.com/v2001Q3/HotelML
">
<Head>
<Process DataPath="/HotelML/Form/BookReservation" Function="TI_BookReservationV1_1" Token="1259152768726"/>
<Route Destination="00" Source="XX"/>
</Head>
<Form>
<BookReservation CurrencyCode="EUR" GuaranteeMethod="CreditCard" GuaranteeType="Guarantee" InDate="2013-12-10" OutDate="2013-12-12" PropertyCode="XM;0905" RatePlanCode="RAC" RoomRate="300.00" RoomTypeCode="B1D" Session="New">
<AgentInfo CountryCode="GB" Number="12345678" Type="IATA"/>
<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"/>
</Guest>
</BookReservation>
</Form>
</HotelML>

Session 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-25T14:17:29.455+00:00" Success="true" TotalProcessTime="798"/>
</Route>
</Head>
<Reservation BookedRate="300.00" CurrencyCode="EUR" HoldReservationTime="18:00" HotelRoomType="B1DRAC" InDate="2009-12-10" NumberOfPersons="1" OutDate="2009-12-12" PropertyCode="XM;0905" RateGuaranteed="true" RatePlanCode="RAC" RoomTypeCode="B1D" SessionID="UD74f42:12480994074:-7e10a6c" TaxInformation="NATIONAL TAXES ON ACCOMMODATION 2.00 EUR" Token="1259152768726">
<CancelPolicy Description="NO CANCELLATION CHARGE UNTIL DAY OF ARRIVAL, 18:00. THEREAFTER: HOTEL WILL CHARGE THE FIRST NIGHT."/>
<GuaranteePolicy Description="GUESTS ARRIVING AFTER 18:00 LOCAL TIME MUST PROVID E A 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"/>
</Guest>
</Reservation>
</HotelML>

The SessionID="UD74f42:12480994074:-7e10a6c" value is confirmation that the rate/room has been “placed in session”. This value must be echoed back as a part of the Ignore or Commit transaction, ending the session.

Example BookReservation Ignore Session request:

This transaction indicates the booking held in the session is to be ignored and returned to inventory.

<HotelML xmlns="
http://www.xpegs.com/v2001Q3/HotelML
">
<Head>
<Process DataPath="/HotelML/Form/BookReservation" Function="TI_BookReservationV1_1" Token="1080223867332"/>
<Route Destination="00" Source="XX"/>
</Head>
<Form>
<SessionControl Action="Ignore" SessionID="UD74f42:12480994074:-7e10a6c"/>
</Form>
</HotelML>
  • The Action="Ignore” will instruct the CRS to ignore the “booking request and return the rooms to common inventory.

  • Even though there is a built-in session timer of 15 minutes, the best practice is for the distributor to end the transaction by either sending a Commit request or an Ignore request.

Example BookReservation Ignore Session 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-25T14:22:06.842+00:00" Success="true" TotalProcessTime="671"/>
</Route>
</Head>
<Reservation BookedRate="300.00" CurrencyCode="EUR" HoldReservationTime="18:00" HotelRoomType="B1DRAC" InDate="2009-12-10" NumberOfPersons="1" OutDate="2009-12-12" PropertyCode="XM;0905" RateGuaranteed="true" RatePlanCode="RAC" RoomTypeCode="B1D" TaxInformation="NATIONAL TAXES ON ACCOMMODATION 2.00 EUR" Token="1259152768726">
<CancelPolicy Description="NO CANCELLATION CHARGE UNTIL DAY OF ARRIVAL, 18:00. THEREAFTER: HOTEL WILL CHARGE THE FIRST NIGHT."/>
<GuaranteePolicy Description="GUESTS ARRIVING AFTER 18:00 LOCAL TIME MUST PROVID E A 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"/>
</Guest>
</Reservation>
</HotelML>

The Hotel has not returned a confirmation number, therefore, there is no active booking.

Example BookReservation Confirm Session request:

<HotelML xmlns=”
http://www.xpegs.com/v2001Q3/HotelML
”>
<Head>
<Process DataPath=”/HotelML/Form/BookReservation” Function=”TI_BookReservationV1_1” Token=”1080224081875”/>
<Route Destination=”00” Source=”XX”/>
</Head>
<Form>
<SessionControl Action=”Commit” SessionID=”UD74f42:12480994074:-7e10a6c”/>
</Form>
</HotelML>

The Action =” Commit” will instruct the CRS to complete the booking process and return a confirmation number.

Confirm Session 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-25T14:24:56.631+00:00" Success="true" TotalProcessTime="611"/>
</Route>
</Head>
<Reservation BookedRate="300.00" ConfirmationNumber="0905JL9504" CurrencyCode="EUR" HoldReservationTime="18:00" HotelRoomType="B1DRAC" InDate="2009-12-10" NumberOfPersons="1" OutDate="2009-12-
12" PropertyCode="XM;0905" RateGuaranteed="true" RatePlanCode="RAC" RoomTypeCode="B1D" TaxInformation="NATIONAL TAXES ON ACCOMMODATION 2.00 EUR" Token="1259152768726">
<CancelPolicy Description="NO CANCELLATION CHARGE UNTIL DAY OF ARRIVAL, 18:00. THEREAFTER: HOTEL WILL CHARGE THE FIRST NIGHT."/>
<GuaranteePolicy Description="GUESTS ARRIVING AFTER 18:00 LOCAL TIME MUST PROVID E A 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"/>
</Guest>
</Reservation>
</HotelML>

The Hotel has returned a confirmation number of 0905JL9504" therefore there is now an active booking on the CRS.

PreviousCancellationNextModification

Last updated 2 months ago