OTA_HotelAvailGetRQ/RS

Provides the ability to request availability details for hotel properties by specific criteria that may include dates, date ranges, rates, rooms and products. For example to fill calendars on a Booking Engine.

OTA_HotelAvailGetRQ

<?xml version="1.0" encoding="utf-8"?>
<OTA_HotelAvailGetRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <POS>
    <Source>
      <RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
    </Source>
  </POS>
  <HotelAvailRequests>
    <HotelAvailRequest>
      <DateRange Start="2018-07-29" End="2018-07-29" />
      <HotelRef HotelCode="12345" />
      <DestinationSystemsCode>
        <DestinationSystemCode>1</DestinationSystemCode>
      </DestinationSystemsCode>
      <RoomTypeCandidates>
        <RoomTypeCandidate RoomTypeCode="1" />
      </RoomTypeCandidates>
      <RatePlanCandidates>
        <RatePlanCandidate RatePlanCode="1" />
      </RatePlanCandidates>
    </HotelAvailRequest>
  </HotelAvailRequests>
</OTA_HotelAvailGetRQ>
Element / @Attribute Parent Info Values Occurrence
HotelAvailRequests OTA_HotelAvailGetRQ Container for the individual HotelAvailRequests(s). 1
HotelAvailRequest HotelAvailRequests Provides the criteria to specify availability details to return. The criteria can include date ranges, room and products, rate plans, hurdle rate, etc. 1
DateRange HotelAvailRequest A date or range of dates for the request criteria. 1
@Start DateRange The starting value of the time span. [yyyy-MM-dd] 1
@End DateRange The ending value of the time span. [yyyy-MM-dd] 1
HotelRef HotelAvailRequest Indicates the detail of hotel reference information. 1
@HotelCode HotelRef The ID of the hotel. [integer] 1
DestinationSystemsCode HotelAvailRequest A collection of destination system codes. These are systems for which this request is targeted. A collection of DestinationSystemCode. 0..1
DestinationSystemCode DestinationSystemsCode The ID of the channel. [integer] 1
RoomTypeCandidates HotelAvailRequest Collection of room stay candidates. 0..1
RoomTypeCandidate RoomTypeCandidates Element used to specify room products. 1
@RoomTypeCode The ID of the room. [integer] 1
RatePlanCandidates HotelAvailRequest Collection of requested rate plans. 0..1
RatePlanCandidate RatePlanCandidates Element used to identify available products and rates. 1
RatePlanCode RatePlanCandidate The ID of the rate. [integer] 1

OTA_HotelAvailGetRS

<?xml version="1.0" encoding="utf-8"?>
<OTA_HotelAvailGetRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <Success />
  <AvailStatusMessages HotelCode="12345">
    <AvailStatusMessage BookingLimit="5">
      <StatusApplicationControl InvTypeCode="1" RatePlanCode="1" RateTier="1" Start="2018-07-29" End="2018-07-29" Mon="true" Fri="true" />
      <BestAvailableRates>
        <BestAvailableRate Amount="4995" DecimalPlaces="2" AgeQualifyingCode="10" NumberOfGuests="2" />
        <BestAvailableRate Amount="2550" DecimalPlaces="2" AgeQualifyingCode="7" />
      </BestAvailableRates>
      <RestrictionStatus Restriction="Master" Status="Open" />
      <RestrictionStatus Restriction="Arrival" Status="Close" />
      <RestrictionStatus Restriction="Departure" Status="Close" />
      <LengthsOfStay FixedPatternLength="7">
        <LengthOfStay MinMaxMessageType="MinLOS" Time="2" />
        <LengthOfStay MinMaxMessageType="MaxLOS" Time="7" />
        <LengthOfStay MinMaxMessageType="FullPatternLOS">
          <LOS_Pattern FullPatternLOS="YYYNNNN" />
        </LengthOfStay>
      </LengthsOfStay>
    </AvailStatusMessage>
  </AvailStatusMessages>
</OTA_HotelAvailGetRS>
Element / @Attribute Parent Info Values Occurrence
AvailStatusMessages OTA_HotelAvailGetRS Container for the individual AvailStatusMessage(s). An OTA_HotelAvailGetRS contains the availability statuses for a single hotel. Hotel identification information are the attributes of this element. 1
@HotelCode AvailStatusMessages The ID of the hotel. [integer] 1
AvailStatusMessage AvailStatusMessages The AvailStatusMessage indicates whether the inventory is opened, closed, etc. 1..n
@BookingLimit AvailStatusMessage Number of units of inventory that can be sold. [integer] 1
StatusApplicationControl AvailStatusMessage Information on what the AvailStatus Message applies to (i.e. the combination of inventory and rate codes) and the period of application. The StatusApplicationControl class is used to indicate to which block codes/rate plans/inventory codes a status should be applied. 1
@InvTypeCode StatusApplicationControl The ID of the room. [integer] 1
@RatePlanCode StatusApplicationControl The ID of the rate. [integer] 1
@RateTier StatusApplicationControl The ID of the channel. [integer] 1
@Start StatusApplicationControl The starting value of the time span. [yyyy-MM-dd] 1
@End StatusApplicationControl The ending value of the time span. [yyyy-MM-dd] 1
@Mon, @Tue, @Weds, @Thur, @Fri, @Sat, @Sun StatusApplicationControl When true, applies only to a particular day. true
false		 0..1
BestAvailableRates AvailStatusMessage A collection of the best rates available. 1
BestAvailableRate BestAvailableRates The details of a best available rate. 1..n
@Amount BestAvailableRate A monetary amount. [numeric] 1
@DecimalPlaces BestAvailableRate The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. [integer] 1
@AgeQualifyingCode BestAvailableRate Defines an age range or age category of a guest. Refer to OpenTravel Code List Age Qualifying Code (AQC) 1
@NumberOfGuests BestAvailableRate The number of guests associated with this base charge, only required when AgeQualifyingCode is set to 10. 1 = Single use
2 = Standard use
3 = Triple use
4 = Quad use
0 = Extra person		 0..1
RestrictionStatus AvailStatusMessage Availability status assigned to the room rate combination for this booking rule. 0..n
@Restriction RestrictionStatus The type of the restriction. Arrival
Departure
Master (default)		 0..1
@Status RestrictionStatus The status. Open
Close		 1
LengthsOfStay AvailStatusMessage A collection of lengths of stay. A collection of LengthOfStay. 0..1
@FixedPatternLength LengthsOfStay The number of elements in a fixed pattern length of stay (FPLOS) array. [integer] 1
LengthOfStay LengthsOfStay A collection of patterns defining allowable lengths of stay (LOS). 1..n
@MinMaxMessageType LengthOfStay An enumerated type used to define how the minimum and maximum LOS is applied: MinLOS
MaxLOS
FullPatternLOS		 1
@Time LengthOfStay Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements. (Only applicable for MinMaxMessageType MinLOS and MaxLOS.) [integer] 0..1
LOS_Pattern LengthOfStay Used to define the LOS Pattern. 0..1
@FullPatternLOS LOS_Pattern This may be used when MinMaxMessageType is FullPatternLOS to identify the open and closed status by LOS (e.g., if LengthsOfStay @FixedPatternLength="7" then FullPatternLOS="YYNYYYY"). [string] 1