OTA_HotelRoomListRQ

Method for retrieving room data and offer data from Kurzurlaub.de.

OTA_HotelRoomListRQ - request via GET - REST API

each method can be called via REST-API using GET.

Parameters used:

AgentDutyCode (optional if IP WhiteList or HTTP Basic Auth is used)
HotelCode (mandatory)

Example:

GET /ota/api/HotelRoomList?AgentDutyCode=1&HotelCode=4

OTA_HotelRoomListRQ - Request per POST

HotelRoomList Request (RQ) and Response (RS) using the example of the test hotel

@AgentDutyCode (Agent-ID): 1
@HotelCode (Hotel-ID): 4

Example OTA_HotelRoomListRQ (Request)

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRoomListRQ xmlns="http://www.opentravel.org/OTA/2003/05" 
    AvailRatesOnly="true" EchoToken="938a6a32-c526-485b-b641-f69d635cda41" 
    TimeStamp="2021-10-18T10:00:00+01:00" Version="1.0">
    <POS>
        <Source AgentDutyCode="1">
            <RequestorID ID="4" Type="4"/>
        </Source>
    </POS>
    <HotelRoomLists>
        <HotelRoomList HotelCode="4"/>
    </HotelRoomLists>
</OTA_HotelRoomListRQ>

versions of the response

This method is not offered in the OTA-V1 version

New version OTA-V2 of OTA_HotelRoomListRS provides room data and offer data

A RoomType / RatePlan combination is supplied here, i.e. all rooms and the associated available offers (RatePlan) with attributes.

The following attributes are used for the rooms (RoomType).

@RoomID
@RoomTypeCode (same as RoomID)
@RoomCategory (room type e.g. single room, double room, apartment ...)
@NumberOfUnits (number of rooms 1-n)
RoomDescription@Name (room name, size and max. occupancy)

Example RoomType:

<RoomType IsRoom="true" RoomID="9143" RoomTypeCode="9143" 
    RoomCategory="Doppelzimmer" NumberOfUnits="2">
    <RoomDescription Name="Doppelzimmer Seeseite (29m², ID:9143, 2E/2K)"/>
</RoomType>

The following attributes are used for the offers (RatePlan).

@RatePlanID
@RatePlanCode
@RatePlanName
@RatePlanType
Offer period (@EffectiveDate - @ExpireDate)

The RatePlanID and RatePlanCode (e.g. BEST-RATE or BAR - Best Available Rate) are usually different. If no RatePlanCode is specified, the ID is also sent here.

Example rate plan:

<RatePlan RatePlanID="20540" RatePlanCode="20540" RatePlanName="Testarrangement schönes Schwerin">
    <RatePlanDescription Name="Testarrangement schönes Schwerin">
        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
    </RatePlanDescription>
</RatePlan>

Example OTA_HotelRoomListRS (Response)

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRoomListRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                     EchoToken="a79fbdd898f09112c7480a9eabc3f6be" PrimaryLangID="de"
                     TimeStamp="2021-11-04T15:09:28+01:00" Target="Production" Version="1.000">
    <Success/>
    <HotelRoomLists>
        <HotelRoomList HotelCode="4" HotelName="Hotel Superurlaub Schwerin">
            <RoomStays>
                <RoomStay>
                    <RoomTypes>
                        <RoomType IsRoom="true" RoomID="9143" RoomTypeCode="9143" RoomCategory="Doppelzimmer"
                                  NumberOfUnits="2">
                            <RoomDescription Name="Doppelzimmer Seeseite (29m², ID:9143, 2E/2K)"/>
                        </RoomType>
                    </RoomTypes>
                    <RatePlans>
                        <RatePlan RatePlanID="20540" RatePlanCode="20540"
                                  RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen">
                            <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                                <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                            </RatePlanDescription>
                        </RatePlan>
                        <RatePlan RatePlanID="190772" RatePlanCode="BAR-190772"
                                  RatePlanName="Testarrangement schönes Schwerin - am Wochenende">
                            <RatePlanDescription Name="Testarrangement schönes Schwerin - am Wochenende">
                                <text>Kurzurlaub Angebot 3 ÜN gültig bis 31.12.2021</text>
                            </RatePlanDescription>
                        </RatePlan>
                    </RatePlans>
                </RoomStay>
                <RoomStay>
                    <RoomTypes>
                        <RoomType IsRoom="true" RoomID="9148" RoomTypeCode="9148" RoomCategory="Einzelzimmer"
                                  NumberOfUnits="1">
                            <RoomDescription Name="Einzelzimmer Deluxe (18m², ID:9148, 1E/1K)"/>
                        </RoomType>
                    </RoomTypes>
                    <RatePlans>
                        <RatePlan RatePlanID="20540" RatePlanCode="20540"
                                  RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen">
                            <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                                <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                            </RatePlanDescription>
                        </RatePlan>
                        <RatePlan RatePlanID="190772" RatePlanCode="BAR-190772"
                                  RatePlanName="Testarrangement schönes Schwerin - am Wochenende">
                            <RatePlanDescription Name="Testarrangement schönes Schwerin - am Wochenende">
                                <text>Kurzurlaub Angebot 3 ÜN gültig bis 31.12.2021</text>
                            </RatePlanDescription>
                        </RatePlan>
                    </RatePlans>
                </RoomStay>
            </RoomStays>
        </HotelRoomList>
    </HotelRoomLists>
</OTA_HotelRoomListRS>