1.2 Room Type Details Request and Response
Overview
This article will take you through the elements of a Room Type Request and Response.
Feature
The room type request allows you to call for information about the room types the property has allocated for use including name, description, max occupants, default arrival and departure times etc.
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 | RoomType | Contains a specific list of sub properties of which to return its underlying room types. | No | |
| SubProperty | RoomType | The specified sub property. | No | |
| SubPropertyId | RoomType | 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 Room Type
<RMSRoomTypeRQ>
<AgentId>1</AgentId>
<RMSClientId>3038</RMSClientId>
<RoomTypes>
<RoomType>
<RoomTypeId>1</RoomTypeId>
</RoomType>
</RoomTypes>
</RMSRoomTypeRQ>
Example Request Using ShowAreas
<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. | |
| 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. | |
| MaxOccupancy | RoomType | The max number of guests allowed in this room type. | |
| DefaultArrival | RoomType | The default arrival time for this room type. | |
| DefaultDeparture | RoomType | The default departure time 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. | |
| 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. | |
| Attributes | Area | Contains all attributes assigned to this Area. | |
| Attribute | Attributes | The specified attribute. | |
| Id | Attribute | The identifier of the attribute. | |
| Name | Attribute | The name of the attribute. |
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/RMSOImag...a3b59e3c43.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/RMSOImag...e3b38f1375.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 Room Type
<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/RMSOImag...a3b59e3c43.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 ShowAreas
<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/RMSOImag...a3b59e3c43.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>
<Areas>
<Area>
<AreaId>5</AreaId>
<Name>05</Name>
</Area>
<Area>
<AreaId>6</AreaId>
<Name>06</Name>
</Area>
<Area>
<AreaId>7</AreaId>
<Name>07</Name>
</Area>
<Area>
<AreaId>8</AreaId>
<Name>08</Name>
</Area>
</Areas>
</RoomType>
</RoomTypes>
</RMSRoomTypeRS>
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.3 Availability Rates Request and Response
- This article will take you through the elements of a Availability / Rates 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.
Classifications
- © Copyright 2015 RMS