Skip to content

OTA_HotelRatePlanRQ

The rate plan request within the OTA_HotelRatePlanRQ method requests the rooms and rate plan combinations from the system for the hotel requested.

<?xml version="1.0"?>
<soap:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <AccessHeader>
            <UserName>MyUserName</UserName>
            <Password>MyPassword</Password>
        </AccessHeader>
    </soap:Header>
    <soap:Body>
        <OTA_HotelRatePlanRQ Version="1"
            xmlns="http://www.opentravel.org/OTA/2003/05">
            <POS>
                <Source>
                    <RequestorID ID="myhotelcode" />
                </Source>
            </POS>
        </OTA_HotelRatePlanRQ>
    </soap:Body>
</soap:Envelope>

Response contents and data

The result will include all available rooms and their rate plans to which this user has access on the hotel to which the hotel code belongs. The ID or "hotelCode" needs to match the code of the property mapped, known as the property id.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <OTA_HotelRatePlanRS EchoToken="" Version="1" 
            TimeStamp="2021-09-29T17:08:57.252Z" 
            PrimaryLangID="en-US" 
            xmlns="http://www.opentravel.org/OTA/2003/05">
            <RatePlans HotelCode="myhotelcode">
                <RatePlan RatePlanType="Rack" RatePlanCode="suitestandard">
                    <Rates>
                        <Rate MinGuestApplicable="1" 
                            MaxGuestApplicable="2" 
                            InvCode="Suite" 
                            InvTypeCode="suite" />
                    </Rates>
                    <Description Name="Short Description">
                        <Text Language="en">Suite Standard</Text>
                    </Description>
                </RatePlan>
            </RatePlans>
        </OTA_HotelRatePlanRS>
    </soap:Body>
</soap:Envelope>

Response field definitions

The output contains the rate plan with the rates and the description including the following fields.

Field Description
HotelCode Unique id of the property
RatePlanCode Code of the rate plan as configured
MinGuestApplicable The minimum occupancy for the room/unit
MaxGuestApplicable The maximum occupancy for the room/unit
InvCode Name of the room/unit
InvTypeCode Unique id of the room/unit
Description Name Is always Short Description
Text The name of the rate plan