Skip to content

OTA_HotelAvailRQ

Method for retrieving rooms and offers from Kurzurlaub.de.

OTA_HotelAvailRQ - 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/HotelAvail?AgentDutyCode=1&HotelCode=4

OTA_HotelAvailRQ - Request per POST

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

Parameters used:

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

Example OTA_HotelAvailRQ (Request)

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" AvailRatesOnly="true"
   EchoToken="938a6a32-c526-485b-b641-f69d635cda41" 
   TimeStamp="2020-06-18T15:04:39+01:00"
   Version="1.0">

    <POS>
        <Source AgentDutyCode="1">
            <RequestorID ID="4" Type="4"/>
        </Source>
    </POS>

    <AvailRequestSegments>
        <AvailRequestSegment AvailReqType="Room">
            <HotelSearchCriteria>
                <Criterion>
                    <HotelRef HotelCode="4"/>
                </Criterion>
            </HotelSearchCriteria>
        </AvailRequestSegment>
    </AvailRequestSegments>
</OTA_HotelAvailRQ>

OTA_HotelAvailRS - Versions of response

OTA-V1

Old version of the OTA_HotelAvailRS with room data only without offer data

Example OTA_HotelAvailRS (Response)

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelAvailRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.opentravel.org/OTA/2003/05"
                  xsi:schemaLocation="http://opentravel.org/2010A/OTA_HotelAvailRS.xsd" Version="1.0"
                  TimeStamp="2021-11-04T12:59:20" EchoToken="43e234b7cede64ea341c6417ab3cd9dd">
    <Success/>
    <RoomStays>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="2625">
                    <RoomDescription Name="Appartement/s (28 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="9147">
                    <RoomDescription Name="Doppelzimmer (24 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="25871">
                    <RoomDescription Name="Doppelzimmer (20 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="9143">
                    <RoomDescription Name="Doppelzimmer Seeseite (29 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="11668">
                    <RoomDescription Name="Dreibettzimmer (29 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="5307">
                    <RoomDescription Name="Einzelzimmer (15 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="9148">
                    <RoomDescription Name="Einzelzimmer Deluxe (18 m²)"/>
                </RoomType>
            </RoomTypes>
        </RoomStay>
    </RoomStays>
</OTA_HotelAvailRS>

OTA-V2 (new version from 10.2021)

New version of the OTA_HotelAvailRS with 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)
  • @RoomType - (room type e.g. single room, double room, apartment ...)
  • @NumberOfUnits (number of rooms 1-n)
  • RoomDescription@Name (room name and size)
  • Occupancy@MaxOccupancy (max. occupancy with adults)

Example RoomType:

<RoomType RoomID="2625" RoomTypeCode="2625" RoomType="Appartement" NumberOfUnits="10">
    <RoomDescription Name="Appartement/s (28m², ID:2625, 4E/2K)"/>
    <Occupancy MaxOccupancy="4"/>
</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 RatePlanID is also sent here.

The RatePlanType is always the same (11) because it is a package - see the OTA standard in the Rate Plan Type Code Table (RPT)

Example rate plan:

<RatePlan RatePlanID="190772" RatePlanCode="BAR-190772" RatePlanType="11" 
    RatePlanName="Testarrangement schönes Schwerin"
    EffectiveDate="2020-01-01" ExpireDate="2022-12-31">

Example OTA_HotelAvailRS (Response)

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelAvailRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  EchoToken="fb67da72b95941c8dc28aeb276790cc0" PrimaryLangID="de" TimeStamp="2021-11-04T12:46:34+01:00"
                  Target="Production" Version="2.0">
    <Success/>
    <RoomStays>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="2625" RoomTypeCode="2625" RoomType="Appartement" NumberOfUnits="10">
                    <RoomDescription Name="Appartement/s (28m², ID:2625, 4E/2K)"/>
                    <Occupancy MaxOccupancy="4"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="20540" RatePlanCode="20540"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="2625" RoomTypeCode="2625" RoomType="Appartement" NumberOfUnits="10">
                    <RoomDescription Name="Appartement/s (28m², ID:2625, 4E/2K)"/>
                    <Occupancy MaxOccupancy="4"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="190772" RatePlanCode="BAR-190772"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen 2" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen 2">
                        <text>Kurzurlaub Angebot 3 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="5306" RoomTypeCode="5306" RoomType="Doppelzimmer" NumberOfUnits="43">
                    <RoomDescription Name="Doppelzimmer (20m², ID:5306, 2E/1K)"/>
                    <Occupancy MaxOccupancy="2"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="20540" RatePlanCode="20540"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="5306" RoomTypeCode="5306" RoomType="Doppelzimmer" NumberOfUnits="43">
                    <RoomDescription Name="Doppelzimmer (20m², ID:5306, 2E/1K)"/>
                    <Occupancy MaxOccupancy="2"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="190772" RatePlanCode="BAR-190772"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen 2" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen 2">
                        <text>Kurzurlaub Angebot 3 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="9143" RoomTypeCode="9143" RoomType="Doppelzimmer" NumberOfUnits="2">
                    <RoomDescription Name="Doppelzimmer Seeseite (29m², ID:9143, 2E/2K)"/>
                    <Occupancy MaxOccupancy="2"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="20540" RatePlanCode="20540"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>

        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="9147" RoomTypeCode="9147" RoomType="Doppelzimmer" NumberOfUnits="3">
                    <RoomDescription Name="Doppelzimmer (24m², ID:9147, 2E/2K)"/>
                    <Occupancy MaxOccupancy="2"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="20540" RatePlanCode="20540"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>

        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="9148" RoomTypeCode="9148" RoomType="Einzelzimmer" NumberOfUnits="1">
                    <RoomDescription Name="Einzelzimmer Deluxe (18m², ID:9148, 1E/1K)"/>
                    <Occupancy MaxOccupancy="1"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="20540" RatePlanCode="20540"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>

        <RoomStay>
            <RoomTypes>
                <RoomType RoomID="45741" RoomTypeCode="45741" RoomType="Einzelzimmer" NumberOfUnits="1">
                    <RoomDescription Name="Einzelzimmer Meerblick (28m², ID:45741, 1E/1K)"/>
                    <Occupancy MaxOccupancy="1"/>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanID="20540" RatePlanCode="20540"
                          RatePlanName="Testarrangement schönes Schwerin - bitte nicht buchen" RatePlanType="11"
                          EffectiveDate="2017-03-01" ExpireDate="2021-12-31">
                    <RatePlanDescription Name="Testarrangement schönes Schwerin - bitte nicht buchen">
                        <text>Kurzurlaub Angebot 2 ÜN gültig bis 31.12.2021</text>
                    </RatePlanDescription>
                </RatePlan>
            </RatePlans>
        </RoomStay>
    </RoomStays>
</OTA_HotelAvailRS>