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.


    Room Type Details Request & Response for the Online API

    Information on the Category Details Request & Response for the RMS Online API.

    The Room Type request allows for calling information about the Categories the property has allocated for use including the Category Name, Description, Max Occupants, Default Arrival & Departure times etc.

    Info

    Data returned by this response is primarily static. RMS recommends caching this data locally for best performance.


    Request Elements

    Element Name Parent Element Element Description Attributes Required
    RMSRoomTypeRQ   Root element Version - document version of the response schema Yes
    AgentId RMSRoomTypeRQ The agent code of the RMS agent enquiring.   Yes
    RMSClientId RMSRoomTypeRQ The RMS Client Id of the property being searched.   Yes
    RoomTypes RMSRoomTypeRQ Contains a specific list of room types to return.   No
    RoomType RoomTypes The specified room type   No
    RoomTypeId RoomType The identifier of the room type to return.   No
    SubProperties RMSRoomTypeRQ Contains a specific list of sub properties of which to return its underlying room types.   No
    SubProperty SubProperties The specified sub property.   No
    SubPropertyId (Attribute) SubProperty The identifier of the sub property.   No
    Test RMSRoomTypeRQ Optional element.  If present, points to the test data for a property.   No
    ShowAreas RMSRoomTypeRQ Optional element.  If present, show the area detail of each room type   No


    Example Request - Required Only

    <RMSRoomTypeRQ>
      <AgentId>1</AgentId>
      <RMSClientId>3038</RMSClientId>
    </RMSRoomTypeRQ>


    Example Request - Including Category

    <RMSRoomTypeRQ>
      <AgentId>1</AgentId>
      <RMSClientId>3038</RMSClientId>
    <SubProperties>
            <SubProperty SubPropertyId = "1"></SubProperty>
        </SubProperties>
      <RoomTypes>
         <RoomType>
           <RoomTypeId>1</RoomTypeId>
         </RoomType>
      </RoomTypes>
    </RMSRoomTypeRQ>


    Example Request - Using Show Areas

    <RMSRoomTypeRQ>
      <AgentId>1</AgentId>
      <RMSClientId>3038</RMSClientId>
      <RoomTypes>
         <RoomType>
           <RoomTypeId>2</RoomTypeId>
         </RoomType>
      </RoomTypes>
      <ShowAreas/>
    </RMSRoomTypeRQ>


    Response Elements

    Element Name Parent Element Element Description Attributes
    RMSRoomTypeRS   Root element.  Containing the response to a room type request. Version - document version of the response schema.
    RoomTypes RMSRoomTypeRS Contains the returned room types for the property.  
    RoomType RoomTypes The specified room type.  
    RoomTypeId RoomType The identifier of the room type.  
    RoomTypeGroupId Room Type    
    SubPropertyId RoomType The sub property the room belongs to.  
    Name RoomType The name of the room type.  
    Description RoomType The long description of the room type.  
    Notes RoomType

    Notes associated with the room 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.

     
    MaxOccupancy RoomType The max number of guests allowed Per Room.  
    DefaultArrival RoomType The default arrival time for this room type.  
    DefaultDeparture RoomType The default departure time for this room type.  
    NoOfFullBaths RoomType Number of Full Baths for this Room Type  
    NoOfHalfBaths RoomType Number of Half Baths for this Room Type  
    NoOfShowers RoomType Number of Showers for this room type  
    Attributes RoomType Contains all attributes assigned to this room type.  
    Attribute Attributes The specified attribute.  
    Id Attribute The identifier of the attribute.  
    Name Attribute The name of the attribute.  
    Images RoomType Contains a list of images relative to the room type.
    Image Images A thumbnail image representing the room type.  
    Image Caption Images Display Order  
    Requirements RoomType Contains requirements that can be added to a booking.  
    Requirement Requirements The specified requirement.  
    Id Requirement Requirement identifier.  
    Name Requirement The name of the requirement.  
    Quantity Requirement Quantity of the requirement.  
    Sundry_Id Requirement The sundry identity that is assosiated to this requirement.  
    Housekeeping_Requirement Requirement RMS use only.  
    Required_Daily Requirement RMS use only.  
    ChargeRequiredDaily Requirement RMS use only.  
    Note Requirement RMS use only.  
    Order Requirement RMS use only.  
    Tax Requirement RMS use only.  
    Amount Requirement The cost of this requirement if added to the booking.  
    Areas RoomType Contains the returned areas for the room type.  
    Area Areas The specified area.  
    AreaId Area The identifier for the area.  
    Name Area The name of the area.  

    Address

    Area The address of the Area  
    Addr1 Area Address Line 1  
    Addr2 Area Address Line 2  
    Addr3 Area Address Line 3  
    Town Area Town  
    State Area State  
    PostCode Area Postcode  
    Latitude Area Latitude  
    Longitude Area Longitude  
    NoOfFullBaths Area Number of Full Baths

     

    NoOfHalfBaths Area Number of Half Baths  
    NoOfShowers Area Number of Showers  
    NoOfBedrooms Area Number of Bedrooms  
    SmokingAllowed Area Smoking Allowed

    0 = Not Set

    1 = Yes

    2 = No

    PetsAllowed Area Pets Allowed

    0 = Not Set

    1 = Yes

    2 = No

    ChildrenAllowed Area Children Allowed

    0 = Not Set

    1 = Yes

    2 = No

    Attributes Area Contains all attributes assigned to this Area.  
    Attribute Area The specified attribute.  
    Id Area The identifier of the attribute.  
    Name Area The name of the attribute.  
    Images Area Contains a list of images relative to the Area.
    Eg.
    <Image Caption="" DisplayOrder="1">https://bookings.rmscloud.com/rmsoimages/3038/rmswin/rmsonlineimages/00000018.jpg</Image>
    Image Area A thumbnail image representing the Area  
    ImageCaption Area Display Order


    Example Response - Required Only

    <RMSRoomTypeRS Version="1">
      <RoomTypes>
        <RoomType>
          <RoomTypeId>2</RoomTypeId>
          <SubPropertyId>1</SubPropertyId>
          <Name>Studio</Name>
          <Description>Comfortable and Contemperary Studio Apartment, boasting fantastic ocean views.</Description>
          <MaxOccupancy>4</MaxOccupancy>
          <DefaultArrival>29/11/2012 4:00:00 PM</DefaultArrival>
          <DefaultDeparture>29/11/2012 11:00:00 AM</DefaultDeparture>
          <Attributes>
            <Attribute>
              <Id>1</Id>
              <Name>Ocean View</Name>
            </Attribute>
          </Attributes>
          <Images>
            <Image>https://bookings.rms.com.au/RMSOImages/3038/RMSWIN/RMSOnlineImages/873b293a-904d-46b2-9caf-e3a3b59e3c43.jpg</Image>
          </Images>
          <Requirements>
            <Requirement>
              <Id>1</Id>
              <Name>Stefanos Cafe / Bakery Breakfast</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>5</Sundry_Id>
              <Housekeeping_Requirement>0</Housekeeping_Requirement>
              <Required_Daily>1</Required_Daily>
              <ChargeRequiredDaily>1</ChargeRequiredDaily>
              <Note>Enjoy a fully cooked breakfast of your choice from selected menu and a tea, coffee or juice.</Note>
              <Order>0</Order>
              <Tax>0</Tax>
              <Amount>1.2000</Amount>
            </Requirement>
            <Requirement>
              <Id>5</Id>
              <Name>Pet in Cabin</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>3</Sundry_Id>
              <Housekeeping_Requirement>1</Housekeeping_Requirement>
              <Required_Daily>0</Required_Daily>
              <ChargeRequiredDaily>0</ChargeRequiredDaily>
              <Note></Note>
              <Order>0</Order>
              <Tax>2</Tax>
              <Amount>15.0000</Amount>
            </Requirement>
          </Requirements>
        </RoomType>
        <RoomType>
          <RoomTypeId>3</RoomTypeId>
          <SubPropertyId>1</SubPropertyId>
          <Name>One Bedroom</Name>
          <Description>Spacious One Bedroom apartment, with gorgeous garden views.</Description>
          <MaxOccupancy>2</MaxOccupancy>
          <DefaultArrival>29/11/2012 12:00:00 AM</DefaultArrival>
          <DefaultDeparture>29/11/2012 12:00:00 AM</DefaultDeparture>
          <Attributes>
            <Attribute>
              <Id>2</Id>
              <Name>Garden View</Name>
            </Attribute>
          </Attributes>
          <Images>
            <Image>https://bookings.rms.com.au/RMSOImages/3038/RMSWIN/RMSOnlineImages/b5c40ce6-4705-4cbe-969f-bce3b38f1375.jpg</Image>
          </Images>
          <Requirements>
            <Requirement>
              <Id>1</Id>
              <Name>Stefanos Cafe / Bakery Breakfast</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>5</Sundry_Id>
              <Housekeeping_Requirement>0</Housekeeping_Requirement>
              <Required_Daily>1</Required_Daily>
              <ChargeRequiredDaily>1</ChargeRequiredDaily>
              <Note>Enjoy a fully cooked breakfast of your choice from selected menu and a tea, coffee or juice.</Note>
              <Order>0</Order>
              <Tax>0</Tax>
              <Amount>1.2000</Amount>
            </Requirement>
            <Requirement>
              <Id>5</Id>
              <Name>Pet in Cabin</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>3</Sundry_Id>
              <Housekeeping_Requirement>1</Housekeeping_Requirement>
              <Required_Daily>0</Required_Daily>
              <ChargeRequiredDaily>0</ChargeRequiredDaily>
              <Note></Note>
              <Order>0</Order>
              <Tax>2</Tax>
              <Amount>15.0000</Amount>
            </Requirement>
          </Requirements>
        </RoomType>
      </RoomTypes>
    </RMSRoomTypeRS>


    Example Response - Including Category

    <RMSRoomTypeRS Version="1">
      <RoomTypes>
        <RoomType>
          <RoomTypeId>2</RoomTypeId>
          <SubPropertyId>1</SubPropertyId>
          <Name>Studio</Name>
          <Description>Comfortable and Contemperary Studio Apartment, boasting fantastic ocean views.</Description>
          <MaxOccupancy>4</MaxOccupancy>
          <DefaultArrival>29/11/2012 4:00:00 PM</DefaultArrival>
          <DefaultDeparture>29/11/2012 11:00:00 AM</DefaultDeparture>
          <Attributes>
            <Attribute>
              <Id>1</Id>
              <Name>Ocean View</Name>
            </Attribute>
          </Attributes>
          <Images>
            <Image>https://bookings.rms.com.au/RMSOImages/3038/RMSWIN/RMSOnlineImages/873b293a-904d-46b2-9caf-e3a3b59e3c43.jpg</Image>
          </Images>
          <Requirements>
            <Requirement>
              <Id>1</Id>
              <Name>Stefanos Cafe / Bakery Breakfast</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>5</Sundry_Id>
              <Housekeeping_Requirement>0</Housekeeping_Requirement>
              <Required_Daily>1</Required_Daily>
              <ChargeRequiredDaily>1</ChargeRequiredDaily>
              <Note>Enjoy a fully cooked breakfast of your choice from selected menu and a tea, coffee or juice.</Note>
              <Order>0</Order>
              <Tax>0</Tax>
              <Amount>1.2000</Amount>
            </Requirement>
            <Requirement>
              <Id>5</Id>
              <Name>Pet in Cabin</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>3</Sundry_Id>
              <Housekeeping_Requirement>1</Housekeeping_Requirement>
              <Required_Daily>0</Required_Daily>
              <ChargeRequiredDaily>0</ChargeRequiredDaily>
              <Note></Note>
              <Order>0</Order>
              <Tax>2</Tax>
              <Amount>15.0000</Amount>
            </Requirement>
          </Requirements>
        </RoomType>
      </RoomTypes>
    </RMSRoomTypeRS>


    Example Response - Using Show Areas

    <RMSRoomTypeRS Version="1.0.1.21">
      <RoomTypes>
        <RoomType>
          <RoomTypeId>5</RoomTypeId>
          <RoomTypeGroupId>0</RoomTypeGroupId>
          <SubPropertyId>1</SubPropertyId>
          <Name>Deluxe Queen</Name>
          <Description>This is the long description of this category ... which is still the wrong place to be! aaghh</Description>
          <MaxOccupancy>0</MaxOccupancy>
          <DefaultArrival>00:00</DefaultArrival>
          <DefaultDeparture>00:00</DefaultDeparture>
          <NoOfFullBaths>1</NoOfFullBaths>
          <NoOfHalfFullBaths>1</NoOfHalfFullBaths>
          <NoOfShowers>2</NoOfShowers>
          <Attributes>
            <Attribute>
              <Id>3</Id>
              <Name>Minibar</Name>
            </Attribute>
          </Attributes>
          <Images>
            <Image Caption="" DisplayOrder="1">https://bookings.rmscloud.com/rmsoimages/3038/rmswin/rmsonlineimages/00000018.jpg</Image>
            <Image Caption="" DisplayOrder="2">https://bookings.rmscloud.com/rmsoimages/3038/rmswin/rmsonlineimages/00000023.jpg</Image>
            <Image Caption="" DisplayOrder="3">https://bookings.rmscloud.com/rmsoimages/3038/rmswin/rmsonlineimages/00000038.jpg</Image>
          </Images>
     <Requirements>
            <Requirement>
              <Id>24</Id>
              <Name>Champagne and Chocolates on Arrival</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>2</Sundry_Id>
              <Housekeeping_Requirement>false</Housekeeping_Requirement>
              <Required_Daily>false</Required_Daily>
              <ChargeRequiredDaily>false</ChargeRequiredDaily>
              <Note>Testing</Note>
              <Order>2</Order>
              <Amount>25</Amount>
            </Requirement>
            <Requirement>
              <Id>6</Id>
              <Name>Late Check-Out Noon</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>1</Sundry_Id>
              <Housekeeping_Requirement>true</Housekeeping_Requirement>
              <Required_Daily>false</Required_Daily>
              <ChargeRequiredDaily>false</ChargeRequiredDaily>
              <Note></Note>
              <Order>0</Order>
              <Amount>20.0000</Amount>
            </Requirement>
            <Requirement>
              <Id>15</Id>
              <Name>Rollaway</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>1</Sundry_Id>
              <Housekeeping_Requirement>true</Housekeeping_Requirement>
              <Required_Daily>true</Required_Daily>
              <ChargeRequiredDaily>true</ChargeRequiredDaily>
              <Note></Note>
              <Order>0</Order>
              <Amount>10.0000</Amount>
            </Requirement>
          </Requirements>
    <Areas>
            <Area>
              <AreaId>15</AreaId>
              <Name>A King Split</Name>
              <Address>
                <Addr1>116 Harrick Road</Addr1>
                <Addr2></Addr2>
                <Addr3></Addr3>
                <Town>Keilor Park</Town>
                <State>VIC</State>
                <PostCode>3042</PostCode>
              </Address>
              <Latitude>49 N</Latitude>
              <Longitude>100 E</Longitude>
              <NoOfFullBaths>1</NoOfFullBaths>
              <NoOfHalfFullBaths>1</NoOfHalfFullBaths>
              <NoOfShowers>2</NoOfShowers>
    <NoOfBedrooms>3</NoOfBedrooms>
              <SmokingAllowed>2</SmokingAllowed>
              <PetsAllowed>2</PetsAllowed>
              <ChildrenAllowed>1</ChildrenAllowed>
              <Attributes />
              <Images />
            </Area>
            <Area>
    <AreaId>16</AreaId>
              <Name>B</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>17</AreaId>
              <Name>C</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>18</AreaId>
              <Name>D</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>19</AreaId>
              <Name>E</Name>
              <Address>
                <Addr1>Address1 field</Addr1>
                <Addr2>ddress2 field</Addr2>
                <Addr3>Address3 field</Addr3>
                <Town>town field</Town>
                <State>State Field</State>
                <PostCode>PostCode</PostCode>
              </Address>
              <Latitude></Latitude>
              <Longitude></Longitude>
              <NoOfFullBaths>0</NoOfFullBaths>
              <NoOfHalfFullBaths>0</NoOfHalfFullBaths>
              <NoOfShowers>0</NoOfShowers>
              <SmokingAllowed>0</SmokingAllowed>
              <PetsAllowed>0</PetsAllowed>
              <ChildrenAllowed>0</ChildrenAllowed>
              <Attributes />
              <Images />
            </Area>
            <Area>
             <AreaId>20</AreaId>
              <Name>F</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>21</AreaId>
              <Name>G</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>107</AreaId>
              <Name>H</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>108</AreaId>
              <Name>I</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>109</AreaId>
              <Name>J</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>110</AreaId>
              <Name>K</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>111</AreaId>
              <Name>L</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>112</AreaId>
              <Name>M</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>113</AreaId>
              <Name>N</Name>
              <Attributes />
              <Images />
            </Area>
            <Area>
              <AreaId>114</AreaId>
              <Name>O</Name>
              <Attributes />
              <Images />
            </Area>
          </Areas>
        </RoomType>
      </RoomTypes>
    </RMSRoomTypeRS>





    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