Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

Provides the ability to request availability details for hotel properties by specific criteria that may include dates, date ranges, rates, rooms and products.

Request

Element / @Attribute

Quantity

Type

Description

OTA_HotelAvailGetRQ

1

Root Element

HotelAvailRequests

1

A collection of HotelAvailRequests

HotelAvailRequest

1

Provides the criteria to specify availability details to return

HotelRef

1

Indicates the detail of hotel reference information

@HotelCode

1

String

The code that uniquely identifies a single hotel property

DateRange

1

A date or range of dates for the request criteria

@Start

1

Date

The starting value of the time span

@End

1

Date

The ending value of the time span

RatePlanCandidates

1

Collection of requested rate plans

RatePlanCandidate

1

Element used to identify available products and rates

@RatePlanCode

1

String

A code that identifies the rate plan

RoomTypeCandidates

1

Collection of room stay candidates

RoomTypeCandidate

1

Element used to identify available room products

@RoomTypeCode

1

String

A code that identifies a room type

Sample

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Header>
    <HTNGHeader xmlns="http://htng.org/1.1/Header/">
      <From>
        <systemId>API Debug</systemId>
        <Credential>
          <userName>username</userName>
          <password>password</password>
        </Credential>
      </From>
      <To>
        <systemId>Convert5</systemId>
      </To>
      <echoToken>1716980945</echoToken>
    </HTNGHeader>
  </soap:Header>
  <soap:Body>
    <OTA_HotelAvailGetRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" TimeStamp="2024-05-29T11:09:05" Version="4">
      <HotelAvailRequests>
        <HotelAvailRequest>
          <HotelRef HotelCode="1853"/>
          <DateRange Start="2024-05-29" End="2024-05-30"/>
          <RatePlanCandidates>
            <RatePlanCandidate RatePlanCode="EXT1"/>
          </RatePlanCandidates>
          <RoomTypeCandidates>
            <RoomTypeCandidate RoomTypeCode="SGL"/>
          </RoomTypeCandidates>
        </HotelAvailRequest>
      </HotelAvailRequests>
    </OTA_HotelAvailGetRQ>
  </soap:Body>
</soap:Envelope>

Response

Element / @Attribute

Quantity

Type

Description

OTA_HotelAvailGetRS

1

Root Element

Success

0..1

Indicates that the incoming request message was processed successfully

Erorrs

0..1

A collection of errors that occurred during the processing of a message

Warnings

0..1

A collection of warning that occurred during the processing of a message

AvailStatusMessages

1

A collection of AvailStatusMessages

@HotelCode

1

String

The code that uniquely identifies a single hotel property

AvailStatusMessage

1

The AvailStatusMessage indicates whether the inventory is opened, closed, closed on request, etc

@BookingLimit

1

Integer

Number of units of inventory that can be sold

StatusApplicationControl

1

Information on what the AvailStatus Message applies to

@Start

1

Date

The starting value of the time span

@End

1

Date

The ending value of the time span

@RatePlanCode

0..1

String

A code that identifies the rate plan

@InvTypeCode

0..1

String

A code that identifies a room type

RestrictionStatus

0..1

Availability status assigned to the room rate combination

@Restriction

1

String

Identifies the restriction the status applies to

@Status

1

String

Identifies the availability status of an item

LengthsOfStay

0..1

Collection of Length of Stay elements

LengthOfStay

1

A collection of patterns defining allowable lengths of stay (LOS)

@MinMaxMessageType

1

String

An enumerated type used to define how the minimum and maximum LOS is applied

@Time

1

Integer

Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements

Sample

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
  <soap:Header>
    <wsa:Action>OTA_HotelAvailGetRS</wsa:Action>
  </soap:Header>
  <soap:Body>
    <OTA_HotelAvailGetRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.100" TimeStamp="2024-05-29T11:11:52Z">
      <Success/>
      <AvailStatusMessages HotelCode="1853">
        <AvailStatusMessage BookingLimit="50">
          <StatusApplicationControl Start="2024-05-29" End="2024-05-29" RatePlanCode="EXT1" InvTypeCode="SGL"/>
          <RestrictionStatus Restriction="Master" Status="Close"/>
          <RestrictionStatus Restriction="Departure" Status="Close"/>
          <RestrictionStatus Restriction="Arrival" Status="Close"/>
          <LengthsOfStay>
              <LengthOfStay MinMaxMessageType="MaxLOS" Time="3"/>
          </LengthsOfStay>
        </AvailStatusMessage>
        <AvailStatusMessage BookingLimit="50">
          <StatusApplicationControl Start="2024-05-30" End="2024-05-30" RatePlanCode="EXT1" InvTypeCode="SGL"/>
        </AvailStatusMessage>
      </AvailStatusMessages>
  </soap:Body>
</soap:Envelope>
  • No labels