Home > Channel Management > RMS Online API > 1.3 Availability Rates Request and Response

1.3 Availability Rates Request and Response

  1. Overview
  2. Feature
    1. Request Elements
    2. Example Request - RoomType Specific
    3. Example Request - Area Specific
    4. Example Request - Full Chart Request
    5. Example Request - Multiple Requests
    6. Response Elements
    7. Example Response - RoomType Specific
    8. Example Response - Area Specific
    9. Example Response - Full Chart Response
    10. Example Response - Multiple Responses
  3. Related

Overview

This article will take you through the elements of a Availability / Rates Request and Response.

Feature

The Availability / Rates request allows you to call for property

Request Elements

Element Name Parent Element Element Description Attributes Required
RMSAvailRateChartRQ   Room element.  Containing the response for avail/rates request. Version - document version of the response schema Yes
Requests RMSAvailRateChartRQ Optional wrapping element for having multiple property requests in one call.   No
Request Requests Optional wrapping element for having multiple property requests in one call.   No
AgentId RMSAvailRateChartRQ -or- Request The agent code of the RMS agent enquiring.   Yes
RMSClientId RMSAvailRateChartRQ -or- Request The RMS Client Id of the property being searched.   Yes
Start RMSAvailRateChartRQ -or- Request The start date for the avail / rates chart.   Yes
End RMSAvailRateChartRQ -or- Request The avail / rates chart will display up to but Excluding this End Date   Yes
Arrival RMSAvailRateChartRQ -or- Request The booking arrival date.   No
Departure RMSAvailRateChartRQ -or- Request The booking departure date.   No
ChartNights RMSAvailRateChartRQ -or- Request Number of nights to return, from the start date provided above.  This is an optional field that can be used in replacement of the end date.   No
RoomTypes RMSAvailRateChartRQ -or- Request Contains the specific list of room types to return.   No
RoomType RoomTypes The specificed room type. RoomTypeId = The identifier of the room type to return. No
Areas RoomTypes Contains a specific list of areas to return.   No
Area Areas The specified area. AreaId = The identifier of the room type to return. No
SubProperties RMSAvailRateChartRQ -or- Request Contains a specific list of sub properties of which to return its underlying room types.   No
SubProperty RMSAvailRateChartRQ -or- Request The specified sub property.   No
SubPropertyId RMSAvailRateChartRQ -or- Request The identifier of the sub property.   No
Adults RMSAvailRateChartRQ -or- Request Number of adults for rate calculation.  If not supplied, response will contain base rate plus rates for each additional.  If supplied , response will contain total rate based on number supplied.   No
Children RMSAvailRateChartRQ -or- Request Number of Children for rate calculation.  If not supplied, response will contain base rate plus rates for each additional.  If supplied , response will contain total rate based on number supplied.   No
Infants RMSAvailRateChartRQ -or- Request Number of Infants for rate calculation.  If not supplied, response will contain base rate plus rates for each additional.  If supplied , response will contain total rate based on number supplied.   No
Additional1 RMSAvailRateChartRQ -or- Request Number of first additionals for rate calculation.   No
Additional2 RMSAvailRateChartRQ -or- Request Number of second additionals for rate calculation.   No
Additional3 RMSAvailRateChartRQ -or- Request Number of third additionals for rate calculation.   No
Additional4 RMSAvailRateChartRQ -or- Request Number of fourth additionals for rate calculation.   No
Additional5 RMSAvailRateChartRQ -or- Request Number of fifth additionals for rate calculation.   No
RVLengthId RMSAvailRateChartRQ -or- Request RV Length Id, if supplied RMS will filter availability on this element.   No
RVTypeId RMSAvailRateChartRQ -or- Request RV Type Id, if supplied RMS will filter availability on this element.   No
RVSlide RMSAvailRateChartRQ -or- Request RV Slide Id, if supplied RMS will filter availability on this element.   No
Test RMSAvailRateChartRQ -or- Request Optional element.  If present, point to the test data for a property.   No
ShowAreas RMSAvailRateChartRQ -or- Request Optional element.  If present, show the area detail of the room type.   No
AvailOnly RMSAvailRateChartRQ -or- Request Optional element.  If present, response will only check and return availability excluding rates.   No
PromoCode RMSAvailRateChartRQ -or- Request

Optional element.  Used to place a promotional discount against the price.  If used two elements will be present in the response;

          <TotalPrice>540.00</TotalPrice>
          <TotalPriceAfterDiscount>530.00</TotalPriceAfterDiscount>

   No
PromoCodeSecond RMSAvailRateChartRQ -or- Request

Optional element. To be used with PromoCode.  Used to place a second promotional discount against the price.  If used two elements will be present in the response;

          <TotalPrice>540.00</TotalPrice>
          <TotalPriceAfterDiscount>520.00</TotalPriceAfterDiscount>

   No
ShowAllChargeTypesIrrespectiveOfPromoCode RMSAvailRateChartRQ -or- Request Optional Element.  If True All Available Charge Types will be Returned with a Response Element "PromoCodeApplied" to indicate if the Promo Code is applicable to the Charge Type   No

Example Request - RoomType Specific

<RMSAvailRateChartRQ>
  <AgentId>1</AgentId>
  <RMSClientId>3038</RMSClientId>
  <Start>2014-08-22</Start>
  <End>2014-08-30</End>
  <Arrival>2014-08-22</Arrival>
  <Departure>2014-08-24</Departure>
  <RoomTypes>
    <RoomType RoomTypeId="2" />
  </RoomTypes>
  <Adults>1</Adults>
  <Children>0</Children>
  <Infants>0</Infants>
  <Additional1>0</Additional1>
  <Additional2>0</Additional2>
  <Additional3>0</Additional3>
  <Additional4>0</Additional4>
  <Additional5>0</Additional5>

  <RVLengthId>3</RVLengthId>
  <RVTypeId>5</RVTypeId>
  <RVSlide>7</RVSlide>
  <PromoCode>*DGetaway</PromoCode>

  <PromoCodeSecond>*DGetaway2</PromoCodeSecond>

</RMSAvailRateChartRQ>

Example Request - Area Specific

<RMSAvailRateChartRQ>
  <AgentId>1</AgentId>
  <RMSClientId>3038</RMSClientId>
  <Start>2012-12-18</Start>
  <End>2012-12-25</End>
  <RoomTypes>
    <RoomType RoomTypeId="2">
      <Areas>
        <Area AreaId="6"/>
      </Areas>
    </RoomType>
  </RoomTypes>
  <Adults>2</Adults>
  <Children>0</Children>
  <Infants>0</Infants>
  <Additional1>0</Additional1>
  <Additional2>0</Additional2>
  <Additional3>0</Additional3>
  <Additional4>0</Additional4>
  <Additional5>0</Additional5>
</RMSAvailRateChartRQ>

Example Request - Full Chart Request

<RMSAvailRateChartRQ>
  <AgentId>1</AgentId>
  <RMSClientId>3038</RMSClientId>
  <Start>2012-12-18</Start>
  <End>2012-12-20</End>
</RMSAvailRateChartRQ>

 

Example Request - Multiple Requests

<RMSAvailRateChartRQ>
  <Requests>
    <Request>
      <AgentId>1</AgentId>
      <RMSClientId>3038</RMSClientId>
      <Start>2012-12-18</Start>
      <End>2012-12-20</End>
    </Request>
    <Request>
      <AgentId>1</AgentId>
      <RMSClientId>3038</RMSClientId>
      <Start>2012-12-20</Start>
      <End>2012-12-22</End>
    </Request>
  </Requests>
</RMSAvailRateChartRQ>

Response Elements

Element Name Parent Element Element Description Attributes
RMSAvailRateChartRS   Root element.  Containing the response for avail/rates request Version - document version of the response schema.
Responses RMSAvailRateChartRS Optional wrapping element for having multiple property responses in one call.  
Response Responses Optional wrapping element for having multiple property responses in one call.  
SoldMessage RMSAvailRateChartRS -or- Response    
RoomTypes RMSAvailRateChartRS -or- Response

Contains allocated room types with availability and charge type information for specified period.

Note Avail/Rates will show under areas if areas were specified in the request.

  
RoomType RoomTypes The specified room type.  
RoomTypeId RoomType Identifier for the room type attached.  
SubPropertyId RoomType The sub property the room type belongs to.  
MaxOccupancy RoomType The max number of guests allowed in this room type.  
Name RoomType Name of the roomtype.  
Areas RoomType

Contains the allocated areas with availability and charge type information for the specified period.

Note this element will only appear if specified in the request.

  
Area Areas The specified area.  
AreaId Area Identifier for the area attached.  
Name Area The name of the area.  
Description Area The long description of the area.  
Last Booked Area The Last Date the Area was last Booked  
Availability RoomType unless using Area elements in which case Area becomes the parent Represents daily availability for the room type/area.

Id = Identifies the availability entry

Date = The date represented by this entry

Available = True/False as to whether this room type/area is available on the specified date.

NoOfRoomsAvailable = If available, number of rooms area available for this room type

Note NoOfRoomsAvailable will not show if calling for specific areas.
ChargeTypes RoomType unless using Area elements in which case Area becomes the parent Contains charge types allocated to the current room type/area.  
ChargeType ChargeTypes The specified charge type.  
ChargeTypeId ChargeType Identifier for the charge type attached.  
Name ChargeType Name of the charge type attached.  
Description ChargeType Long description of the charge type attached.  
TotalPrice ChargeType Total Price of Booking using the arrival and departure dates  
TotalPriceAfterDiscount ChargeType Total Price of Booking after the discount/s have been applied using the arrival and departure dates.  
PromoCodeApplied ChargeType Indicates whether the Charge Type is applicable for the PromoCode if Present in the Request  
Charge ChargeType

Represents daily charge details and availability for the charge type.

 

Availability returned in this element supersedes the category availability (allowing the property to stop sell rates for there online page).

Id = Identifier for the charge entry

Date = The date represented by this entry

Price = The price of this charge

MinStay = The minimum stay period for that particular charge type/roomtype/area combination

MaxStay = The maximum stay period for that particular charge type/roomtype/area combination

ValidCharge = Indicates whether the Charge Type is valid for the day (False would represent a grid rate that has returned $0)

IncludeChildInBase = True/False to whether children are included in the Price

IncludeInfantInBase = True/False to whether Infants are included in the Price

Flames = True/False to whether flames images should be used

CanArriveToday = Specifies whether a customer can make a booking arriving on this date

ClosedToArrival = True/False to whether a Closed to Arrival has been set for that Date

NoOfRoomsAvailable = Number of areas available for this Charge Type.

PersonBase = The amount of people the price applies to

ChildBase = Number of Children the price applies to

InfantBase = Number of Infants the price applies to
AdditionalGuests ChargeType Contains charge details for additional guests if booking has more guests than the PersonBase.  Only supplied if Adults, Children and Infants elements are not present in the RMSAvailRateChartRQ.  
Adults AdditionalGuests Additional Adult Charges.

FirstAdditional = Price for the first additional over the PersonBase

SecondAdditional = Price for the second additional over the PersonBase

ThirdAdditional = Price for the third additional over the PersonBase

FourthAdditional = Price for the fourth additional over the PersonBase

Thereafter = Price for each additional after the fourth

MinAllowed = Minimum number of adults required

MaxAllowed = Maximum number of adults allowed
Children AdditionalGuests Additional Children Charges.

FirstAdditional = Price for the first additional over the PersonBase

SecondAdditional = Price for the second additional over the PersonBase

ThirdAdditional = Price for the third additional over the PersonBase

FourthAdditional = Price for the fourth additional over the PersonBase

Thereafter = Price for each additional after the fourth

MinAllowed = Minimum number of children required

MaxAllowed = Maximum number of children allowed
Infants AdditionalGuests Additional Infant Charges

FirstAdditional = Price for the first additional over the PersonBase

SecondAdditional = Price for the second additional over the PersonBase

ThirdAdditional = Price for the third additional over the PersonBase

FourthAdditional = Price for the fourth additional over the PersonBase

Thereafter = Price for each additional after the fourth

MinAllowed = Minimum number of infants required

MaxAllowed = Maximum number of infants allowed

Example Response - RoomType Specific

<RMSAvailRateChartRS Version="1.0.0.0">
  <SoldMessage>call</SoldMessage>
  <RoomTypes>
    <RoomType>
      <RoomTypeId>2</RoomTypeId>
      <SubPropertyId>1</SubPropertyId>
      <Name>One Bedroom</Name>
      <MaxOccupancy>4</MaxOccupancy>
      <Availability Id="1" Date="2014-08-22" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="2" Date="2014-08-23" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="3" Date="2014-08-24" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="4" Date="2014-08-25" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="5" Date="2014-08-26" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="6" Date="2014-08-27" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="7" Date="2014-08-28" Available="true" NoOfRoomsAvailable="9" />
      <Availability Id="8" Date="2014-08-29" Available="true" NoOfRoomsAvailable="8" />
      <BookingRangeAvailable>true</BookingRangeAvailable>
      <ChargeTypes>
        <ChargeType>
          <ChargeTypeId>7</ChargeTypeId>
          <Name>Mobile</Name>
          <Description></Description>
          <TotalPrice>540.00</TotalPrice>
          <TotalPriceAfterDiscount>520.00</TotalPriceAfterDiscount>
          <Charge Id="1" Date="2014-08-22" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="2" Date="2014-08-23" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="3" Date="2014-08-24" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="4" Date="2014-08-25" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="5" Date="2014-08-26" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="6" Date="2014-08-27" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="7" Date="2014-08-28" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="8" Date="2014-08-29" Price="270.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
        </ChargeType>
        <ChargeType>
          <ChargeTypeId>17</ChargeTypeId>
          <Name>No of Nights Stay</Name>
          <Description></Description>
          <TotalPrice>100.00</TotalPrice>
          <TotalPriceAfterDiscount>90.00</TotalPriceAfterDiscount>
          <Charge Id="1" Date="2014-08-22" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="2" Date="2014-08-23" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="3" Date="2014-08-24" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="4" Date="2014-08-25" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="5" Date="2014-08-26" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="6" Date="2014-08-27" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="7" Date="2014-08-28" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
          <Charge Id="8" Date="2014-08-29" Price="50.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0" />
        </ChargeType>
        <ChargeType>
          <ChargeTypeId>2</ChargeTypeId>
          <Name>Promotion</Name>
          <Description></Description>
          <TotalPrice>400.00</TotalPrice>
          <TotalPriceAfterDiscount>390.00</TotalPriceAfterDiscount>
          <Charge Id="1" Date="2014-08-22" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="true" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="2" Date="2014-08-23" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="true" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="3" Date="2014-08-24" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="true" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="4" Date="2014-08-25" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="5" Date="2014-08-26" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="6" Date="2014-08-27" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="7" Date="2014-08-28" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="8" Date="2014-08-29" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
        </ChargeType>
        <ChargeType>
          <ChargeTypeId>1</ChargeTypeId>
          <Name>Rack Rate</Name>
          <Description>Every Day Rate!</Description>
          <TotalPrice>182.00</TotalPrice>
          <TotalPriceAfterDiscount>172.00</TotalPriceAfterDiscount>
          <Charge Id="1" Date="2014-08-22" Price="92.00" MinStay="4" MaxStay="0" ValidCharge="true" IncludeChildInBase="true" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="15.00" SecondAdditional="15.00" ThirdAdditional="15.00" FourthAdditional="15.00" Thereafter="15.00" MinAllowed="1" MaxAllowed="0" />
              <Children FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="10.00" FourthAdditional="10.00" Thereafter="10.00" MinAllowed="0" MaxAllowed="3" />
              <Infants FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional1 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional2 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional3 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional4 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional5 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional6 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" />
              <Additional7 FirstAdditional="5.00" SecondAdditional="5.00" ThirdAdditional="5.00" FourthAdditional="5.00" Thereafter="5.00" MinAllowed="0" MaxAllowed="0" /          

             </AdditionalGuests>
          </Charge>
        </ChargeType>
      </ChargeTypes>
    </RoomType>
  </RoomTypes>
</RMSAvailRateChartRS>

Example Response - Area Specific

<RMSAvailRateChartRS Version="1">
  <SoldMessage>sold</SoldMessage>
  <RoomTypes>
    <RoomType>
      <RoomTypeId>2</RoomTypeId>
      <SubPropertyId>1</SubPropertyId>
      <Name>Studio</Name>
      <MaxOccupancy>4</MaxOccupancy>
      <BookingRangeAvailable>false</BookingRangeAvailable>
      <Areas>
        <Area>
          <AreaId>6</AreaId>
          <Name>06</Name>
          <Description></Description>

          <LastBooked>2012-12-16</LastBooked>
          <Availability Id="1" Date="2012-12-18" Available="true" />
          <Availability Id="2" Date="2012-12-19" Available="true" />
          <Availability Id="3" Date="2012-12-20" Available="true" />
          <Availability Id="4" Date="2012-12-21" Available="true" />
          <Availability Id="5" Date="2012-12-22" Available="true" />
          <Availability Id="6" Date="2012-12-23" Available="true" />
          <Availability Id="7" Date="2012-12-24" Available="true" />
          <ChargeTypes>
            <ChargeType>
              <ChargeTypeId>8</ChargeTypeId>
              <Name>BAR</Name>
              <Description></Description>
              <Charge Id="1" Date="2012-12-18" Price="80.00" MinStay="0" MaxStay="0" />
              <Charge Id="2" Date="2012-12-19" Price="80.00" MinStay="0" MaxStay="0" />
              <Charge Id="3" Date="2012-12-20" Price="80.00" MinStay="0" MaxStay="0" />
              <Charge Id="4" Date="2012-12-21" Price="100.00" MinStay="0" MaxStay="0" />
              <Charge Id="5" Date="2012-12-22" Price="100.00" MinStay="0" MaxStay="0" />
              <Charge Id="6" Date="2012-12-23" Price="100.00" MinStay="0" MaxStay="0" />
              <Charge Id="7" Date="2012-12-24" Price="80.00" MinStay="0" MaxStay="0" />
            </ChargeType>
          </ChargeTypes>
        </Area>
      </Areas>
    </RoomType>
  </RoomTypes>
</RMSAvailRateChartRS>

Example Response - Full Chart Response

<RMSAvailRateChartRS Version="1">
  <SoldMessage>sold</SoldMessage>
  <RoomTypes>
    <RoomType>
      <RoomTypeId>2</RoomTypeId>
      <SubPropertyId>1</SubPropertyId>
      <Name>Studio</Name>
      <MaxOccupancy>4</MaxOccupancy>
      <BookingRangeAvailable>true</BookingRangeAvailable>
      <Availability Id="1" Date="2012-12-18" Available="true" NoOfRoomsAvailable="4" />
      <Availability Id="2" Date="2012-12-19" Available="true" NoOfRoomsAvailable="4" />
      <ChargeTypes>
        <ChargeType>
          <ChargeTypeId>8</ChargeTypeId>
          <Name>BAR</Name>
          <Description></Description>
          <Charge Id="1" Date="2012-12-18" Price="80.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="True" ClosedToArrival="true" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="20.00" SecondAdditional="20.00" ThirdAdditional="0.00" FourthAdditional="0.00" Thereafter="0.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="0.00" FourthAdditional="0.00" Thereafter="0.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
          <Charge Id="2" Date="2012-12-19" Price="80.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="True" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests>
              <Adults FirstAdditional="20.00" SecondAdditional="20.00" ThirdAdditional="0.00" FourthAdditional="0.00" Thereafter="0.00" MinAllowed="0" MaxAllowed="0" />
              <Children FirstAdditional="10.00" SecondAdditional="10.00" ThirdAdditional="0.00" FourthAdditional="0.00" Thereafter="0.00" MinAllowed="0" MaxAllowed="0" />
            </AdditionalGuests>
          </Charge>
        </ChargeType>
      </ChargeTypes>
    </RoomType>
    <RoomType>
      <RoomTypeId>3</RoomTypeId>
      <SubPropertyId>1</SubPropertyId>
      <Name>One Bedroom</Name>
      <MaxOccupancy>2</MaxOccupancy>
      <BookingRangeAvailable>true</BookingRangeAvailable>
      <Availability Id="1" Date="2012-12-18" Available="true" NoOfRoomsAvailable="4" />
      <Availability Id="2" Date="2012-12-19" Available="true" NoOfRoomsAvailable="4" />
      <ChargeTypes>
        <ChargeType>
          <ChargeTypeId>8</ChargeTypeId>
          <Name>BAR</Name>
          <Description></Description>
          <Charge Id="1" Date="2012-12-18" Price="150.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="True" ClosedToArrival="true" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests />
          </Charge>
          <Charge Id="2" Date="2012-12-19" Price="150.00" MinStay="0" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="True" ClosedToArrival="false" PersonBase="2" ChildBase="0" InfantBase="0">
            <AdditionalGuests />
          </Charge>
        </ChargeType>
      </ChargeTypes>
    </RoomType>
  </RoomTypes>
</RMSAvailRateChartRS>

 

Example Response - Multiple Responses

<RMSAvailRateChartRS Version="1.0.1.5">
  <Responses>
    <Response>
      <SoldMessage>call</SoldMessage>
      <RoomTypes>
        <RoomType>
          <RoomTypeId>11</RoomTypeId>
          <SubPropertyId>1</SubPropertyId>
          <Name>Function Rooms</Name>
          <MaxOccupancy>0</MaxOccupancy>
          <Availability Id="1" Date="2012-12-18" Available="true" NoOfRoomsAvailable="3" />
          <Availability Id="2" Date="2012-12-19" Available="true" NoOfRoomsAvailable="3" />
          <BookingRangeAvailable>true</BookingRangeAvailable>
          <ChargeTypes />
        </RoomType>
      </RoomTypes>
    </Response>
    <Response>
      <SoldMessage>call</SoldMessage>
      <RoomTypes>
        <RoomType>
          <RoomTypeId>11</RoomTypeId>
          <SubPropertyId>1</SubPropertyId>
          <Name>Function Rooms</Name>
          <MaxOccupancy>0</MaxOccupancy>
          <Availability Id="1" Date="2012-12-20" Available="true" NoOfRoomsAvailable="3" />
          <Availability Id="2" Date="2012-12-21" Available="true" NoOfRoomsAvailable="3" />
          <BookingRangeAvailable>true</BookingRangeAvailable>
          <ChargeTypes />
        </RoomType>
      </RoomTypes>
    </Response>
  </Responses>
</RMSAvailRateChartRS>

Related

RMS Online API
This guide provides an overview of product features and related technologies. In addition, it contains recommendations on best practices, tutorials for getting started, and troubleshooting information for common situations.
1.1 Property Details Request and Response
This article will take you through the elements of a Property Details Request and Response.
1.2 Room Type Details Request and Response
This article will take you through the elements of a Room Type Request and Response.
1.4 Booking Quote Request and Response
This article will take you through the elements of a Booking Quote Request and Response.
1.5 Booking Request and Response
This article will take you through the elements of a Booking Request and Response.
1.6 Booking Cancel Request and Response
This article will take you through the elements of a Booking Cancel Request and Response.
2.1 Terms and Definitions
This article will take you through the terms and definitions of the RMS Online Schema.
RMS API Technical Information
This article will provide your web page developer the technical information required to write to the RMS API Schema.



 

You must to post a comment.
Last modified
15:37, 7 Jul 2015

Tags

Classifications

This page has no classifications.
For support assistance with this article, click once on the Live Support image below
 
btn_LS_on.png
Powered by MindTouch ®