Developer Docs
  • Our Products
    • 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
      • 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
    • 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
  • Get in Touch
    • Questions?
Powered by GitBook
On this page
  1. Our Products
  2. Smart Distribution
  3. Pre-Book
  4. Pre Book API

Pre-Book Request message format

Element Path

Attribute

Occ

Type

Notes

HotelML/Head/Process

1

DataPath

1

Char

Set to "/HotelML/Form/PreBook”

Function

1

Char

Set to “TI_PreBookV1_1”

Token

1

Char

Unique ID for the transaction generated by the system sending the transaction.

HotelML/Head/Route

1

Source

1

Char 2-3

Identifies the organization sending the transaction. The value to use will be provided during the implementation project.

Destination

1

Char 2

Always set to “00” (i.e. zero zero).

HotelML/Form/PreBook/Property

1

PropertyCode

1

Char

Chain and property code, separated by a semi-colon – e.g. “UI;AB1234”

Context

0..1

Char

HotelML/Form/PreBook/ Property/Locale

0..1

This is used to request the response in a specific language.

Language

1

Char 2

Language code – e.g. “FR”

Country

0..1

Char

Optional country name – e.g. “France”.

HotelML/Form/PreBook/ RateCriteria

1

Specify rate selection criteria.

VersionCompliance

0..1

Enum

Must be “PreBook_V1”

NumberOfRooms

1

Integer

Total number of rooms required, which is used when checking availability. The prices in the response will be per room.

NumberOfBeds

0..1

Integer

Preferred number of beds per room

TotalRate

0..1

Decimal

Expected total rate excluding taxes and fees

TotalRateInclusive

0..1

Decimal

Expected total rate including taxes and fees

RatePlanCode

0..1

Char

Rate plan for the rate being checked. Will be the same as the rate plan code returned in the availability response

RateCodeContext

0..1

Char

RoomCode

0..1

Char

Rate plan for the rate being checked. Will be the same as the rate plan code returned in the availability response

RoomCodeContext

0..1

Char

HotelML/Form/PreBook/

RateCriteria/GuestCount

0..M

This element specifies the number of adults and children (optionally including child counts by age).

GuestCount must occur once (and only once) with Type=”Adult”.

It can also occur once with Type=”Child” if no Age attribute is supplied. Alternatively, it can multiple times for Type=”Child” when an Age attribute is specified.

Type

1

Enum

Values “Adult” or “Child”

Count

1

Integer

Number of guests of this type

Age

0..1

Integer

The optional age of the guest. Only applicable when Type=”Child”.

HotelML/Form/PreBook/ RateCriteria/ExtraBed

0..2

Number

0..2

Integer

Number of extra beds

Type

0..2

Enum

Type of extra bed required. Valid values are:

AdultRollAway, ChildRollAway, Crib

HotelML/Form/PreBook/ RateCriteria/AgentInfo

0..1

Number

1

Char 8

Travel agent identifier – often the IATA number.

Type

1

Enum.

Identifies the type of travel agent identifier. Values are: “ARC” , “IATA”, “TIDS”, “CLIA”, “AAA”, “GDS”, “Other”.

City

0..1

Char 3

Originating Agent’s City. Not normally required.

Country

0..1

Char 2

Originating Agent’s Country Code (ISO Standard Codes). Not normally required.

HotelML/Form/PreBook/RateCriteria/ DateRange

1

InDate

1

Date

The arrival date in format “2011-12-24”

OutDate

1

Date

The departure date in format “2011-12-27”

HotelML/Form/PreBook/RateCrieria/RateSearch

1

RatePlanCode

1

Rate access code

RatePlanType

1

Date

“Negotiated”, “Corporate”, “Standard” etc.

HotelML/Form/PreBook/ RateCriteria/RateSearch/AutoInfo

Code

0..5

Char 25

Auto Frequent Traveler Number

HotelML/Form/PreBook/RateCriteria/ RateSearch/CorpInfo

Code

0..1

Char 25

Corporate Account Number.

HotelML/Form/ PreBook/RateCriteria/ RateSearch/FlyerInfo

Code

0..5

Char 25

Frequent Flyer Number

HotelML/Form/ PreBook/RateCriteria/ RateSearch/FreqGuest

Code

0..1

Char 25

Frequent Guest Number