Submit your question using the contact form below to request a new article.

    Alternatively, Log a Service Request for assistance from our Customer Support Team.


    Availability Rates Request & Response for the Online API

    Information on the Availability & Rates Request and Response for the RMS Online API.

    The Availability/Rates request allows for calling the property's Rate Types and Availability.


    Information

    • When Arrive & Depart dates are supplied the availability is calculated based on whether a booking can be made.

    The two main factors that determine if a booking can be made are:

        1. There is availability for the entire date range.

        2. The same Area is available for the entire date range.

    If any of the nights in the range return with no availability or a single Area is not available for the entire length of say then the entire date range will be returned as not available.

    To retrieve the actual nightly availability the Arrive & Depart dates should be omitted from the request. When done this way, the availability calculations will not use the above rules and will simply return the number of Areas available within the Category for each date.

    • The bookingRangeAvailable element is only set to True when every Rate Type for the Category is available for the booking range.

    This element behaves this way as the ability to return more than one Rate Type for each Category was added added at a later stage and was introduced to ensure backwards compatibility.

    The correct way to determine availability when there are multiple Rate Types to check is to check each Rate Type has NoOfRoomsAvailable as greater than 0 whilst meeting other restrictions. Eg. ClosedToArrival = False for the dates being booked.

    If all conditions are met then the Rate Type should be shown as available.


    Request Elements

    Element Name Parent Element Element Description Attributes Required
    RMSAvailRateChartRQ   Room element.  Containing the response for avail/rates request.   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 specified room type. RoomTypeId = The identifier of the room type to return. No
    RoomTypeAttribute RoomTypeAttributes Specificed Attributes to filter Room Types returned. RoomTypeAttributeId = The identifier of the room types attribute to filter on. No
    ChargeType ChargeTypes The specified charge type ChargeTypeId=The identifier of the charge type to return No
    Areas RoomType Contains a specific list of areas to return.   No
    Area Areas The specified area. AreaId = The identifier of the area to return. No
    AreaAttribute AreaAttributes Specificed Attributes to filter Areas returned. AreaAttributeId = The identifier of the area attribute to filter on. 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. SupPropertyId=The identifier of the subproperty to return. 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;

              540.00
              530.00

    Can also be used as a Group Allotment name where rates and roomtypes will be restricted by group allotment

      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;

              540.00
              520.00

      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
    Attribute by Room Type RMSAvailRateChartRQ-or-Request A specified additional Attribute.   No
    Abbribute by Area RMSAvailRateChartRQ-or-Request A specified additional Attribute   No
    ExcludeInvalidRates RMSAvailRateChartRQ-or-Request Optional element. If present will exclude RoomTypes/Rates that do not meet stay restrictions (eg min/max nights, min/max pax)   No


    Example Request - Category 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>


    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 User-Configurable phrase to display when there is no availability. Eg. "Sold", "Sold Out" or "Please call"  
    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.  

    NoDiscountAllowed

    ChargeType No Discount Allowed True/False  
    Currency ChargeType Currency the Rate is in  
    Name ChargeType Name of the charge type attached.  
    Description ChargeType Long description of the charge type attached.  
    Notes ChargeType Notes associated with the Rate Type.

    If an HTML description is required from RMS, this is the best field to use. Simply paste the HTML into the setup field in RMS and it will be reflected in the API.
     
    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. This includes an on arrival date only (MLOS restriction type)

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

    MinResStaySoftClose= Any day within stay (Soft Close restriction)

    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

    ClosedToDeparture = True/False to whether a Closed to Departure has been set for that Date

    StopSell = True/False whehter a StopSell 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

    ExclusiveTax ExclusiveTaxes Each new Tax per Room Type  
    Name ExclusiveTaxes Name of Tax  
    TaxType ExclusiveTaxes Type of Tax E.g. Percentage  
    TaxAmount ExclusiveTaxes Amount of Tax  

     



    Example Response - Category 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>
              <Notes>This promotion will incur a $100 charge for any cancellation.</Notes>
    <NoDiscountAllowed>false</NoDiscountAllowed>
              <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>
             <NoDiscountAllowed>false</NoDiscountAllowed>
              <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>
    <NoDiscountAllowed>false</NoDiscountAllowed>
              <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"StopSell="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="2" Date="2014-08-23" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="true"StopSell="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="3" Date="2014-08-24" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="true"StopSell="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="4" Date="2014-08-25" Price="200.00" MinStay="3" MaxStay="0" ValidCharge="true" IncludeChildInBase="false" IncludeInfantInBase="false" Flames="false" CanArriveToday="true" ClosedToArrival="false"StopSell="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"StopSell="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"StopSell="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" StopSell="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"StopSell="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>
              <NoDiscountAllowed>false</NoDiscountAllowed>
              <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"StopSell="false" 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 Request

    <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"StopSell="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>
              <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" StopSell="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" StopSell="false"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" StopSell="false"PersonBase="2" ChildBase="0" InfantBase="0">
                <AdditionalGuests />
              </Charge>
            </ChargeType>
          </ChargeTypes>
        </RoomType>
      </RoomTypes>
    </RMSAvailRateChartRS>


    Example Response - Multiple Requests

    <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>







    Was this article helpful?

    Send Feedback

    Can’t find what you’re looking for?

    Our team of RMS experts are here for you!

    Submit a Question