OTA_HotelRatePlanRQ

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The OTA_HotelRatePlanRQ operation provides the ability to request rate plan details for hotel properties by specific criteria that may include date ranges, rates and rooms.

Request

Element / @Attribute	Quantity	Type	Description
OTA_HotelRatePlanRQ	1		Root Element.
@TimeStamp	0..1	DateTime	ISO 8601 format date string indicating the creation date and time of the message.
@EchoToken	0..1	String	A reference for additional message identification, assigned by the requesting host system.
@Version	0..1	Decimal	The OpenTravel message version indicated by a decimal value.
RatePlans	1		Collection of rate plans.
RatePlan	1		Provides the criteria to identify the rate plan to be returned.
HotelRef	1	String	Indicates the detail of hotel reference information.
@HotelCode	1	String	The code that uniquely identifies a single hotel property.
DateRange	1		A date range for the rate plan.
@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>usernam</userName>
          <password>password</password>
        </Credential>
      </From>
      <To>
        <systemId>Convert5</systemId>
      </To>
      <echoToken>1716980112</echoToken>
    </HTNGHeader>
  </soap:Header>
  <soap:Body>
    <OTA_HotelRatePlanRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" TimeStamp="2024-05-29T10:55:12" EchoToken="1716980112" Version="4">
      <RatePlans>
        <RatePlan>
          <HotelRef HotelCode="1853"/>
          <DateRange Start="2024-05-29" End="2024-05-30"/>
          <RatePlanCandidates>
            <RatePlanCandidate RatePlanCode="EXT1"/>
            <RatePlanCandidate RatePlanCode="EXT2"/>
          </RatePlanCandidates>
          <RoomTypeCandidates>
            <RoomTypeCandidate RoomTypeCode="SGL"/>
            <RoomTypeCandidate RoomTypeCode="DBL"/>
          </RoomTypeCandidates>
        </RatePlan>
      </RatePlans>
    </OTA_HotelRatePlanRQ>
  </soap:Body>
</soap:Envelope>

Response

Element / @Attribute	Quantity	Type	Description
OTA_HotelRatePlanRS	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
RatePlans	1		A collection of rate plans
HotelRef	1	String	Indicates the detail of hotel reference information
@HotelCode	1	String	The code that uniquely identifies a single hotel property
RatePlan	1		An individual rate plan
@RatePlanCode	1	String	A code that identifies the rate plan
Rate	1		An individual rate
@Start	1	Date	The starting value of the time span
@End	1	Date	The ending value of the time span
@InvTypeCode	1	String	A code that identifies a room type
BaseByGuestAmts	1		A collection of Base charges by number of guests
BaseByGuestAmt	1		Base charge for a given number of guests for a given age qualifying code
@AmountBeforeTax	1	Decimal	The total amount not including any associated tax
@NumberOfGuests	1	Integer	The number of guests associated with this base charge
@AgeQualifyingCode	1	Decimal	Defines an age range or age category of a guest
AdditionalGuestAmounts	0..1		A collection of charges that apply to for additional occupants
AdditionalGuestAmount	1		Collection of incremental charges per age qualifying code for additional guests
@AmountBeforeTax	1	Decimal	The total amount not including any associated tax
@NumberOfGuests	1	Integer	The number of guests associated with this base charge
@AgeQualifyingCode	1	Integer	Defines an age range or age category of a guest

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_HotelRatePlanRS</wsa:Action>
  </soap:Header>
  <soap:Body>
    <OTA_HotelRatePlanRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.100" TimeStamp="2024-05-29T10:56:20Z">
      <Success/>
      <RatePlans>
        <HotelRef HotelCode="1853"/>
        <RatePlan RatePlanCode="EXT1">
          <Rate Start="2024-05-29" End="2024-05-29" InvTypeCode="SGL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
          <Rate Start="2024-05-30" End="2024-05-30" InvTypeCode="SGL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="123.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
          <Rate Start="2024-05-29" End="2024-05-29" InvTypeCode="DBL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
          <Rate Start="2024-05-30" End="2024-05-30" InvTypeCode="DBL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="150.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
        </RatePlan>
        <RatePlan RatePlanCode="EXT2">
          <Rate Start="2024-05-29" End="2024-05-29" InvTypeCode="SGL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
          <Rate Start="2024-05-30" End="2024-05-30" InvTypeCode="SGL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="160.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
          <Rate Start="2024-05-29" End="2024-05-29" InvTypeCode="DBL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
          <Rate Start="2024-05-30" End="2024-05-30" InvTypeCode="DBL">
            <BaseByGuestAmts>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
              <BaseByGuestAmt AmountBeforeTax="200.00" NumberOfGuests="5" AgeQualifyingCode="10"/>
            </BaseByGuestAmts>
            <AdditionalGuestAmounts>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="xadu" AgeQualifyingCode="10"/>
              <AdditionalGuestAmount AmountBeforeTax="0.00" NumberOfGuests="chi1" AgeQualifyingCode="8"/>
            </AdditionalGuestAmounts>
          </Rate>
        </RatePlan>
      </RatePlans>
    </OTA_HotelRatePlanRS>
  </soap:Body>
</soap:Envelope>