1.1 Property Details Request and Response
Overview
This article will take you through the elements of a Property Details Request and Response.
Feature
The property details request allows you to call for property information including property name, address, star rating, terms and conditions etc.
Request Elements
| Element Name | Parent Element | Element Description | Attributes | Required |
|---|---|---|---|---|
| RMSPropertyRQ | Root Element | Version - document version of the response schema | Yes | |
| Requests | RMSPropertyRQ | 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 | RMSPropertyRQ -or- Request | The agent code of the RMS Agent enquiring. | Yes | |
| RMSClientId | RMSPropertyRQ -or- Request | The RMS ClientId of the property being searched. | Yes | |
| ReturnAllProperties | RMSPropertyRQ -or- Request | For multi-prop users. Returns all sub properties within an RMS setup. | No | |
| Test | RMSPropertyRQ -or- Request | Optional element. If present, point to the test data for a property. | No |
Example Request
<RMSPropertyRQ>
<AgentId>1</AgentId>
<RMSClientId>3038</RMSClientId>
</RMSPropertyRQ>
Example Request - Multiple Requests
<RMSPropertyRQ>
<Requests>
<Request>
<AgentId>1</AgentId>
<RMSClientId>3038</RMSClientId>
</Request>
<Request>
<AgentId>1</AgentId>
<RMSClientId>3038</RMSClientId>
</Request>
</Requests>
</RMSPropertyRQ>
Response Elements
| Element Name | Parent Element | Element Description | Attributes |
|---|---|---|---|
| RMSPropertyRS | Root element | Version - document version of the response schema | |
| Responses | RMSPropertyRS | Optional wrapping element for having multiple property responses in one call. | |
| Response | Responses | Optional wrapping element for having multiple property responses in one call. | |
| Properties | RMSPropertyRS -or- Response | Properties container | |
| Property | Properties | Property element | |
| RMSClientId | Property | The RMS ClientId of the property being searched | |
| SubPropertyId | Property | The identifier of the sub property | |
| Name | Property | The name of the property | |
| GAC | Property | Google analytics code | |
| Manual | Property | RMS use only. | |
| RMSVersion | Property | Property's RMS version | |
| Beta | Property | RMS use only. | |
| UseCategoryDefaultTimes | Property | If the property is using category default times. | True/False element |
| DateOfNow | Property | Date/Time of now for call | |
| AllowGroupBookings | Property | MaxGroupBookings = the maximum number of areas that can be booking in one online booking. | |
| PropertyDetails | Property | Specific details of the property | |
| Description | PropertyDetails | Property long description | |
| Features | PropertyDetails | Property features | |
| Directions | PropertyDetails | Directions to property | |
| Terms | PropertyDetails | Property terms & conditions | |
| StarRating | PropertyDetails | The star rating of the property | |
| StarRatingType | PropertyDetails | Whom it was rated by | |
| Gateway | PropertyDetails | RMS use only. | |
| MerchantName | PropertyDetails | Property merchant name | |
| BusinessFacilities | PropertyDetails | Any facilities listed by the property | |
| CarParking | PropertyDetails | Car parking details | |
| CancellationPolicy | PropertyDetails | Property cancellation policy | |
| MaxChildAge | PropertyDetails | Max age of children allowed | |
| MaxInfantAge | PropertyDetails | Max age of infants allowed | |
| ThingsToDo | PropertyDetails | Any local activities | |
| ExtraGuests | PropertyDetails | Extra guest policies | |
| DefArriveTime | PropertyDetails | Default time of arrival | |
| DefDepartTime | PropertyDetails | Default time of departure | |
| CurrencySymbol | PropertyDetails | Default currency symbol of the property | |
| Currency | PropertyDetails | Default currency of the property | |
| RedirectionURL | PropertyDetails | RMS use only. | |
| TaxExclusive | PropertyDetails | RMS use only. | |
| ContactDetails | Property | Contains property contact details | |
| Address1 | ContactDetails | Property address 1 field | |
| Address2 | ContactDetails | Property address 2 field | |
| State | ContactDetails | Property state field | |
| Postcode | ContactDetails | Property postcode field | |
| Country | ContactDetails | Property country field | |
| Phone | ContactDetails | Property phone field | |
| Fax | ContactDetails | Property fax field | |
| ContactDetails | Property email field | ||
| URL | ContactDetails | Property URL field | |
| Images | Property | Contains location of property images | |
| Image | Images | Specific property image path | |
| Labels | Property | Contains any renamable labels of the property | |
| Label | Labels | Contains the value to use in replacement of the type | Type = The type of label including; Area Infant RoomType Tariff Guest Town Postcode Res Note |
| ManditoryFields | Property | Contains fields that should be mandatory from guests in order to make a booking | |
| BookingSource | ManditoryFields | True/False manditory field | |
| Town | ManditoryFields | True/False manditory field | |
| State | ManditoryFields | True/False manditory field | |
| Postcode | ManditoryFields | True/False manditory field | |
| Country | ManditoryFields | True/False manditory field | |
| Addr1 | ManditoryFields | True/False manditory field | |
| Addr2 | ManditoryFields | True/False manditory field | |
| Phone | ManditoryFields | True/False manditory field | |
| Mobile | ManditoryFields | True/False manditory field | |
| Deposits | Property | Contains the rules for booking deposit amounts | |
| Currencies | Property | Contains the currencies accepted | |
| Currency | Currencies | Currency accepted by the property. | |
| ID | Currency | Currency identifier | |
| Symbol | Currency | Currency Symbol | |
| Name | Currency | Currency Name | |
| Description | Currency | Currency long description | |
| BookingSources | Property | Contains booking source options for a booking | |
| BookingSource | BookingSources | A specified booking source from the property | |
| Id | BookingSource | Booking souce identifier | |
| Name | BookingSource | The name of the booking source | |
| Additionals | Property | Contains additional stay options such as pets etc. | Id = Additional identifier E.g. <Additional Id="1">Pets</Additional> |
| Additional | Additionals | The name of the specified additional | E.g. <Additional Id="1">Pets</Additional> |
| Attributes | Property | Contains attributes that can be assigned to room types | |
| Attribute | Attributes | A room type attribute | |
| Id | Attribute | Attribute identifier | |
| Name | Attribute | The name of the attribute | |
| Cards | Property | Contains all accepted cards from the property | |
| Card | Cards | The name of the specified credit card | |
| Requirements | Property | 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. | |
| ExcludeAmountFromDeposit | Requirement | Should the Requirement Amount be Excluded from the Deposit Calculation | |
| Amount | Requirement | The cost of this requirement, if added to the booking | |
| ResTypes | Property | Contains Res types to add to a booking | |
| ResType | ResTypes | The specified Res Type | |
| Id | ResType | Res type identifier | |
| Name | ResType | The name of the Res type | |
| SubResTypes | ResType | Contains the Sub Res types to add to a booking | |
| SubResType | SubResTypes | The specified Sub Res type | |
| Id | SubResType | Sub res type identifier | |
| Name | SubResType | The name of the Sub Res type | |
| RVTypes | Property | Contains the RV Types to add to a booking | |
| RVType | RVTypes | Id = RVType identifier Name = RVType Description | |
| RVLengths | Property | Contains the RV Lengths to add to a booking | |
| RVLength | RVLengths | Id = RVLength identifier Name = RVLength Description | |
| SlideOuts | Property | Contains the SlidOuts to add to a booking | |
| SlideOut | SlideOuts | Id = SlideOut identifier Name = SlideOut Description |
Example Response
<RMSPropertyRS Version="1">
<Properties>
<Property>
<RMSClientId>3038</RMSClientId>
<SubPropertyId>1</SubPropertyId>
<Name>Mexican Shores</Name>
<GAC>UA-7221640-4</GAC>
<Manual>false</Manual>
<RMSVersion>8.11.872</RMSVersion>
<Beta>0</Beta>
<UseCategoryDefaultTimes>false</UseCategoryDefaultTimes>
<DateOfNow>2014-08-05T00:00:00+10:00</DateOfNow>
<AllowGroupBookings MaxGroupBookings="2" />
<PropertyDetails>
<Description>A short description of the property - RMS Test Property.
Testing Layout</Description>
<Features>Explain features about the property - RMS Test Property.
Testing Layout</Features>
<Directions>Provides Travel Directions for guests. - RMS Test Property.
Testing Layout</Directions>
<Terms>Outlines the properties Terms and Conditions for online bookings - RMS Test Property. Hello.
Testing Layout</Terms>
<StarRating>4.5</StarRating>
<StarRatingType>Self Rated</StarRatingType>
<Gateway>4</Gateway>
<MerchantName></MerchantName>
<BusinessFacilities>Outlines what Business Facilities are available at the property. - RMS Test Property.
Testing Layout</BusinessFacilities>
<CarParking>Explains Car Parking facilities to guests. - RMS Test Property.
Testing Layout</CarParking>
<CancellationPolicy>Outlines the properties Cancellation Policy. - RMS Test Property.
Testing Layout</CancellationPolicy>
<MaxChildAge>10</MaxChildAge>
<MaxInfantAge>2</MaxInfantAge>
<ThingsToDo>Outlines things to do at the property. - RMS Test Property.
Testing Layout</ThingsToDo>
<ExtraGuests></ExtraGuests>
<DefArriveTime>16:00:00</DefArriveTime>
<DefDepartTime>10:00:00</DefDepartTime>
<CurrencySymbol>$</CurrencySymbol>
<Currency>AUD</Currency>
<RedirectionURL>www.rms.com.au</RedirectionURL>
</PropertyDetails>
<ContactDetails>
<Address1>116 Harrick Rd</Address1>
<Address2>KEILOR PARK</Address2>
<State>VIC</State>
<Postcode>3042</Postcode>
<Country>Australia</Country>
<Phone>+61 3 8399 9462</Phone>
<Fax>+61 3 9331 7323</Fax>
<Email>[email protected]</Email>
<URL>www.rms.com.au</URL>
</ContactDetails>
<Images>
<Image>https://bookings.rms.com.au/rmsoimag...5dad7bd505.jpg</Image>
<Image>https://bookings.rms.com.au/rmsoimag...358f16f30e.jpg</Image>
</Images>
<Labels>
<Label Type="Area">Site</Label>
<Label Type="Infant">Infant</Label>
<Label Type="RoomType">Site Type</Label>
<Label Type="Tariff">Tariff</Label>
<Label Type="Guest">Guest</Label>
<Label Type="Town">Town</Label>
<Label Type="Postcode">Post Code</Label>
<Label Type="Notes">Res Note</Label>
</Labels>
<ManditoryFields>
<BookingSource>false</BookingSource>
<Town>false</Town>
<State>false</State>
<Postcode>true</Postcode>
<Country>false</Country>
<Addr1>false</Addr1>
<Addr2>false</Addr2>
<Phone>false</Phone>
<Mobile>false</Mobile>
</ManditoryFields>
<Currencies>
<Currency>
<ID>5</ID>
<Symbol>$</Symbol>
<Name>AUD</Name>
<Description>Australian Dollars (AUD)</Description>
</Currency>
<Currency>
<ID>16</ID>
<Symbol>£</Symbol>
<Name>GBP</Name>
<Description>Great Britain Pounds (GBP)</Description>
</Currency>
<Currency>
<ID>56</ID>
<Symbol>R</Symbol>
<Name>INR</Name>
<Description>Indian Rupee (INR)</Description>
</Currency>
<Currency>
<ID>42</ID>
<Symbol>€</Symbol>
<Name>EUR</Name>
<Description>Euro (EUR)</Description>
</Currency>
<Currency>
<ID>92</ID>
<Symbol>$</Symbol>
<Name>NZD</Name>
<Description>New Zealand Dollars (NZD)</Description>
</Currency>
<Currency>
<ID>7</ID>
<Symbol>B</Symbol>
<Name>BHD</Name>
<Description>Bahraini Dinar (BHD)</Description>
</Currency>
<Currency>
<ID>139</ID>
<Symbol>D</Symbol>
<Name>AED</Name>
<Description>United Arab Emirates Dirhams (AED)</Description>
</Currency>
<Currency>
<ID>61</ID>
<Symbol>¥</Symbol>
<Name>JPY</Name>
<Description>Japan Yen (JPY)</Description>
</Currency>
<Currency>
<ID>138</ID>
<Symbol>$</Symbol>
<Name>USD</Name>
<Description>United States Dollar (USD)</Description>
</Currency>
</Currencies>
<BookingSources>
<BookingSource>
<Id>3</Id>
<Name>Getaway</Name>
</BookingSource>
</BookingSources>
<Additionals>
<Additional Id="1">Pets</Additional>
<Additional Id="2">Cat</Additional>
<Additional Id="3">Dog</Additional>
<Additional Id="4">Bird</Additional>
<Additional Id="5">Hamster</Additional>
<Additional Id="6">Snake</Additional>
</Additionals>
<Attributes>
<Attribute>
<Id>1</Id>
<Name>City View</Name>
</Attribute>
<Attribute>
<Id>2</Id>
<Name>Park View</Name>
</Attribute>
</Attributes>
<Cards>
<Card>Visa</Card>
<Card>Mastercard</Card>
</Cards>
<Requirements>
<Requirement>
<Id>2</Id>
<Name>Full Breakfast</Name>
<Quantity>1</Quantity>
<Sundry_Id>3</Sundry_Id>
<Housekeeping_Requirement>0</Housekeeping_Requirement>
<Required_Daily>1</Required_Daily>
<ChargeRequiredDaily>0</ChargeRequiredDaily>
<Note>Enjoy our menu selections including The Big Breakfast!</Note>
<Order>3</Order>
<Tax>0</Tax>
<ExcludeAmountFromDeposit>false</ExcludeAmountFromDeposit>
<Amount>25</Amount>
</Requirement>
<Requirement>
<Id>3</Id>
<Name>Newspaper</Name>
<Quantity>1</Quantity>
<Sundry_Id>1</Sundry_Id>
<Housekeeping_Requirement>0</Housekeeping_Requirement>
<Required_Daily>1</Required_Daily>
<ChargeRequiredDaily>0</ChargeRequiredDaily>
<Note>Daily Newspaper Delivery.</Note>
<Order>1</Order>
<Tax>0</Tax>
<ExcludeAmountFromDeposit>true</ExcludeAmountFromDeposit>
<Amount>1.2</Amount>
</Requirement>
</Requirements>
<ResTypes>
<ResType>
<Id>4</Id>
<Name>Corporate</Name>
<SubResTypes>
<SubResType>
<Id>5</Id>
<Name>Direct</Name>
</SubResType>
<SubResType>
<Id>6</Id>
<Name>Travel Agent</Name>
</SubResType>
</SubResTypes>
</ResType>
</ResTypes>
<RVTypes>
<RVType Id="4" Name="Caravan" />
<RVType Id="3" Name="RV" />
<RVType Id="5" Name="Storage" />
</RVTypes>
<RVLengths>
<RVLength Id="4" Name="> 15"" />
<RVLength Id="5" Name="> 25"" />
<RVLength Id="6" Name="> 35"" />
<RVLength Id="7" Name="> 45"" />
<RVLength Id="8" Name="10"" />
</RVLengths>
<SlideOuts>
<SlideOut Id="0" Name="NONE" />
<SlideOut Id="1" Name="LEFT" />
<SlideOut Id="2" Name="RIGHT" />
<SlideOut Id="3" Name="LEFT AND RIGHT" />
</SlideOuts>
</Property>
</Properties>
</RMSPropertyRS>
Example Response - Multiple Responses
<RMSPropertyRS Version="1.0.1.5">
<Responses>
<Response>
<RMSClientId>3038</RMSClientId>
... (extra information removed to save space)
</Property>
</Properties>
</Response>
<Response>
<Properties>
<Property>
<RMSClientId>3038</RMSClientId>
<SubPropertyId>1</SubPropertyId>
<Name>Mexican Shores</Name>
... (extra information removed to save space)
</Property>
</Properties>
</Response>
</Responses>
</RMSPropertyRS>
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.2 Room Type Details Request and Response
- This article will take you through the elements of a Room Type 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