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. Our Products
  2. Smart Distribution
  3. Multiavailability (Enhanced Shopping Transaction)
  4. Enhanced Shopping (EST) – Detailed Rate Information

UltraDirect Cache Processing

The UltraDirect Availability Cache functionality allows rate and availability information for properties to be retrieved in the EST response. Cached single-property availability responses can be utilized by UltraDirect to generate multi-property availability responses, and vice versa.

The RequestedAccuracy attribute within the Route element in the message header specifies whether the cache should be used. Affiliates can indicate their preference for responses to be sourced either from the cache or directly from the source (e.g., the hotel’s CRS).

In the example below, the affiliate specifies that responses can be retrieved from either the cache or the source:

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Head>
<Process DataPath="/HotelML/Form/MultiAvailability" Function="TI_MultiAvailabilityV1_1"
Token="1285940187599"/>
<Route Destination="00" Source="01" RequestedAccuracy="CacheOrSource"/>
</Head>
<Form>
<MultiAvailability>
<Property Code="UI;12345"/>
<Property Code="UI;54321"/>
<RateCriteria VersionCompliance="Enhanced_V1" MatchingQualifier="ExactAndPublic"
NumberOfBeds="2" BedType="Queen" NumberOfRooms="1" RoomCategory="Standard">
<GuestCount Type="Adult" Count="1"/>
<GuestCount Type="Child" Count="1" Age="14"/>
<GuestCount Type="Child" Count="1" Age="1"/>
<ExtraBed Type="Crib" Number="1"/>
<DateRange InDate="2010-07-01" OutDate="2010-07-05"/>
<RateSearch RatePlanCode="RAC" RatePlanType="Standard"/>
<RateSearch RatePlanCode="PRO" RatePlanType="Standard"/>
</RateCriteria>
</MultiAvailability>
</Form>
</HotelML>

The response message specifies, for each property, whether the information was retrieved from the cache or directly from the source. It also provides the "age" of the response by including a timestamp indicating when the response was created.

  • If the information was returned from the cache, the age corresponds to the timestamp of when the response was initially added to the cache.

  • If the information was sourced directly, the timestamp reflects when the response was generated in real-time.

Note:

As a general practice, for EST API transactions, “CacheOrSource” is used.

An example is shown below:

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Head>
<Route Destination="01" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.2.8.1" DataPath="/HotelML" StartTime="2010-06-07T08:13:36.688+00:00" Success="true" TotalProcessTime="228"/>
</Route>
</Head>
<Property xml:lang="en" Code="UI;12345" DataAge="2011-06-30-02T09:27:04.173-00:00" DataOrigin="Cache" AvailabilityStatus="Open">
... Room & Rate Details ....
</Property>
<Property xml:lang="en" Code="UI;54321" DataAge="2011-06-30-08T14:28:01.268-00:00" DataOrigin="Source" AvailabilityStatus="Open">
... Room & Rate Details ....
</Property>
</HotelML>

If the requested accuracy is not available for a requested property then the Property element is returned with AvailabilityStatus set to “Unknown”. For example, if the previous request message was changed so that RequestedAccuracy=”CacheOnly” and there is no matching transaction in the cache for property UI;54321 then the response would be as follows:

<HotelML xmlns="http://www.xpegs.com/v2001Q3/HotelML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Head>
<Route Destination="01" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.2.8.1" DataPath="/HotelML" StartTime="2010-06-
07T08:13:36.688+00:00" Success="true" TotalProcessTime="228"/>
</Route>
<Error Code="CHE06" Description="RequestedAccuracy.CacheOnly - No cached data matching the requested criteria for
property: UI;54321" ResponseDataPath="Hotel/Property@Code=' UI;54321'"Type="Process"/>
</Head>
<Property xml:lang="en" Code="UI;12345" Token="1275898416589" DataAge="2010-06-30-08T14:28:01.268-00:00"
DataOrigin="Cache" AvailabilityStatus="Open">
... Room & Rate Details ....
<Property xml:lang="en" Code="UI;54321"Token="1275898416589" AvailabilityStatus="Unknown" />
</HotelML>

Last updated 3 months ago