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.


    Property Details Request & Response for the Online API

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

    The Property Details Request allows for calling property information including the property name, address and star rating as well as the Property's Terms & Conditions.

    Info

    Property Details Responses are primarily static data. RMS recommends caching this data locally for best performance.



    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
    IncludeDiscounts RMSPropertyRQ -or- Request
    Returns all Discounts added to the Property requested. True/False. No


    Example Request

    <RMSPropertyRQ>
      <AgentId>1</AgentId>
      <RMSClientId>3038</RMSClientId>
      <IncludeDiscounts>true</IncludeDiscounts>
    </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 RMSClientId 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.
    MaxAdults Property    
    MaxChildren Property    
    MaxPets Property    
    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  
    PetPolicy PropertyDetails Property pet 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.  
    Latitude PropertyDetails Property latitude  
    Longitude PropertyDetails Property Longitude  
    SmokingAllowed PropertyDetails Property smoking allowed  
    PetsAllowed PropertyDetails Property pets allowed  
    ChildrenAllowed PropertyDetails Property children allowed  
    MinAgeRequiredToBook PropertyDetails Property minimum age required to make an online booking  
    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  
    Email 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

    Spare1

    Spare2

    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  
    PaymentGateways Property Contains Payment Gatways setup for Property  
    ID PaymentGateways Gateway Enum

    0 = NotSet

    1 = eMatters

    2 = SagePay

    3 = XCharge

    4 = PaymentExpress (DPS)                      

    5 = TGate (BridgePay)                            

    6 = PayPal

    7 = RMS

    8 = HDFCBank                            

    9 = BrainTree

    10 = GKSolutions

    11 = CBA

    12 = Stripe

    Name PaymentGateways Gateway 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 E.g. <Card>Visa</Card>
           <Card>Mastercard</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  
    Validations Requirement Contains validation rules for requirements that can be added to a booking  
    DateMadeFrom Validations Specific Date for Res Made From  
    DateMadeTo Validations Specific Date for Res Made To  
    ResCrossingFrom Validations Spepcific Date for Res Crossing From  
    ResCrossingTo Validations Specific Date for Res Crossing To  
    ArrivingOn Validations Day of the Week res must arrive on  
    Validations Requirement    
    Discounts Property Discount Name, ID, Description and Categories applicable to.
    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  

    E.g. <RVType Id="3" Name="Double decker" />

    RVLengths Property Contains the RV Lengths to add to a booking  
    RVLength RVLengths  

    E.g. <RVLength Id="1" Name="10&quot;" />

    SlideOuts Property Contains the SlidOuts to add to a booking  
    SlideOut SlideOuts  

    E.g. <SlideOut Id="0" Name="None" />
    <SlideOut Id="1" Name="Passenger" />
    <SlideOut Id="2" Name="Driver" />
    <SlideOut Id="3" Name="Driver And Passenger" />
           <SlideOut Id="4" Name="Rear" />

    Towings Property Contains the Towings to add to a booking  
    Towing Towing  

    E.g. <Towing Id="6" Description="Cargo Trailer" />


    Example Response

    <RMSPropertyRS Version="1.0.1.41">
      <Properties>
        <Property>
          <RMSClientId>6880</RMSClientId>
          <SubPropertyId>1</SubPropertyId>
          <Name>Rachels Ritzy Resort</Name>
         <GAC>UA-118261224-2</GAC>
          <Manual>false</Manual>
          <RMSVersion></RMSVersion>
          <Beta>false</Beta>
          <UseCategoryDefaultTimes>false</UseCategoryDefaultTimes>
          <DateOfNow>2019-04-15T00:00:00+10:00</DateOfNow>
          <AllowGroupBookings MaxGroupBookings="10" />
          <PropertyDetails>
            <Description>Rachel's Ritzy Resort is a class above the rest!!!</Description>
            <Features></Features>
            <Directions>Travel Directions for guests.
    For easiest access to the property the best route to follow to arrive safely is the most direct route which comes in from the south, as this is the only route which provides road access, although many of you may wish to take the scenic alternative.</Directions>
            <Terms>AFTER-HOURS ARRIVALS 
    Reception hours are from 8am to 6pm daily. If you are arriving outside of these hours, please contact the lodge at least 24 hours prior to 2pm on your arrival date to arrange an after-hours key collection.
    
    CHECK-IN POLICY
    The person who's name the room was booked under must be present and part of the travelling party staying at the lodge.
    
    THIRD PARTY PAYMENT POLICY
    If any room nights or additional charges are to be paid for by a third party, or anyone else other than the person who's name the booking was made under, the lodge must be notified more than 48 hours prior to 2pm on your arrival date.</Terms>
    
            <StarRating>4.5</StarRating>
            <StarRatingType>Self Rated</StarRatingType>
            <Gateway>4</Gateway>
            <MerchantName></MerchantName>
            <BusinessFacilities></BusinessFacilities>
            <CarParking>There is a charge for extra vehicles, daily parking and other space consuming devices which accompany travelers, except for those which are exempt from extra charges.</CarParking>
    <CancellationPolicy>CANCELLATION POLICY
    Cancellation is free of charge up to 48 hours prior to 2pm on your arrival date. Any booking modifications, including date changes and/or a full cancellation of your booking made within 48 hours of 2pm on your arrival date will incur a charge of the first night booked. Any booking modifications requested after check in must occur at least 48 hours prior to the change taking place to avoid any charges.
    
    NO SHOW POLICY
    Failure to arrive at the property, on the booked check-in date, will be treated as a no-show and will incur the first night charge. Please note the remainder of the booking will be cancelled.
    </CancellationPolicy>
    <PetPolicy>Those pets which have returned from the taxidermist and now exhibit none of their former feral aromas or lifestyle are most welcome.  These beasts must be restrained at all times and are not allowed outside at any time without close attentive supervision. </PetPolicy>
            <MaxChildAge>10</MaxChildAge>
            <MaxInfantAge>2</MaxInfantAge>
            <ThingsToDo>Outlines things to do at the property.</ThingsToDo>
            <ExtraGuests></ExtraGuests>
            <DefArriveTime>14:00:00</DefArriveTime>
            <DefDepartTime>10:00:00</DefDepartTime>
            <CurrencySymbol>$</CurrencySymbol>
            <Currency>AUD</Currency>
            <RedirectionURL></RedirectionURL>
            <Latitude></Latitude>
            <Longitude></Longitude>
            <SmokingAllowed>false</SmokingAllowed>
            <PetsAllowed>true</PetsAllowed>
            <ChildrenAllowed>false</ChildrenAllowed>
            <MinAgeRequiredToBook>0</MinAgeRequiredToBook>
          </PropertyDetails>
          <ContactDetails>
            <Address1>116 Harrick Road</Address1>
            <Address2>Keilor Park</Address2>
            <State>VIC</State>
            <Postcode>3042</Postcode>
            <Country>Australia</Country>
            <Phone>03 8399 9462</Phone>
            <Fax></Fax>
            <Email>[email protected]</Email>
            <URL>www.rms.com.au</URL>
          </ContactDetails>
          <Images>
            <Image Caption="" DisplayOrder="1">https://bookings2.rms.com.au/rmsoimages/6880/rmswin/rmsonlineimages/00000088.jpg</Image>
            <Image Caption="" DisplayOrder="2">https://bookings2.rms.com.au/rmsoimages/6880/rmswin/rmsonlineimages/00000090.jpg</Image>
          </Images>
          <Labels>
            <Label Type="Area">Area</Label>
            <Label Type="Infant">Infants</Label>
            <Label Type="RoomType">Room Type</Label>
            <Label Type="Tariff">Rate</Label>
            <Label Type="Guest">Guest</Label>
            <Label Type="Town">City</Label>
            <Label Type="Postcode">Post Code</Label>
            <Label Type="Notes">Booking Note</Label>
            <Label Type="Spare1">Spare1</Label>
            <Label Type="Spare11">Pre Auth</Label>
            <Label Type="lblClientSpare1">Parkbridge Id</Label>
            <Label Type="lblClientSpare13">Active +</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>42</ID>
              <Symbol>€</Symbol>
              <Name>EUR</Name>
              <Description>Euro (EUR)</Description>
            </Currency>
          </Currencies>
          <BookingSources>
            <BookingSource>
              <Id>24</Id>
              <Name>WEB</Name>
            </BookingSource>
          </BookingSources>
          <Additionals>
            <Additional Id="1">Pets +</Additional>
          </Additionals>
          <MaxAdults>5</MaxAdults>
          <MaxChildren>0</MaxChildren>
          <MaxPets>0</MaxPets>
          <Attributes>
            <Attribute>
              <Id>1</Id>
              <Name>City View</Name>
            </Attribute>
          </Attributes>
          <Cards>
            <Card>Visa</Card>
            <Card>Mastercard</Card>
          </Cards>
          <Requirements>
            <Requirement>
              <Id>510</Id>
              <Name>2 x King Beds</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>25</Sundry_Id>
              <Housekeeping_Requirement>False</Housekeeping_Requirement>
              <Required_Daily>False</Required_Daily>
              <ChargeRequiredDaily>0</ChargeRequiredDaily>
              <Note></Note>
              <Order>0</Order>
              <ExcludeAmountFromDeposit>false</ExcludeAmountFromDeposit>
              <Amount>5.00</Amount>
              <Tax>0.00</Tax>
              <SecondaryCurrency>
                <Amount>0.00</Amount>
                <Tax>0.00</Tax>
              </SecondaryCurrency>
            </Requirement>
          </Requirements>
          <ResTypes>
            <ResType>
              <Id>9</Id>
              <Name>Markets</Name>
              <SubResTypes>
                <SubResType>
                  <Id>25</Id>
                  <Name>Farmer's Market</Name>
                </SubResType>
              </SubResTypes>
          </ResTypes>
          <RVTypes>
            <RVType Id="4" Name="Caravan" />
            <RVType Id="6" Name="Huge" />
          </RVTypes>
          <RVLengths>
            <RVLength Id="15" Name="&gt; 10&quot;" />
            <RVLength Id="4" Name="&gt; 15&quot;" />
          </RVLengths>
          <SlideOuts>
            <SlideOut Id="0" Name="None" />
            <SlideOut Id="1" Name="Passenger" />
          </SlideOuts>
          <Towings>
            <Towing Id="11" Description="Cargo Trailer" />
            <Towing Id="12" Description="Large SUV/Truck" />
          </Towings>
          <RoomTypeGroupings>
            <RoomTypeGrouping Id="42" Description="House" />
          </RoomTypeGroupings>
        </Property>
      </Properties>
      <Discounts>
        <Discount>
          <Name>*Online*</Name>
          <Id>87</Id>
          <Description>Online Special</Description>
          <PropertyIds>1</PropertyIds>
          <CategoryIds>54,50,51,52,60,53,3,20,23,24,14,1,5,11,4,2</CategoryIds>
          <Validations>
            <Validation>
              <DateMadePermanent>true</DateMadePermanent>
              <ResCrossingPermanent>true</ResCrossingPermanent>
              <ChargeTypes>24,102,47,99,60</ChargeTypes>
              <ArrivesOn>1,1,1,1,0,1,1</ArrivesOn>
              <AppliesOn>1,1,1,0,1,0,1</AppliesOn>
            </Validation>
          </Validations>
        </Discount>
      </Discounts>
    </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>

    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