fbpx

Have any Question?

You can ask below or enter what you are looking for!

Rates

Effective Tours API receive updates for rates via the OTA_HotelRateAmountNotifRQ message. Effective Tours API will process the updates and respond with the OTA_HotelRateAmountNotifRS message as a receipt of success or failure.

OTA_HotelRateAmountNotifRQ

The OTA_HotelRateAmountNotifRQ message is used to update the rates for one or more room types for a single hotel. Specifically:

  • Room rates
  • Room inclusions

Each OTA_HotelRateAmountNotifRQ message should have a single RateAmountMessages element which indicates the hotel to update using the RateAmountMessages/HotelCode attribute. The RateAmountMessages/RateAmountMessage elements will contain the updates to process over a date range. There can be several RateAmountMessage updates per request, however each request should be limited to one hotel.

Effective Tours API only supports sending the Base Guest Amount rate for a room. Base Guest Amount is the amount charged for the base number of guests staying in a room. Extra Guest charges such as Extra Infant, Extra Child and Extra Adults cannot be sent over Effective Tours API . 

The basic structure of the message is as follows:

<OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2005-08-01T09:30:47-05:00" Version="1.0" EchoToken="echo-abc123">
  <POS>
    <Source>
      <RequestorID Type="22" ID="PMS1"/>
    </Source>
  </POS>
  <RateAmountMessages HotelCode="ABC">
    <RateAmountMessage>
      <StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
      <Rates>
        <Rate CurrencyCode="AUD" Start="2010-01-01" End="2010-01-14" Mon="0" Tue="0" Weds="0" Thur="0" Fri="1" Sat="1" Sun="1">
          <BaseByRoomAmts>
            <BaseByRoomAmt Amount="123.00"/>
          </BaseByRoomAmts>
        </Rate>
      </Rates>
    </RateAmountMessage>
    <RateAmountMessage>
      <!-- Content omitted -->
    </RateAmountMessage>
  </RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

StatusApplicationControl

This element must appear once in each RateAmountMessage element. The StatusApplicationControl element is used to specify the room type, rate code and dates for which the update applies. 

The InvTypeCode attribute is required and the RatePlanCode attribute is optional. It is possible to have 1 or more Effective Tours API room types linked to the same InvTypeCode/RatePlanCode combination and the update will be applied to all room types found with matching values. 

Rate

The Rate element is used to determine the dates for which the update applies. The dates affected by the update are controlled by the mandatory Start and End attributes. Use the Mon, Tue, Wed, Thur, Fri, Sat or Sun attributes to apply an update to specific days of the week. If any of these day of week attributes is present, then they must all be present. For example it is not possible to specify just the Mon and Fri attribute and not include the other 5.

Setting Rates

Rates should be sent through in the BaseByRoomAmt element. Amount  must be included and must contain the rate as a positive decimal value (i.e. a rate of 200 should be 200.00). In order to set Rates it is mandatory to specify the CurrencyCode. At present Effective Tours API DOES NOT perform currency conversion and the Rate amount specified will be applied directly to Effective Tours.

<OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2005-08-01T09:30:47-05:00" Version="1.0" EchoToken="echo-abc123">
  <POS>
    <Source>
      <RequestorID Type="22" ID="PMS1"/>
    </Source>
  </POS>
   <RateAmountMessage>
      <StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
      <Rates>
        <Rate CurrencyCode="AUD" Start="2010-01-01" End="2010-01-14" Mon="0" Tue="0" Weds="0" Thur="0" Fri="1" Sat="1" Sun="1">
          <BaseByRoomAmts>
            <BaseByRoomAmt Occupancy="SGL" Amount="123.00"/>
            <BaseByRoomAmt Occupancy="DBL" Amount="123.00"/>
            <BaseByRoomAmt Occupancy="TPL" Amount="123.00"/>
            <BaseByRoomAmt Occupancy="FULL" Amount="123.00"/>
          </BaseByRoomAmts>
         </Rate>
        </Rates>
      </RateAmountMessage>
  </OTA_HotelRateAmountNotifRQ>

OTA_HotelRateAmountNotifRQ Specification

Element  NumberDescription
OTA_HotelRateAmountNotifRQ1Root node
@EchoToken1Globally unique identifier for the request, the value will be returned in the response EchoToken.
@Version1Current version is 1.0
@Timestamp1Timestamp of the request in xml dateTime format
OTA_HotelRateAmountNotifRQ / POS / Source / RequestorID1This identifies the system which is sending the Rates. This element must appear in the first Source element.
@Type1Fixed at 22 (ESRP)
@ID1The ID used will be agreed by the trading partners and remain the same throughout the messages.
OTA_HotelRateAmountNotifRQ / RateAmountMessages1Contains rates for a given hotel
@HotelCode1Hotel code of the property whose rate is being updated
RateAmountMessages / RateAmountMessage1..nRates to be updated
RateAmountMessage / StatusApplicationControl1Contains room identification information
@RatePlanCode0..1Identifies the rate to be updated
@InvTypeCode1Identifies the room to be updated
RateAmountMessage / Rates / Rate1..nContains the timespan the update applies to and the currency code if this is a rate update
@CurrencyCode0..1Required if BaseByRoomAmts is present, ie if you are updating the rate amount. Standard 3 character ISO currency code of the rate eg “AUD”
@Start, @End1The start and end date of the rate plan in xml date format. End date is inclusive. End date cannot be more than 750 days in the future.
@Sun, Mon, Tue, Weds, Thur, Fri, Sat0..1“0” or “1”. Optional, if not set all are assumed to be set to true The day of the week indicators are used to communicate which days of the week the update pertains to. For example, if mon, tue and weds are set to “1”, and the other days are set to “0”, the rate will only be updated for Monday, Tuesday and Wednesday. If one is sent they must all be sent.
Rate / BaseByRoomAmts0..1Optional. Contains information about the rates. Can be omitted if the update is only for inclusions.
BaseByRoomAmts / BaseByRoomAmt1Contains the rate amounts per room
@Amount0..1@Amount must be included if BaseByRoomAmts is present. Must be a positive decimal value. i.e. a rate of 200 should be 200.00

OTA_HotelRateAmountNotifRS

This message is returned to the PMS in response to the OTA_HotelRateAmountNotifRQ message. It notifies whether the OTA_HotelRateAmountNotifRQ message has been processed successfully.

Example of Success Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://www.opentravel.org/OTA/2003/05">
  <SOAP-ENV:Body>
    <tns:OTA_HotelRateAmountNotifRS Version="1.0" TimeStamp="2005-08-01T09:30:47+0000" EchoToken="echo-abc123">
      <tns:Success></tns:Success>
    </tns:OTA_HotelRateAmountNotifRS>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of Error Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://www.opentravel.org/OTA/2003/05">
  <SOAP-ENV:Body>
    <tns:OTA_HotelRateAmountNotifRS Version="1.0" TimeStamp="2005-08-01T09:30:47+08:00" EchoToken="echo-abc123">
      <tns:Errors>
        <tns:Error Type="3" Code="392">Cannot finder hotelier ABC</Error>
      </tns:Errors>
    </tns:OTA_HotelRateAmountNotifRS>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

OTA_HotelRateAmountNotifRS Specification

Element    NumberDescription
OTA_HotelRateAmountNotifRS1Root element
@EchoToken1Return the EchoToken from the request message.
@Version1Current version is 1.0
@TimeStamp1Time of the transaction.
OTA_HotelRateAmountNotifRS / Success / Success0..1Will only be present if the request processed successfully. The Errors node will not be present if the Success node is present
OTA_HotelRateAmountNotifRS / Errors0..1Contains a list of errors if the request failed to process.
Errors / Error1..nWill be at least one node if there is an Errors Node.
@Type1Mandatory if Error present. Any type from the OTA code table for ‘Error Warning Type (EWT)’ can be used. In particular, the following types are used
3: Biz rule (The business rules for the request message were not met)
4: Authentication error (If username and password are not authenticated)
6: Authorization error (If authenticated username is not authorized to alter hotel data)
10: Required field missing (If xml does not meet the schema, i.e missing request fields or invalid data types.)
@Code0..1

—- —- —- —- —- —- —- — — — — —
Back to API Documentation