4.2. GuestRequests: quote requests, booking reservations and cancellations

The typical use case for GuestRequests is a portal that collects quote requests, booking reservations or booking cancellations from potential customers and stores them until a client (typically the software used by a hotel) retrieves them.

In this case, the client sends a first request to obtain the information from the server about any requests, reservations or cancellations with the X-AlpineBits-Action field set to the value OTA_Read:GuestRequests.

The server then responds with the requested information.

Successively, the client sends a follow-up request to acknowledge having received the information, with the X-AlpineBits-Action field set to the value OTA_NotifReport:GuestRequests.

Please note that a server that has announced support for OTA_Read:GuestRequests MUST also support the action OTA_NotifReport:GuestRequests so that the client can execute follow-up acknowledgement requests. See section 4.2.3 and section 4.2.4 for more details.

Push Support

Starting with AlpineBits version 2018-10 it is possible to push the GuestRequest instead of polling them. Please note that this functionality relies on a few arrangements between the two parties that are not negotiated through AlpineBits, namely the endpoint (URL) where the client can receive the pushed GuestRequests, its credentials, etc. This behavior is described in section 4.2.6 and 4.2.7, but the XML structure of the HotelReservation is the same as in the rest of this chapter.

4.2.1. First client request

The X-AlpineBits-Action field is set to the value OTA_Read:GuestRequests and the request body must contain a OTA_ReadRQ document.

For the attributes HotelCode and HotelName the rules are the same as for room availability notifications (section 4.1.1).

The element SelectionCriteria with the Start attribute is optional.

When given, the server will send only inquiries generated after the Start timestamp, regardless whether the client has retrieved them before or not.

When omitted, the server will send all inquiries it has on record and that the client has not yet retrieved.

files/samples/GuestRequests/GuestRequests-OTA_ReadRQ-selection-criteria.xml
<?xml version="1.0" encoding="UTF-8"?>

<OTA_ReadRQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://www.opentravel.org/OTA/2003/05"
            xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_ReadRQ.xsd"
            Version="5.001">

    <ReadRequests>
        <HotelReadRequest HotelCode="123" HotelName="AlpineBits Hotel">
           <SelectionCriteria Start="2027-03-21T15:00:00+01:00"></SelectionCriteria>
       </HotelReadRequest>
    </ReadRequests>

</OTA_ReadRQ>

4.2.2. Server response

The server will send a response indicating the outcome of the request. The response is a OTA_ResRetrieveRS document. Any of the four possible AlpineBits® server response outcomes (success, advisory, warning or error) are allowed.

See section 2.3 for details.

files/samples/GuestRequests/GuestRequests-Acknowledgments-OTA_NotifReportRS-success.xml - the follow-up response, here reporting success
<?xml version="1.0" encoding="UTF-8"?>

<OTA_NotifReportRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns="http://www.opentravel.org/OTA/2003/05"
                   xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_NotifReportRS.xsd"
                   Version="3.000">

    <Success/>

</OTA_NotifReportRS>

In case of success, the OTA_ResRetrieveRS response will contain a single, empty Success element followed by a ReservationsList element with zero or more HotelReservation elements containing the requested information (zero elements indicate the server has no information for the client at this point).

Each HotelReservation must have the attributes CreateDateTime (the timestamp the information was collected by the portal). Furthermore the ResStatus attribute must be set. AlpineBits® expects it to be one of the following four:

  • Requested - this is a request for a quote, newsletter or catalog.

  • Reserved - this is a booking reservation.

  • Modify - this is a booking modification.

  • Cancelled - this is a booking cancellation.

For a newsletter- or catalog request the optional attribute RoomStayReservation must be explicitly set to false.

The following example is a reservation (thus, ResStatus is Reserved). The documentation kit also has an example of a quote request. A cancellation is discussed later.

First, consider the outer part of the OTA_ResRetrieveRS document:

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - outer part
<?xml version="1.0" encoding="UTF-8"?>

<OTA_ResRetrieveRS
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.opentravel.org/OTA/2003/05"
        xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_ResRetrieveRS.xsd"
        Version="7.000">

    <Success/>

    <ReservationsList>

        <HotelReservation CreateDateTime="2026-11-21T12:00:00+01:00"
                          ResStatus="Reserved">

             <!-- Type 14 -> Reservation -->
             <UniqueID Type="14" ID="6b34fe24ac2ff810"/>

             <RoomStays>     <!-- stays, see below -->                    </RoomStays>

             <Services>      <!--- optional services, see below-->        </Services>

             <ResGuests>     <!-- customer data, see below -->            </ResGuests>

             <ResGlobalInfo> <!-- additional booking data, see below -->  </ResGlobalInfo>

        </HotelReservation>

    </ReservationsList>

</OTA_ResRetrieveRS>

Each HotelReservation contains a mandatory UniqueID element that the client can use to recognize information it has already processed.

The UniqueID element must have the Type attribute set according the OTA Unique Id Type list (UIT). The value must be consistent with the ResStatus attribute of the surrounding HotelReservation element:

  • For ResStatus = Requested, the Type must be 14 (Reservation).

  • For ResStatus = Reserved, the Type must be 14 (Reservation).

  • For ResStatus = Modify, the Type must be 14 (Reservation).

  • For ResStatus = Cancelled, the Type must be 15 (Cancellation).

The attribute ID is a free text field suitable for uniquely identifying the HotelReservation.

The actual data is then split into four parts: each HotelReservation contains the elements: RoomStays, Services, ResGuests and ResGlobalInfo discussed in the following paragraphs.

Modifications and Cancellations.

A booking modification (ResStatus is Modify) is identical to a booking reservation (ResStatus is Reserved). However, for a booking modification the client will recognize the UniqueId attribute and act accordingly, updating the reservation instead of adding a new one.

Besides quote requests and booking reservations, also cancellations can be handled. For cancellations the ResStatus is Cancelled as shown in the following example:

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-cancellation.xml
<?xml version="1.0" encoding="UTF-8"?>

<OTA_ResRetrieveRS
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.opentravel.org/OTA/2003/05"
        xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_ResRetrieveRS.xsd"
        Version="7.000">

    <Success/>

    <ReservationsList>

        <HotelReservation CreateDateTime="2027-03-21T15:00:00+01:00"
                          ResStatus="Cancelled">

              <!-- Type 15 -> Cancellation -->
            <UniqueID Type="15" ID="c24e8b15ca469388"/>

            <!-- the following are optional for cancellations: -->
            <!--
            <RoomStays>     ...  </RoomStays>
            <ResGuests>     ...  </ResGuests>
            <ResGlobalInfo> ...  </ResGlobalInfo>
            -->

        </HotelReservation>

    </ReservationsList>

</OTA_ResRetrieveRS>

Each HotelReservation must of course have the attributes CreateDateTime and ResStatus set to Cancelled.

Of course, the element UniqueID is mandatory, again with mandatory attribute Type 15 and attribute ID referring to the reservation that is being cancelled! Other reservation elements may be also sent.

RoomStays

RoomStays is mandatory for reservations, optional for quote requests, disallowed for newsletter- or catalog requests.

The RoomStays element contains one or more RoomStay elements, each indicating a desired stay.

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - RoomStay element common example
files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-allguests-and-company.xml - RoomStay element with all guests and company
<RoomStays>

    <RoomStay>

        <RoomTypes>
            <RoomType RoomTypeCode="SUITE" RoomClassificationCode="42"/>
        </RoomTypes>

        <RatePlans>
            <RatePlan RatePlanCode="123456-xyz">
                <Commission Percent="15"/>
                <!-- Code 1 -> All inclusive -->
                <MealsIncluded MealPlanIndicator="true" MealPlanCodes="1"/>
            </RatePlan>
        </RatePlans>

        <RoomRates>
            <RoomRate> ... </RoomRate>
        </RoomRates>

        <!-- 2 adults + 1 child + 1 child = 4 guests -->
        <GuestCounts>
            <!-- 2 adults -->
            <GuestCount Count="2"/>
            <!-- 1 child -->
            <GuestCount Count="1" Age="9"/>
            <!-- 1 child -->
            <GuestCount Count="1" Age="3"/>
        </GuestCounts>

        <TimeSpan Start="2027-01-01" End="2027-01-12"/>

        <Guarantee>
            <GuaranteesAccepted>
                <GuaranteeAccepted>
                    <PaymentCard CardCode="VI"
                                 ExpireDate="1230">
                        <CardHolderName>Otto Mustermann</CardHolderName>
                        <CardNumber>
                            <PlainText>4444333322221111</PlainText>
                        </CardNumber>
                    </PaymentCard>
                </GuaranteeAccepted>
            </GuaranteesAccepted>
        </Guarantee>

        <Total AmountAfterTax="1125" CurrencyCode="EUR"/>

        <ServiceRPHs>
            <ServiceRPH RPH="1" />
            <ServiceRPH RPH="2" />
        </ServiceRPHs>

    </RoomStay>

</RoomStays>

Each RoomStay element contains:

  • One RoomType element (mandatory for reservations, optional for quote requests): see below for an explanation;

  • One RatePlan element with:

    • A RatePlanCode attribute (mandatory for reservations, optional for quote requests).

    • Zero or one Commission elements with either a Percent attribute (the commission in percent) or a CommissionPayableAmount sub-element with attributes Amount and CurrencyCode; the Amount must follow the currency decimal format.

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-alternatives.xml - a commission expressed as an amount instead of a percentage
<RatePlans>
    <RatePlan RatePlanCode="STD-HB">
        <Commission>
            <CommissionPayableAmount Amount="82.50" CurrencyCode="EUR"/>
        </Commission>
        <MealsIncluded MealPlanIndicator="true" MealPlanCodes="12"/>
    </RatePlan>
</RatePlans>

  • One MealsIncluded element (mandatory for reservations, optional for quote requests): the MealsIncluded element must contain the MealPlanCodes attribute (values see below) and must have the MealPlanIndicator attribute set to true;

    • One RoomRate element with:

      • A RatePlanCode attribute (mandatory).

      • A RoomTypeCode attribute (mandatory).

      • One or more Rate elements (mandatory), where each element contains:

        • An EffectiveDate (mandatory) attribute: Indicating the starting date.

        • An ExpireDate attribute: Indicating the ending date.

        • An optional ExpireDateExclusiveInd attribute (defaults to false): When false, it indicates that the ExpireDate is the last day of the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 15). When true, it indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).

        • An RateTimeUnit attribute: Indicating the time unit for the rate.

        • An UnitMultiplier attribute: Indicating the number of rate time units such as "3 Days".

        • A Base element (mandatory) : The base amount charged for the accommodation or service per unit of time (eg: Nightly, Weekly, etc). Note that any additional charges should be itemized in the other elements.

    • One GuestCounts element (mandatory) indicating the number of all adults (identified by zero or one GuestCount element with no Age attribute given) and the number of all children (identified by zero or more GuestCount element with Age attribute given); of course all guests must be listed and their total (adults + children) must not be zero.

    • One TimeSpan element (mandatory): see below for an explanation.

    • One PaymentCard element, either in DepositPayments or Guarantee (only for reservations, optional) with:

      • The mandatory attributes CardCode (the card issuer, two uppercase letters, such as "VI" for Visa) and ExpireDate (four digits).

      • The optional sub-element CardHolderName.

      • The mandatory sub-element CardNumber (see below).

    • One Total element (mandatory for reservations, optional for quote requests) containing the cost after taxes the portal has displayed to the customer, both attributes AmountAfterTax and CurrencyCode are required; the AmountAfterTax must follow the currency decimal format.

    • One ResGuestRPHs element which holds a list of unsigned integers that reference the ResGuestRPH attribute in the ResGuest object. It is used to specify which guests occupy this room.

The CardNumber element is used to send a credit card number. The number can be sent either as plain text (but note the message transport is encrypted using HTTPS) or encrypted.

For the plain text case, the CardNumber element has no attributes and must contain a PlainText sub-element holding the complete credit card number or its last four digits as in the example above.

For the encrypted case, the CardNumber element must not have any sub-elements and must have attributes EncryptedValue (a string representation of the encrypted card number) and EncryptionMethod (a string identifying the encryption method, e.g. "RSA-PKCSV2.2").

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-alternatives.xml - a credit card number sent encrypted
<PaymentCard CardCode="VI" ExpireDate="1230">
    <CardHolderName>Otto Mustermann</CardHolderName>
    <CardNumber EncryptedValue="Vk15rP0iQ2xhdWRlU2FtcGxlRW5jcnlwdGVkQ2FyZE51bWJlcg=="
                EncryptionMethod="RSA-PKCSV2.2"/>
</PaymentCard>

For reservations, the RoomType element is mandatory. Reservations must refer to a specific room category (specified by RoomTypeCode). Quote requests should refer a specific room category whenever possible (specified by the optional attribute RoomTypeCode) but may refer to a generic GRI (specified by the optional attribute RoomClassificationCode) or may be completely open if the RoomType element is present without attributes.

The RoomTypeCode must be identical to the InvTypeCode attribute used for room categories (see section 4.1.1).

The RoomClassificationCode follows the OTA list "Guest Room Info" (GRI). It is used to loosely classify the kind of guest room (42 means just "Room", 13 means "Apartments", 5 means "Pitches", etc.) wished by the guest.

The optional RoomType attribute may be specified, see the definition of the RoomType attribute used for the Inventory (see section 4.3.1) for the list of values defined by AlpineBits®. If the RoomType attribute is specified, then also RoomClassificationCode must be present.

Regarding the MealPlanCodes attribute, AlpineBits® does not use the single Breakfast/Lunch/Dinner booleans, but relies on the MealPlanCodes attribute only. The following codes (a subset of the full OTA list) are allowed:

  • 1 - All inclusive

  • 3 - Bed and breakfast

  • 10 - Full board

  • 12 - Half board

  • 14 - Room only

TimeSpan

The TimeSpan element deserves a more detailed explanation.

For reservations (ResStatus is Reserved or Modify), the arrival and departure date must be given with the Start and End attributes of the TimeSpan element. No other attributes and no sub elements must be present in TimeSpan. The End attribute must be interpreted as exclusive: it is the departure date, not the last night of the stay. For example, a 4-night stay arriving on 23 May 2026 is encoded with Start = "2026-05-23" and End = "2026-05-27", i.e. the 23rd, 24th, 25th and 26th of May are the nights.

For quote requests (ResStatus is Requested) the timespan can be given in the same way (i.e. using the Start and End attributes) or it may be given as a window. In this case the TimeSpan element must have the Duration attribute (encoded in ISO 8601) and the StartDateWindow sub element with attributes EarliestDate and LatestDate which must be greater than EarliestDate indicating a range of possible start dates.

Duration are given in nights, the form is thus always PxN where x is a number.

A reservation can contain multiple RoomStay elements. Thus, different rooms with different RatePlans can be managed in one reservation. In addition, it is possible to book a stay of, for example, 10 days with a weekly flat rate and a standard offer for the remaining days.

The optional RoomStayGroupID attribute comes into play when alternative room stays or periods need to be transmitted. Note that this is valid for quote requests only (ResStatus is Requested) and they cannot be used together. Each room type with the same RoomStayGroupID indicates a group of room types which must be requested together, meaning that RoomStayGroupID set to "1" is the first alternative, RoomStayGroupID set to "2" the second alternative and so on. One or more alternatives can be specified by using a different identifier.

In general, a separate RoomStay element should be used for each room and rate plan.

RoomRates

RoomRates allow to track the exact costs of a room per day.

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - RoomRates element
<RoomRates>
    <RoomRate RatePlanCode="123456-xyz" RoomTypeCode="SUITE">
        <Rates>
            <Rate EffectiveDate="2027-01-01" ExpireDate="2027-01-07" ExpireDateExclusiveInd="false" RateTimeUnit="Day" UnitMultiplier="1">
                <Base AmountAfterTax="100" CurrencyCode="EUR"/>
            </Rate>
            <Rate EffectiveDate="2027-01-08" RateTimeUnit="Day">
                <Base AmountAfterTax="115" CurrencyCode="EUR"/>
            </Rate>
            <Rate EffectiveDate="2027-01-09" RateTimeUnit="Day">
                <Base AmountAfterTax="110" CurrencyCode="EUR"/>
            </Rate>
            <Rate EffectiveDate="2027-01-10" ExpireDate="2027-01-11" ExpireDateExclusiveInd="false" RateTimeUnit="Day">
                <Base AmountAfterTax="100" CurrencyCode="EUR"/>
            </Rate>
        </Rates>
    </RoomRate>
</RoomRates>

This covers two use cases:

  1. In eras of revenue management it becomes more and more frequent that each day has its own unique rate. In order to be able to provide the hotel with data on how much revenue was made on each single day, this information needs to be as detailed as possible.

  2. Some portals do grant discounts on the prices they receive from PMS. In order to be able to get the information which price has been offered to the guest back to the PMS, the reservation message has to contain the daily room rates (the base price of a single room on a daily basis).

NB: In a PMS (AlpineBits Client) such gross prices for the rooms often have to be split internally, either for internal cost accounting or for tax regulations (different tax rates). Therefore both the sold offer (rate plan) and the calculated room rate must be known in the PMS.

The amounts specified via the Rate/Base element should only define the room rates. Any other surcharges do not need to be specified in detail. Therefore, the total amount specified under ResGlobalInfo/Total may exceed the sum of the room rates.

Regarding RoomRates there are the following rules to be followed:

  • Since there are separate RoomStay elements per room and rate plan, only one RoomRate element is required.

  • The Rate elements defines the unit prices of a certain period per room and time unit.

  • ExpireDate is optional and is usually specified inclusive. If this attribute is omitted, the price is valid only for EffectiveDate.

  • The optional ExpireDateExclusiveInd attribute (defaults to false) is an indicator that must be used only in combination with ExpireDate and determines whether ExpireDate is exclusive (true) or inclusive (false).

  • The amounts specified in the Base element should only define the room rates. Any other surcharges do not need to be specified in detail. Therefore, the total amount specified under ResGlobalInfo/Total may exceed the sum of the room rates.

Services

The optional Services element contains one or more Service elements. The Service element can be used to specify additional services booked with the reservation and also allows to give a more precise indication of the price composition.

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - Services element
<Services>
    <!-- Garage 10 Euro / day -->
    <Service Inclusive="false" Quantity="11" ServiceRPH="1" ServicePricingType="Per use"
             ServiceCategoryCode="OTHER" ServiceInventoryCode="garage1" ID="ab123" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="110" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Garage</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <!-- Ski depot, charged for every night of the stay -->
    <Service Inclusive="false" Quantity="7" ServiceRPH="5" ServicePricingType="Per night"
             ServiceCategoryCode="OTHER" ServiceInventoryCode="skidepot" ID="cd456" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="35" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Ski depot</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <!-- Spa entrance, charged once for every guest -->
    <Service Inclusive="false" Quantity="4" ServiceRPH="6" ServicePricingType="Per person"
             ServiceCategoryCode="SPA" ServiceInventoryCode="spaentry" ID="ef789" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="60" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Spa entrance</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <!-- Supplement from a rate plan -->
    <Service Inclusive="true" Quantity="1" ServiceRPH="2" ServicePricingType="Per stay"
             ServiceCategoryCode="SUPPLEMENT" ServiceInventoryCode="0x539" ID="456" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="50" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Final cleaning</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <!--  Couple Massage -->
    <Service Inclusive="false" Quantity="1" ServiceRPH="3" ServicePricingType="Per use"
             ServiceCategoryCode="ACTIVITY"
             ServiceInventoryCode="M1" ID="555" Type="16">
        <ServiceDetails>
            <!-- optional guest counts -->
            <GuestCounts>
                <!-- 2 adults -->
                <GuestCount Count="2"/>
            </GuestCounts>
            <!-- optional time span -->
            <TimeSpan Start="2027-01-03T15:00:00+02:00" End="2027-01-03T17:30:00+02:00"/>
            <!-- optional guest comment -->
            <Comments>
                <Comment>
                    <Text TextFormat="PlainText">A guest comment</Text>
                </Comment>
            </Comments>
            <Total AmountAfterTax="50" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">couple massage</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <!-- Board price (2 guests * 7 nights) -->
    <Service Inclusive="true" Quantity="14" ServiceRPH="4" ServicePricingType="Per person per night"
             ServiceCategoryCode="BOARD" ServiceInventoryCode="HB" ID="HB" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="140" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Halfboard</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Each Service element contains:

  • One ServiceDetails element with:

    • One optional GuestCounts element containing one or more GuestCount elements with the attribute Count and the optional attribute Age. The purpose of this element is to identify the number of guests and their age.

    • One optional TimeSpan element with the mandatory attribute Start and the optional attribute End. It specifies when the service is consumed. Both attributes are of OTA type DateOrTimeOrDateTimeType and, within the same TimeSpan, must use the same form (a date, a time, or a date-time). The End attribute must be interpreted as exclusive. When End is omitted, the service refers to the single day or time given by Start; recurring services may therefore be encoded either as a single Service with Start and End, or as one Service per occurrence with only Start. When the values carry a time component they may include a timezone offset; if the offset is omitted, the local timezone of the accommodation applies. See the dedicated examples at the end of this section.

    • One optional Comments element containing exactly one Comment element. The Comment element contains one Text element having the attribute TextFormat set to PlainText. This element should be used to add a comment that has been inserted by the customer who has booked the service.

    • One mandatory Total element with the mandatory attributes AmountAfterTax and CurrencyCode; the AmountAfterTax must follow the currency decimal format. The indicated amount must not be multiplied by the quantity of the service, but already represents the total cost of the service including all taxes.

    • One optional ServiceDescription element containing one Text element with the attribute TextFormat set to PlainText. This is used to specify the description of the service.

  • The mandatory attribute ServiceCategoryCode is an enumerated type that identifies the category of the service. Allowed values are: BOARD, SUPPLEMENT, SPA, FOOD, BEVERAGE, ACTIVITY, TOURISTTAX, TRANSFER, PACKAGE, RESOURCE, OTHER

  • The mandatory attribute ServiceInventoryCode for identification of the service in conjunction with the ServiceCategoryCode.

  • The mandatory attribute ID attribute should be used to specify the unique identifier of the originating system. If the originating system does not manage such an ID, it should be set to the concatenated value of ServiceCategoryCode and ServiceInventoryCode to uniquely identify the service.

  • The mandatory attribute ServicePricingType is an enumerated type that indicates how a service was priced. Allowed values are: Per night, Per person, Per person per night, Per stay, Per use.

  • The mandatory attribute Inclusive indicates whether the price for this service is already included in the room rate.

  • The mandatory attribute Quantity is used to indicate the quantity of the booked services. Also serves as the number of persons/nights when pricing class is per person or per person per night.

  • The optional attribute ServiceRPH is a unique ID for a service that may be referenced in a RoomStay element of the HotelReservation

The following examples illustrate each valid combination of the optional TimeSpan element and its Start and End attributes. They are taken from a single 7-night stay (2026-05-01 → 2026-05-08, 2 guests).

Example 1: a per-stay welcome package with no TimeSpan element — the service refers to the whole stay.

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - welcome package
<Services>
    <!-- Per stay welcome package, no TimeSpan -->
    <Service Inclusive="false" Quantity="1" ServiceRPH="1" ServicePricingType="Per stay"
             ServiceCategoryCode="PACKAGE" ServiceInventoryCode="welcome_pkg" ID="PACKAGE_welcome_pkg" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="30" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Welcome package</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 2: a per-use bike rental, TimeSpan with a full date-time including a timezone offset; End is exclusive (the bike is returned at 17:00 local time).

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - bike rental
<Services>
    <!-- Per use bike rental, TimeSpan with full date-time and timezone offset;
         End is exclusive (the bike is returned at 17:00 local time) -->
    <Service Inclusive="false" Quantity="1" ServiceRPH="2" ServicePricingType="Per use"
             ServiceCategoryCode="RESOURCE" ServiceInventoryCode="bicycle" ID="RESOURCE_bicycle" Type="16">
        <ServiceDetails>
            <TimeSpan Start="2026-05-02T09:00:00+02:00" End="2026-05-02T17:00:00+02:00"/>
            <Total AmountAfterTax="25" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Bicycle</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 3: a per-night babyphone, TimeSpan with a date range; End is the departure date (exclusive), so the device covers the seven nights from 2026-05-01 through 2026-05-07.

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - babyphone
<Services>
    <!-- Per night babyphone, TimeSpan with date range; End = departure date (exclusive),
         so the device covers the seven nights from 2026-05-01 through 2026-05-07 -->
    <Service Inclusive="false" Quantity="7" ServiceRPH="3" ServicePricingType="Per night"
             ServiceCategoryCode="RESOURCE" ServiceInventoryCode="babyphone" ID="RESOURCE_babyphone" Type="16">
        <ServiceDetails>
            <TimeSpan Start="2026-05-01" End="2026-05-08"/>
            <Total AmountAfterTax="35" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Babyphone</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 4: a per-stay fruit basket, TimeSpan with only Start — the service refers to that single day.

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - fruit basket
<Services>
    <!-- Per stay fruit basket, TimeSpan with Start only (delivered on 2026-05-03) -->
    <Service Inclusive="false" Quantity="1" ServiceRPH="4" ServicePricingType="Per stay"
             ServiceCategoryCode="FOOD" ServiceInventoryCode="fruit_basket" ID="FOOD_fruit_basket" Type="16">
        <ServiceDetails>
            <TimeSpan Start="2026-05-03"/>
            <Total AmountAfterTax="20" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Fruit basket</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 5: a per-use couple massage, TimeSpan with a full date-time including a timezone offset.

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - couple massage
<Services>
    <!-- Per use couple massage, TimeSpan with full date-time and timezone offset -->
    <Service Inclusive="false" Quantity="1" ServiceRPH="5" ServicePricingType="Per use"
             ServiceCategoryCode="SPA" ServiceInventoryCode="massage_couple" ID="SPA_massage_couple" Type="16">
        <ServiceDetails>
            <GuestCounts>
                <GuestCount Count="2"/>
            </GuestCounts>
            <TimeSpan Start="2026-05-04T15:00:00+02:00" End="2026-05-04T16:30:00+02:00"/>
            <Total AmountAfterTax="90" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Couple massage</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 6: a per-person-per-night city tax with no TimeSpan element. Quantity is 2 guests × 7 nights = 14.

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - city tax
<Services>
    <!-- Per person per night city tax, no TimeSpan (Quantity = 2 guests * 7 nights) -->
    <Service Inclusive="false" Quantity="14" ServiceRPH="6" ServicePricingType="Per person per night"
             ServiceCategoryCode="TOURISTTAX" ServiceInventoryCode="city_tax" ID="TOURISTTAX_city_tax" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="14" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">City tax</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 7: ski lessons on three consecutive days, encoded as one Service per occurrence (each TimeSpan has only Start). This is equivalent to a single Service with Start = "2026-05-05" and End = "2026-05-08".

samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation-services-matrix.xml - ski lessons
<Services>
    <!-- Per use ski lessons, three consecutive days encoded as one Service per occurrence
         (each TimeSpan has only Start); equivalent to a single Service with Start and End -->
    <Service Inclusive="false" Quantity="1" ServiceRPH="7" ServicePricingType="Per use"
             ServiceCategoryCode="ACTIVITY" ServiceInventoryCode="ski_lesson" ID="ACTIVITY_ski_lesson" Type="16">
        <ServiceDetails>
            <TimeSpan Start="2026-05-05"/>
            <Total AmountAfterTax="60" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Ski lesson</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <Service Inclusive="false" Quantity="1" ServiceRPH="7" ServicePricingType="Per use"
             ServiceCategoryCode="ACTIVITY" ServiceInventoryCode="ski_lesson" ID="ACTIVITY_ski_lesson" Type="16">
        <ServiceDetails>
            <TimeSpan Start="2026-05-06"/>
            <Total AmountAfterTax="60" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Ski lesson</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
    <Service Inclusive="false" Quantity="1" ServiceRPH="7" ServicePricingType="Per use"
             ServiceCategoryCode="ACTIVITY" ServiceInventoryCode="ski_lesson" ID="ACTIVITY_ski_lesson" Type="16">
        <ServiceDetails>
            <TimeSpan Start="2026-05-07"/>
            <Total AmountAfterTax="60" CurrencyCode="EUR"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Ski lesson</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Example 8: a per night bathrobe, TimeSpan with date.

Service example - bathrobe
<Services>
    <!-- Start & End mandatory; ServicePricingType = per use / per person / per night / per person per night; the same behavior for ServiceCategoryCode = FOOD / BEVERAGE / ACTIVITY / TRANSFER -->
    <Service Inclusive="false" Quantity="5" ServiceRPH="1" ServicePricingType="Per night" ServiceCategoryCode="OTHER" ServiceInventoryCode="bathrobe" ID="a123" Type="16">
        <ServiceDetails>
            <Total AmountAfterTax="14.99" CurrencyCode="EUR"/>
            <TimeSpan Start="2026-05-01" End="2026-05-06"/>
            <ServiceDescription>
                <Text TextFormat="PlainText">Bathrobe</Text>
            </ServiceDescription>
        </ServiceDetails>
    </Service>
</Services>

Calculation of AmountAfterTax

The AmountAfterTax of the Total element of a Service is the final price of the service and is not multiplied any further. It is calculated as the price per unit of the service multiplied by the quantity:

AmountAfterTax = price per unit × quantity

For example, a bathrobe at 3 EUR per night, booked for 5 nights, has an AmountAfterTax of 15.

The quantity depends on the ServicePricingType:

ServicePricingType quantity

Per night

the maximum number of nights

Per person

the number of guests in the reservation

Per person per night

the number of guests × the maximum number of nights

Per stay

1

Per use

the number selected by the guest

ResGuests

The technically optional but recommended ResGuests element is dedicated to transmit personal information about the guests which will physically stay in the hotel structure.

Nested inside the ResGuests element there must be at least one Customer element, providing the data of the primary guest.

  • The Gender attribute can be Male, Female or Unknown.

  • The BirthDate attribute follows ISO 8601.

  • The Language follows ISO 639-1 (two-letter lowercase language abbreviation). It identifies the language to be used when contacting the customer.

  • The ResGuestRPH attribute is a reference placeholder, used as an index for this guest in this reservation. It is used by the RoomStay object to indicate which guests are associated with that room stay.

These attributes are all optional. However, it is recommended that at least gender and language be specified (so the customer can be addressed properly).

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - Customer element
<ResGuests>
    <ResGuest>
        <Profiles>
            <ProfileInfo>
                <Profile>

                    <Customer Gender="Male" BirthDate="1980-01-01" Language="de">

                        <PersonName>
                            <NamePrefix>Herr</NamePrefix>
                            <GivenName>Otto</GivenName>
                            <Surname>Mustermann</Surname>
                            <NameTitle>Dr</NameTitle>
                        </PersonName>

                        <!-- Code 1 -> Voice -->
                        <Telephone PhoneTechType="1" PhoneNumber="+4934567891"/>
                        <!-- Code 3 -> Fax -->
                        <Telephone PhoneTechType="3" PhoneNumber="+4934567892"/>
                        <!-- Code 5 -> Mobile -->
                        <Telephone PhoneTechType="5" PhoneNumber="+4934567893"/>

                        <Email Remark="newsletter:yes">otto.mustermann@example.com</Email>

                        <Address Remark="catalog:yes">

                            <AddressLine>Musterstraße 1</AddressLine>
                            <CityName>Musterstadt</CityName>
                            <PostalCode>1234</PostalCode>
                            <CountryName Code="DE"/>

                        </Address>

                    </Customer>

                </Profile>
            </ProfileInfo>
        </Profiles>
    </ResGuest>
</ResGuests>

The Customer element contains:

  • One PersonName element with NamePrefix, GivenName (mandatory), Surname (mandatory) and NameTitle.

  • Zero or more Telephone elements with the optional PhoneTechType attribute: it indicates the phone technology (1 → voice, 3 → fax, 5 → mobile per OTA).

  • One optional Email element.

  • One optional Address element with the (all optional) elements AddressLine , CityName , PostalCode and CountryName with Code attribute; the Code attribute follows ISO 3166-1 alpha-2 (two-letter uppercase country codes)

Note that most elements and attributes under the ResGuests element are optional in the AlpineBits® schema. It is, however, expected that as much contact information as possible is given.

The Email element may contain the attribute Remark having either values newsletter:yes or newsletter:no indicating whether the customer does or does not wish to receive an email newsletter. A missing Remark indicates the information is not known - for new customers this should be treated the same way as if a newsletter:no was given (do not send a newsletter), while existing customer records should not be updated.

Analogously, the Address element may contain the attribute Remark having either values catalog:yes or catalog:no indicating whether the customer does or does not wish to receive print ads by mail. A missing Remark indicates the information is not known - for new customers this should be treated the same way as if a catalog:no was given (do not send a mail), while existing customer records should not be updated.

ResGlobalInfo

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - ResGlobalInfo element
<ResGlobalInfo>
    <Comments>
        <Comment Name="included services">
            <ListItem ListItem="1" Language="de">Parkplatz</ListItem>
            <ListItem ListItem="2" Language="de">Schwimmbad</ListItem>
            <ListItem ListItem="3" Language="de">Skipass</ListItem>
        </Comment>
        <Comment Name="customer comment">
            <Text>
                Do you allow pets? sincerely, John Doe
            </Text>
        </Comment>
        <Comment Name="additional info">
            <Text>
                This is a collective request.
            </Text>
        </Comment>
    </Comments>

    <SpecialRequests>
        <SpecialRequest CodeContext="ALPINEBITS" RequestCode="PETS">
            <Text TextFormat="PlainText">two dogs</Text>
        </SpecialRequest>
        <SpecialRequest CodeContext="HOTEL" RequestCode="LATE_CHECKOUT">
            <Text TextFormat="PlainText"></Text>
        </SpecialRequest>
    </SpecialRequests>

    <DepositPayments>
       <!--- optional payments, see below-->
    </DepositPayments>

    <CancelPenalties>
        <CancelPenalty>
            <PenaltyDescription>
                <Text>
                Cancellation is handled by hotel.
                Penalty is 50%, if canceled within 3 days before show, 100% otherwise.
                </Text>
            </PenaltyDescription>
        </CancelPenalty>
    </CancelPenalties>

    <HotelReservationIDs>
        <!-- The booking ID of the original booking source -->
        <HotelReservationID ResID_Type="14"
                            ResID_Value="XYZ0123456"
                            ResID_Source="booking.com"/>

        <!-- ResID_Type 13 -> Internet Broker -->
        <HotelReservationID ResID_Type="13"
                            ResID_Value="Slogan"
                            ResID_Source="www.example.com"
                            ResID_SourceContext="top banner" />
    </HotelReservationIDs>

    <Profiles>
        <!--- optional profiles, see below-->
    </Profiles>

    <BasicPropertyInfo HotelCode="123" HotelName="AlpineBits Hotel"/>
</ResGlobalInfo>

The mandatory ResGlobalInfo element contains:

  • One Comment element (optional) with attribute Name set to included services containing the included services given as free text fields using ListItem elements. In most cases the AlpineBits® client software will just display this to a human hotel employee with no further processing. Each ListItem element must have Language and ListItem attributes. At most one ListItem element is allowed for each combination of Language and ListItem.

  • One Comment element (optional) with attribute Name set to customer comment containing a single Text element freely filled out by the customer and fed through unchecked by the portal.

  • One Comment element (optional) with attribute Name set to additional info containing a single Text element freely filled with additional information NOT entered by the customer. In general this is used by the portal to provide useful information that is not covered by OTA elements.

  • One or more SpecialRequest elements (optional). For further specification see dedicated chapter below.

  • One DepositPayments element (optional). For further specification see dedicated chapter below.

  • Only allowed for reservations, one PenaltyDescription element (optional) containing a single Text element with no attributes that clearly states the cancellation policy the portal and the hotel have previously agreed upon and the portal has communicated to the customer - the language or languages of this text is chosen by the portal.

  • One or more HotelReservationID elements (optional) that can be used to transmit miscellaneous IDs associated with the reservation the trading partners have agreed upon. ResID_Type must be specified with a value from the OTA "Unique Id Type" list (UIT). The other attributes, ResID_Value, ResID_Source and ResID_SourceContext are all optional.
    The HotelReservationID element can be used to track the original booking ID from the system where the guest completed the reservation. This booking ID must be transmitted via the attribute ResID_Value with ResID_Type="14". It represents the second identifier of this type, while the primary ID (assigned by the channel manager) is defined in the UniqueID element (see above).
    Historically, AlpineBits® has used these fields to handle internet campaign management: in this case the agreement is to use a ResID_Type value of "13" (internet broker) and the three attributes ResID_Value, ResID_Source and ResID_SourceContext to identify, respectively, the campaign name (Slogan in our example), the campaign source (www.example.com) and the campaign marketing medium (top banner) following the scheme used by Google Analytics.

  • One Profiles element (optional). For further specification see dedicated chapter below.

  • One mandatory BasicPropertyInfo element with the mandatory HotelCode and optional HotelName attributes following the same rules of that used in the corresponding attributes in the request (see section 4.2.1).

SpecialRequest

The SpecialRequest element has the following mandatory attributes:

  • CodeContext set to ALPINEBITS or HOTEL.

  • RequestCode set to a distinct value inside of the provided CodeContext.

SpecialRequests within CodeContext ALPINEBITS must contain a predefined RequestCode value from the following list:

  • PETS providing details regarding pets

SpecialRequests within CodeContext HOTEL contain hotel-specific requests, in which the RequestCode value can be freely defined.

An SpecialRequest element can contain a single Text element (optional) with attribute TextFormat set to PlainText, stating details regarding the specific request. To express that a SpecialRequest element is explicitly not wanted by the customer, the Text element must be omitted. On the other hand it is not allowed to express absence inside of the Text element (e.g. “no pets“ or “none” should not be used). An empty Text element means that the request is wanted but provides no further details.

The absence of the whole SpecialRequest element means that the information about a potential presence of a SpecialRequest is not available (i.e. can not be guaranteed their presence nor absence).

Example A: the customer will surely bring pets described as “two dogs”.

SpecialRequest - PETS (example A)
<SpecialRequests>
    <SpecialRequest CodeContext="ALPINEBITS" RequestCode="PETS">
        <Text TextFormat="PlainText">two dogs</Text>
    </SpecialRequest>
</SpecialRequests>

Example B: the customer will surely bring pets but no further information is given.

SpecialRequest - PETS (example B)
<SpecialRequests>
    <SpecialRequest CodeContext="ALPINEBITS" RequestCode="PETS">
        <Text TextFormat="PlainText"></Text>
    </SpecialRequest>
</SpecialRequests>

Example C: the customer will surely not have any pet with him.

SpecialRequest - PETS (example C)
<SpecialRequests>
    <SpecialRequest CodeContext="ALPINEBITS" RequestCode="PETS"></SpecialRequest>
</SpecialRequests>

DepositPayments

The DepositPayments element contains one or more GuaranteePayment elements and is used to specify the information about the payments made with the booking.

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - DepositPayments element
<DepositPayments>
   <!-- example online payment -->
   <GuaranteePayment Start="2026-11-21T12:51:49" GuaranteeCode="129acd49f7db2fabc317db3d9656525">
        <AcceptedPayments>
            <AcceptedPayment GuaranteeTypeCode="46" GuaranteeID="PAYPAL" PaymentTransactionTypeCode="charge">
                <PaymentCard CardCode="VI" ExpireDate="1128">
                    <CardHolderName>Laura Sample</CardHolderName>
                    <CardNumber Mask="XXXXXXXXXXXX1234" Token="39acd49f7db2fabc317db3d969592345" TokenProviderID="PAYPAL" />
                </PaymentCard>
            </AcceptedPayment>
        </AcceptedPayments>
        <AmountPercent Amount="100" CurrencyCode="EUR" />
   </GuaranteePayment>
   <!-- example bank transfer payment -->
   <GuaranteePayment Start="2026-11-21T12:51:49" GuaranteeCode="123456">
        <AcceptedPayments>
            <AcceptedPayment GuaranteeTypeCode="28" GuaranteeID="INTESA">
                <BankAcct>
                    <BankAcctName>Laura Sample</BankAcctName>
                    <BankAcctNumber Mask="IT12XXXXXXXXXXXXXX7990">
                        <PlainText>IT12 3456 7890 1234 5678 90</PlainText>
                    </BankAcctNumber>
                </BankAcct>
            </AcceptedPayment>
        </AcceptedPayments>
        <AmountPercent Amount="100" CurrencyCode="EUR" />
   </GuaranteePayment>
   <!-- example voucher payment -->
   <GuaranteePayment Start="2026-11-21T12:51:49" GuaranteeCode="123456">
        <AcceptedPayments>
            <AcceptedPayment GuaranteeTypeCode="3" GuaranteeID="GETAVO" PaymentTransactionTypeCode="charge">
                <Voucher ElectronicIndicator="true" Identifier="XVZ-123-14050" />
            </AcceptedPayment>
        </AcceptedPayments>
        <AmountPercent Amount="100" CurrencyCode="EUR" />
   </GuaranteePayment>
   <!-- amount only pre-authorized, not charged yet -->
   <GuaranteePayment Start="2026-11-21T12:52:03" GuaranteeCode="7c1f9ab2e4d05631">
        <AcceptedPayments>
            <AcceptedPayment GuaranteeTypeCode="46" GuaranteeID="PAYPAL" PaymentTransactionTypeCode="reserve">
                <PaymentCard CardCode="VI" ExpireDate="1128">
                    <CardHolderName>Laura Sample</CardHolderName>
                    <CardNumber Mask="XXXXXXXXXXXX1234" Token="39acd49f7db2fabc317db3d969592345" TokenProviderID="PAYPAL" />
                </PaymentCard>
            </AcceptedPayment>
        </AcceptedPayments>
        <AmountPercent Amount="30" CurrencyCode="EUR" />
   </GuaranteePayment>
   <!-- part of an earlier charge given back -->
   <GuaranteePayment Start="2026-12-02T09:14:27" GuaranteeCode="129acd49f7db2fabc317db3d9656525">
        <AcceptedPayments>
            <AcceptedPayment GuaranteeTypeCode="46" GuaranteeID="PAYPAL" PaymentTransactionTypeCode="refund">
                <PaymentCard CardCode="VI" ExpireDate="1128">
                    <CardHolderName>Laura Sample</CardHolderName>
                    <CardNumber Mask="XXXXXXXXXXXX1234" Token="39acd49f7db2fabc317db3d969592345" TokenProviderID="PAYPAL" />
                </PaymentCard>
            </AcceptedPayment>
        </AcceptedPayments>
        <AmountPercent Amount="40" CurrencyCode="EUR" />
   </GuaranteePayment>
</DepositPayments>

Each GuaranteePayment element contains:

  • One AcceptedPayments element containing exactly one AcceptedPayment element. It has the mandatory GuaranteeTypeCode which refers to the OpenTravel Code List Payment Type (PMT). We currently support 28 to specify a bank transfer payment, 46 for online payments and 3 if the payment was done with a voucher. The mandatory attribute GuaranteeID is used this to identify the payment service provider and the optional PaymentTransactionTypeCode attribute is used this to specify if the amount was already charged, only reserved/pre-authorized or refunden. The allowed values ar either charge, reserve and refund.

Regarding the PaymentTransactionTypeCode the following guidelines should be considered: - The payment method and payment instrument must be identical to the previous transaction. - If the amount is identical, the payment is cancelled. If the payment differs (the refund amount must be less than or equal to the previously charged amount), a credit is initiated.

Nested under the AcceptedPayment element either an PaymentCard, BankAcct or Voucher element must be specified.

  • The PaymentCard element should be used to describe online payments made with the booking. The optional attribute CardCode is a 2 digit code that references the credit card vendor. The optional attributes ExpireDate indicates the expiration date of the credit card. The optional CardHolderName element identifies the owner of the card. And the optional CardNumber element can be used to specify more detailed data about the payment made. It has the optional attribute Mask which is used to transmit a masked representation of the card number and the optional attributes Token and TokenProviderID which can be used to transmit the data about the credit card tokenization.

  • The BankAcct element should be used to describe bank transfer payments. The optional BankAcctName could be used to specify the name of the bank accounts owner used for the transaction. And the optional BankAcctNumber can be used to describe more in detail the bank account used for the payment. It has the optional attribute Mask which is used to transmit a masked representation of the bank account number and the optional element PlainText which can be used to specify the entire bank account number.

  • The Voucher element should be used to describe payments made with a voucher. The ElectronicIndicator is mandatory and must be always true. We currently support only electronic vouchers. The mandatory Identifier element should be used to specify the unique code of the voucher.

    • One AmountPercent element with the mandatory attributes Amount and CurrencyCode. The purpose of this element is to specify total amount of the payment.

    • The mandatory attribute GuaranteeCode is used to specify the unique identifier of the payment transaction

    • The mandatory attribute Start identifies the timestamp of the payment transaction.

Profiles

The Profiles element contains one Profile element nested within a ProfileInfo element with attribute ProfileType set to "4" with information about the booking channel;

files/samples/GuestRequests/GuestRequests-OTA_ResRetrieveRS-reservation.xml - Profiles element
<Profiles>
    <ProfileInfo>
        <!-- ProfileType 4 -> Travel Agent -->
        <Profile ProfileType="4">
            <CompanyInfo>
                <CompanyName Code="123" CodeContext="ABC">
                    ACME Travel Agency
                </CompanyName>
                <AddressInfo>
                    <AddressLine>Musterstraße 1</AddressLine>
                    <CityName>Flaneid</CityName>
                    <PostalCode>12345</PostalCode>
                    <CountryName Code="IT"/>
                </AddressInfo>
                <!-- Code 1 -> Voice -->
                <TelephoneInfo PhoneTechType="1" PhoneNumber="+391234567890"/>
                <Email>info@example.com</Email>
            </CompanyInfo>
        </Profile>
    </ProfileInfo>
</Profiles>

The Profile element contains:

  • The required CompanyName element with attributes Code and CodeContext.

  • The optional AddressInfo, TelephoneInfo and Email elements: these contain the same data as the equivalent fields in the customer part (note the element names: AddressInfo and TelephoneInfo vs Address and Telephone in the customer part - also different ordering - dictated by OTA)

4.2.3. Follow-up client request (acknowledgement)

A client, upon receiving a non-empty response to its first request (OTA_Read:GuestRequests), should initiate another request, acknowledging or refusing the UniqueID values it got (referring to quotes, reservations or cancellations).

For this follow-up request, the X-AlpineBits-Action field is set to the value OTA_NotifReport:GuestRequests and the request body must contain a OTA_NotifReportRQ document.

For the refusal, a standard Warning element is used. The value of the attribute Type can be set to any value of the OTA list "Error Warning Type" (EWT). The value 3 stands for "Biz rule". The attribute Code can be set to any value present in the OTA list "Error Codes" (ERR). The value 450 stands for "Unable to process". For the acknowledgments, the client again uses the HotelReservation element, one for each ID it wishes to acknowledge.

Here is an example where a client refuses one reservation request and acknowledges three other requests.

files/samples/GuestRequests/GuestRequests-Acknowledgments-OTA_NotifReportRQ.xml
<?xml version="1.0" encoding="UTF-8"?>

<OTA_NotifReportRQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.opentravel.org/OTA/2003/05"
        xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_NotifReportRQ.xsd"
        Version="4.000">

    <Success/>

    <Warnings>
        <!-- refuse reservation with ID=f054bbd2f5ebab9 -->
        <Warning Type="3" Code="450" RecordID="f054bbd2f5ebab9">
            Unable to process reservation
        </Warning>
    </Warnings>

    <NotifDetails>
        <HotelNotifReport>
            <HotelReservations>

                <HotelReservation>
                    <!-- ACK reservation with ID="6b34fe24ac2ff810" -->
                    <UniqueID Type="14" ID="6b34fe24ac2ff810"/>
                    <ResGlobalInfo>
                       <BasicPropertyInfo HotelCode="123"/>
                    </ResGlobalInfo>
                </HotelReservation>

                <HotelReservation>
                    <!-- ACK cancellation with ID="c24e8b15ca469388" -->
                    <UniqueID Type="15" ID="c24e8b15ca469388"/>
                    <ResGlobalInfo>
                       <BasicPropertyInfo HotelCode="123"/>
                    </ResGlobalInfo>
                </HotelReservation>

                <HotelReservation>
                    <!-- ACK quote request with ID="1000000000000001" -->
                    <UniqueID Type="14" ID="1000000000000001"/>
                    <ResGlobalInfo>
                       <BasicPropertyInfo HotelCode="123"/>
                    </ResGlobalInfo>
                </HotelReservation>

            </HotelReservations>
        </HotelNotifReport>
    </NotifDetails>

</OTA_NotifReportRQ>

The following rules apply to acknowledgements:

  • For every UniqueID, the server must remember whether or not the client has acknowledged it yet.

  • It is a client’s responsibility to send the acknowledgments - if it doesn’t, it must be prepared to deal with duplicates the next time it queries the server.

Here is a sample sequence of messages exchanged between a client and a server:

time client request server response comment

08:00

action = OTA_Read:GuestRequests;
request = OTA_Read with SelectionCriteria Start today 00:00

OTA_ResRetrieveRS with UniqueID=1 (Reservation) and UniqueID=2 (Request)

the server answers with today’s two requests (1 and 2)

08:01

action = OTA_NotifReport:GuestRequests;
request = OTA_NotifReportRQ with UniqueID=1

OTA_NotifReportRS Success

server knows the client got 1, it will not be sent again

09:00

action = OTA_Read:GuestRequests;
request = OTA_Read

OTA_ResRetrieveRS with UniqueIDs 2 and 3 (Request)

the client wishes to read all new requests, 1 is not sent (since it was ack’ed), 2 is sent again and 3 is sent because it’s new

10:00

action = OTA_Read:GuestRequests;
request = OTA_Read

OTA_ResRetrieveRS with UniqueIDs 2 and 3 (Request)

same server response as at 09:00 because 2 and 3 were not ack’ed

10:01

action = OTA_NotifReport:GuestRequests;
request = OTA_NotifReportRQ with UniqueID=2, 3

OTA_NotifReportRS Success

server now knows the client got all three

11:00

action = OTA_Read:GuestRequests;
request = OTA_Read with SelectionCriteria Start today 00:00

OTA_ResRetrieveRS with UniqueIDs 1, 2 and 3 (Request)

the SelectionCriteria Start overrides the fact that all three guest requests had already been ack’ed, so the server sends all three again

4.2.4. Follow-up server response

The server will send a response indicating the outcome of the request. The response is a OTA_NotifReportRS document. Any of the four possible AlpineBits® server response outcomes (success, advisory, warning or error) are allowed.

See section 2.3 for details.

4.2.5. Implementation tips and best practice

The attribute RatePlanCode is mandatory for reservations and is meant to refer a reservation to the originating RatePlan. If reservations are not originated from an AlpineBits® Rateplan this information may be unavailable. In this case it is recommended to set the value of the RatePlanCode attribute to the string "Unknown" (with a capital "U", please note that OTA schemas do not allow an empty value for this attribute).

Both occurrences of RatePlanCode in a RoomStay, the one on RatePlan and the one on RoomRate, refer to the same rate plan and must carry the same value. Like the rate plan code they refer to (see section 4.4), they are limited to 16 characters.

Every CurrencyCode attribute must be consistent with the originating RatePlan. In case of "Unknown" RatePlan, the currency must be one supported by the hotel or previously agreed upon for communication.

If a non-standard MealsIncluded has to be transmitted, consider using the closest standard MealsIncluded combination. This needs prior agreement among the parts, which is not covered by AlpineBits®. For example in South-Tyrol some hotels offer 3/4 board (half board plus afternoon snack, hence a non-standard MealsIncluded combination) to their guests. This may be transmitted as half board, since 3/4 board replaces half board for these hotels.

The value of the PhoneNumber attribute (element Telephone) should contain the standard international format (as in +<country code><phone number>) whenever possible.

Some guidelines on how to fill the fields in the HotelReservationID and Profile / CompanyInfo elements are provided here in order to allow easier grouping of the data coming from different servers.

The attributes of the HotelReservationID attributes can be mapped to the attributes used for internet marketing like in the following table:

utm_source

ResID_Source

utm_medium

ResID_SourceContext

utm_content

not present in AlpineBits®

utm_campaign

ResID_Value

We can then distinguish different use cases - here are some examples:

1. Request or reservation via homepage

  1. Direct (user types domain into browser address bar)
    ResID_Source (utm_source) = direct
    ResID_SourceContext (utm_medium) =
    ResID_Value (utm_campaign) =
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  2. Referral link to hotel site from other website
    ResID_Source (utm_source) = otherwebsite.com
    ResID_SourceContext (utm_medium) = referral
    ResID_Value (utm_campaign) =
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  3. Referral link to hotel site from portal website with campaign infos
    ResID_Source (utm_source) = portalwebsite.com
    ResID_SourceContext (utm_medium) = referral (or exact medium type of portal, e.g. "banner", "membership", "toplinks")
    ResID_Value (utm_campaign) = [campaign-name]
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  4. Search engine organic
    ResID_Source (utm_source) = google.com
    ResID_SourceContext (utm_medium) = organic_search
    ResID_Value (utm_campaign) =
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  5. Search engine paid (e.g. Google Adwords)
    ResID_Source (utm_source) = google.com
    ResID_SourceContext (utm_medium) = cpc
    ResID_Value (utm_campaign) = [campaign-name]
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  6. Social media content link (e.g. Facebook)
    ResID_Source (utm_source) = facebook.com
    ResID_SourceContext (utm_medium) = social_media
    ResID_Value (utm_campaign) = [facebook-post]
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  7. Social media paid (e.g. Facebook Ads)
    ResID_Source (utm_source) = facebook.com
    ResID_SourceContext (utm_medium) = cpc
    ResID_Value (utm_campaign) = [campaign-name]
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  8. Newsletter
    ResID_Source (utm_source) = newsletter-[company-name]
    ResID_SourceContext (utm_medium) = email
    ResID_Value (utm_campaign) = [newsletter-name] (e.g. NL 09/2017)
    Profile / CompanyInfo (travel agent / booking channel) = homepage

  9. QR code in printed magazine
    ResID_Source (utm_source) = [magazine-name] (e.g. Bergwelten)
    ResID_SourceContext (utm_medium) = qr_code
    ResID_Value (utm_campaign) = [magazine-name-and-issue] (e.g. Bergwelten 08/2017)
    Profile / CompanyInfo (travel agent / booking channel) = homepage

2. Request or reservation via landing page

  1. Bookings/enquiries on landing pages from Google Adwords
    ResID_Source (utm_source) = google.com
    ResID_SourceContext (utm_medium) = cpc
    ResID_Value (utm_campaign) = [campaign-name]
    Profile / CompanyInfo (travel agent / booking channel) = landingpage

  2. Bookings/enquiries on landing pages from portal links
    ResID_Source (utm_source) = portalwebsite.com
    ResID_SourceContext (utm_medium) = referral (or exact medium type of portal, e.g. "banner", "membership", "toplinks")
    ResID_Value (utm_campaign) = [campaign-name]
    Profile / CompanyInfo (travel agent / booking channel) = landingpage

3. Reservation on a booking platform

  1. Bookings on booking portal (e.g. Booking.com)
    ResID_Source (utm_source) = booking.com
    ResID_SourceContext (utm_medium) =
    ResID_Value (utm_campaign) =
    Profile / CompanyInfo (travel agent / booking channel) = [booking portal name] (e.g. booking.com)

  2. Bookings/enquiries on portals (e.g. suedtirolerland.it)
    ResID_Source (utm_source) = [portal name] (e.g. suedtirolerland.it)
    ResID_SourceContext (utm_medium) =
    ResID_Value (utm_campaign) =
    Profile / CompanyInfo (travel agent / booking channel) = [portal operator] (e.g. Peer.travel)

4.2.6. Requests Push client request

Starting with AlpineBits version 2018-10, a new capability was added (action_OTA_HotelResNotif_GuestRequests) to allow a push mechanism for the GuestRequest. If the capability is exposed, the Client is capable of acting as an AlpineBits Server, and the Server is capable of acting as an AlpineBits Client. This means that a few arrangements between the two parties have to be made, and those are not negotiated through AlpineBits, namely the endpoint (URL) where the client can receive the pushed GuestRequests, its credentials, etc.

The X-AlpineBits-Action field is set to the value OTA_HotelResNotif:GuestRequests and the request body must contain a OTA_HotelResNotifRQ document.

Please note that this message does not allow to specify a HotelCode or HotelName in the root element, this information is however provided in the corresponding attributes within each Request’s BasicPropertyInfo element. All the Request exchanged with a single message must refer to the same Hotel.

The request must contain a single HotelReservations element with one or more HotelReservation elements containing the requested information. A client that has no information for the server must not initiate a transfer: an empty HotelReservations element is rejected by OTA2015A and, since release 2026-10, by the AlpineBits® schema as well. As for the content of the HotelReservation element, refer to section 4.2.2.

All the GuestRequests described above (e.g. Booking Requests, Quote Requests, Cancellations) can be pushed by using this mechanism.

4.2.7. Requests Push server response

The server will send a response indicating the outcome of the request. The response is a OTA_HotelResNotifRS document. Any of the four possible AlpineBits® server response outcomes (success, advisory, warning or error) are allowed.

See section 2.3 for details.

In case of success, the OTA_HotelResNotifRS response will contain a single, empty Success element followed by a HotelReservations element with one or more HotelReservation elements. Each HotelReservation element must contain only a single UniqueID element with the Type and ID attributes referring to one of the GuestRequests the Client sent (quotes, reservations or cancellations).

Each request that could not be processed must be listed in a Warning element, where the RecordID attribute refers to the request ID and Type and Code refer to the reason of the refusal.

If the server could process none of the requests, there is nothing to acknowledge: the HotelReservations element is then omitted altogether and the response consists of the Success element followed by a Warnings element listing every request of the batch. This is the warning outcome of section 2.3, so the client must consider the whole transfer as failed. The element must not be omitted when at least one request could be processed, and it is never empty: an empty HotelReservations element is rejected by OTA2015A and by the AlpineBits® schema.

files/samples/GuestRequests/GuestRequests-Push-OTA_HotelResNotifRS.xml
<?xml version="1.0" encoding="UTF-8"?>

<OTA_HotelResNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns="http://www.opentravel.org/OTA/2003/05"
                   xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelResNotifRS.xsd"
                   Version="6.000">

    <Success/>

    <Warnings>
        <!-- refuse reservation with ID=f054bbd2f5ebab9 -->
        <Warning Type="3" Code="450" RecordID="f054bbd2f5ebab9">Unable to process reservation</Warning>
    </Warnings>

    <HotelReservations>

        <HotelReservation>
            <!-- ACK reservation with ID="6b34fe24ac2ff810" -->
            <UniqueID Type="14" ID="6b34fe24ac2ff810"/>
        </HotelReservation>

        <HotelReservation>
            <!-- ACK cancellation with ID="c24e8b15ca469388" -->
            <UniqueID Type="15" ID="c24e8b15ca469388"/>
        </HotelReservation>

        <HotelReservation>
            <!-- ACK quote request with ID="1000000000000001" -->
            <UniqueID Type="14" ID="1000000000000001"/>
        </HotelReservation>

    </HotelReservations>

</OTA_HotelResNotifRS>

The following example shows a response to the same push in which the server could accept none of the requests: each of them is refused in a Warning element and no HotelReservations element is present.

files/samples/GuestRequests/GuestRequests-Push-OTA_HotelResNotifRS-all-refused.xml
<?xml version="1.0" encoding="UTF-8"?>

<OTA_HotelResNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                     xmlns="http://www.opentravel.org/OTA/2003/05"
                     xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelResNotifRS.xsd"
                     Version="6.000">

    <Success/>

    <Warnings>
        <!-- refuse reservation with ID="6b34fe24ac2ff810" -->
        <Warning Type="3" Code="450" RecordID="6b34fe24ac2ff810">Unable to process reservation</Warning>
        <!-- refuse cancellation with ID="c24e8b15ca469388" -->
        <Warning Type="3" Code="450" RecordID="c24e8b15ca469388">Unable to process cancellation, unknown reservation</Warning>
    </Warnings>

    <!-- no HotelReservations element: there is nothing to acknowledge -->

</OTA_HotelResNotifRS>

4.2.8. Guest Requests status update

Starting with AlpineBits® version 2022-10, clients can send status updates of a given guest request to the server.

The X-AlpineBits-Action field is set to the value OTA_HotelResNotif:GuestRequests_StatusUpdate and the request body must contain a OTA_HotelResNotifRQ document.

The request must contain a single HotelReservations element with one or more HotelReservation elements containing the guest request status update.

Each HotelReservation element must contain the mandatory attributes ResStatus and CreateDateTime (the first timestamp recorded by the client for the guest request). The possible values for the ResStatus attribute expected by AlpineBits® are:

  • Reserved - this is a booking reservation.

  • Cancelled - this is a booking cancellation.

A HotelReservation element may contain the LastModifyDateTime attribute which identifies the timestamp of modification. If the LastModifyDateTime attribute is not specified, the timestamp of the request may be used instead.

Each HotelReservation element contains a mandatory UniqueID element which itself contains the mandatory ID and Type attributes. The ID attribute must match the unique HotelReservation identifier previously sent by the server. The Type attribute is set according to the OTA Unique Id Type (UIT) list.

The Type attribute value must be consistent with the ResStatus attribute of the surrounding HotelReservation element:

  • For ResStatus = Reserved, the Type must be 14 (Reservation).

  • For ResStatus = Cancelled, the Type must be 15 (Cancellation).

Below is an example of a status update sent from a client for some guest requests.

files/samples/GuestRequests/GuestRequests-Push-OTA_HotelResNotifRQ-StatusUpdate.xml
<HotelReservations>

    <HotelReservation ResStatus="Reserved" CreateDateTime="2027-03-21T11:00:00+01:00">
        <UniqueID Type="14" ID="6b34fe24ac999999"/>
    </HotelReservation>

    <HotelReservation ResStatus="Modify" CreateDateTime="2027-04-02T09:30:00+02:00">
        <UniqueID Type="14" ID="6b34fe24ac777777"/>
    </HotelReservation>
    <HotelReservation ResStatus="Cancelled" CreateDateTime="2027-05-12T19:00:00+01:00">
        <UniqueID Type="15" ID="6b34fe24ac244444"/>
    </HotelReservation>

</HotelReservations>

The server’s response is the same as that described in Chapter 4.2.7.

4.2.9. Tabular representation of OTA_ReadRQ

Level Element Attribute Type Cardinality

OTA_ReadRQ

element

1

›

ReadRequests

element

1

› ›

HotelReadRequest

element

1

› › ›

SelectionCriteria

element

0 - 1

Start

dateTime (\S+)

1

See file files/schema-xsd/alpinebits.xsd in the AlpineBits® documentation kit.

4.2.10. Tabular representation of OTA_ResRetrieveRS

Level Element Attribute Type Cardinality

OTA_ResRetrieveRS

element

1

Start choice

›

Success

element

1

›

ReservationsList

element

1

› ›

HotelReservation

element

1 - ∞

CreateDateTime

dateTime (\S+)

1

LastModifyDateTime

dateTime (\S+)

0 - 1

ResStatus

string enum (Requested|Reserved|Cancelled|Modify)

1

RoomStayReservation

boolean (\S+)

0 - 1

› › ›

UniqueID

element

1

Type

string enum (14|15)

1

ID

string(1-32)

1

› › ›

RoomStays

element

0 - 1

› › › ›

RoomStay

element

1 - ∞

RoomStayGroupID

string(1-32)

0 - 1

› › › › 5

RoomTypes

element

0 - 1

› › › › 6

RoomType

element

1

RoomTypeCode

string(1-8)

0 - 1

RoomClassificationCode

0 - 1

RoomType

string enum (1|2|3|4|5|6|7|8|9)

0 - 1

› › › › 5

RatePlans

element

0 - 1

› › › › 6

RatePlan

element

1

RatePlanCode

string(1-16)

0 - 1

› › › › 7

Commission

element

0 - 1

Percent

0 - 1

› › › › 8

CommissionPayableAmount

element

0 - 1

Amount

decimal ([0-9]*\.?[0-9]*)

0 - 1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

0 - 1

› › › › 7

MealsIncluded

element

0 - 1

MealPlanIndicator

string enum (1|true)

1

MealPlanCodes

string enum (1|3|10|12|14)

1

› › › › 5

RoomRates

element

0 - 1

› › › › 6

RoomRate

element

1

RatePlanCode

string(1-16)

1

RoomTypeCode

string(1-8)

1

› › › › 7

Rates

element

1

› › › › 8

Rate

element

1 - ∞

EffectiveDate

date (\S+)

1

ExpireDate

date (\S+)

0 - 1

ExpireDateExclusiveInd

boolean (\S+)

0 - 1

RateTimeUnit

string enum (Day)

0 - 1

UnitMultiplier

integer ([0-9]+)

0 - 1

› › › › 9

Base

element

1

AmountAfterTax

decimal ([0-9]*\.?[0-9]*)

0 - 1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

0 - 1

› › › › 5

GuestCounts

element

0 - 1

› › › › 6

GuestCount

element

1 - 99

Count

1

Age

0 - 1

› › › › 5

TimeSpan

element

1

Start

date (\S+)

0 - 1

End

date (\S+)

0 - 1

Duration

string pattern P[0-9]+N

0 - 1

› › › › 6

StartDateWindow

element

0 - 1

EarliestDate

date (\S+)

1

LatestDate

date (\S+)

1

› › › › 5

Guarantee

element

0 - 1

› › › › 6

GuaranteesAccepted

element

1

› › › › 7

GuaranteeAccepted

element

1

› › › › 8

PaymentCard

element

1

› › › › 5

Total

element

0 - 1

AmountAfterTax

decimal ([0-9]*\.?[0-9]*)

1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

1

› › › › 5

ResGuestRPHs

element

0 - 1

› › › › 5

ServiceRPHs

element

0 - 1

› › › › 6

ServiceRPH

element

1 - ∞

RPH

string pattern [0-9]{1,8}

1

› › ›

Services

element

0 - 1

› › › ›

Service

element

1 - ∞

ID

string(1-32)

1

Type

string enum (16)

1

ServiceCategoryCode

string enum (BOARD|SUPPLEMENT|SPA|FOOD|BEVERAGE|ACTIVITY|TOURISTTAX|TRANSFER|PACKAGE|RESOURCE|OTHER)

1

ServiceInventoryCode

string(1-16)

1

ServiceRPH

string pattern [0-9]{1,8}

0 - 1

ServicePricingType

string enum (Per night|Per person|Per person per night|Per stay|Per use)

1

Inclusive

1

Quantity

1

› › › › 5

ServiceDetails

element

1

› › › › 6

GuestCounts

element

0 - 1

› › › › 7

GuestCount

element

1 - 99

Age

0 - 1

Count

1

› › › › 6

TimeSpan

element

0 - 1

Start

1

End

0 - 1

› › › › 6

Comments

element

0 - 1

› › › › 7

Comment

element

1

› › › › 8

Text

string(1-∞)

1

TextFormat

string enum (PlainText)

1

› › › › 6

Total

element

1

AmountAfterTax

decimal ([0-9]*\.?[0-9]*)

1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

1

› › › › 6

ServiceDescription

element

0 - 1

› › › › 7

Text

string(1-∞)

1

TextFormat

string enum (PlainText)

1

› › ›

ResGuests

element

0 - 1

› › › ›

ResGuest

element

1 - ∞

ResGuestRPH

string ([0-9]\{1,8})

0 - 1

› › › › 5

Profiles

element

1

› › › › 6

ProfileInfo

element

1

› › › › 7

Profile

element

1

› › › › 8

Customer

element

1

› › ›

ResGlobalInfo

element

0 - 1

› › › ›

Comments

element

0 - 1

› › › › 5

Comment

element

1 - 3

Name

string enum (included services|customer comment|additional info)

1

Start choice

› › › › 6

ListItem

string(1-∞)

0 - ∞

ListItem

integer ([0-9]+)

1

Language

([a-z][a-z])

1

End choice

Start choice

› › › › 6

Text

string(1-∞)

0 - 1

End choice

› › › ›

SpecialRequests

element

0 - 1

› › › › 5

SpecialRequest

element

1 - ∞

RequestCode

string(1-16)

1

CodeContext

string enum (ALPINEBITS|HOTEL)

1

› › › › 6

Text

element

0 - 1

TextFormat

string enum (PlainText)

1

› › › ›

DepositPayments

element

0 - 1

› › › › 5

GuaranteePayment

element

1 - ∞

Start

dateTime (\S+)

0 - 1

GuaranteeCode

string(1-32)

0 - 1

› › › › 6

AcceptedPayments

element

1

› › › › 7

AcceptedPayment

element

1

GuaranteeTypeCode

string enum (3|28|46)

0 - 1

GuaranteeID

string(1-64)

0 - 1

PaymentTransactionTypeCode

string enum (charge|reserve|refund)

0 - 1

Start choice

› › › › 8

PaymentCard

element

0 - 1

End choice

Start choice

› › › › 8

BankAcct

element

0 - 1

› › › › 9

BankAcctName

string(1-64)

0 - 1

› › › › 9

BankAcctNumber

element

1

Mask

string pattern [0-9a-zA-Z]{1,32}

0 - 1

› › › › 10

PlainText

string(1-64)

1

End choice

Start choice

› › › › 8

Voucher

element

0 - 1

ElectronicIndicator

boolean pattern 1|true

1

Identifier

string(1-64)

1

End choice

› › › › 6

AmountPercent

element

0 - 1

Amount

decimal ([0-9]*\.?[0-9]*)

1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

0 - 1

› › › ›

CancelPenalties

element

0 - 1

› › › › 5

CancelPenalty

element

1

› › › › 6

PenaltyDescription

element

1

› › › › 7

Text

string(1-∞)

1

› › › ›

HotelReservationIDs

element

0 - 1

› › › › 5

HotelReservationID

element

1 - ∞

ResID_Type

1

ResID_Value

string(1-64)

0 - 1

ResID_Source

string(1-64)

0 - 1

ResID_SourceContext

string(1-64)

0 - 1

› › › ›

Profiles

element

0 - 1

› › › › 5

ProfileInfo

element

1 - 3

› › › ›

BasicPropertyInfo

element

1

End choice

See file files/schema-xsd/alpinebits.xsd in the AlpineBits® documentation kit.

4.2.11. Tabular representation of OTA_NotifReportRQ

Level Element Attribute Type Cardinality

OTA_NotifReportRQ

element

1

›

Success

element

1

›

NotifDetails

element

0 - 1

› ›

HotelNotifReport

element

1

› › ›

HotelReservations

element

1

› › › ›

HotelReservation

element

1 - ∞

› › › › 5

UniqueID

element

1

Type

string enum (14|15)

1

ID

string(1-32)

1

› › › › 5

ResGlobalInfo

element

0 - 1

› › › › 6

BasicPropertyInfo

element

1

›

Warnings

element

0 - 1

› ›

Warning

element

1 - ∞

Type

1

Code

1

RecordID

string(1-64)

1

Status

string enum (ALPINEBITS_SEND_HANDSHAKE|ALPINEBITS_SEND_FREEROOMS|ALPINEBITS_SEND_RATEPLANS|ALPINEBITS_SEND_INVENTORY)

0 - 1

See file files/schema-xsd/alpinebits.xsd in the AlpineBits® documentation kit.

4.2.12. Tabular representation of OTA_NotifReportRS

Level Element Attribute Type Cardinality

OTA_NotifReportRS

element

1

Start choice

›

Success

element

1

End choice

See file files/schema-xsd/alpinebits.xsd in the AlpineBits® documentation kit.

4.2.13. Tabular representation of OTA_HotelResNotifRQ

Level Element Attribute Type Cardinality

OTA_HotelResNotifRQ

element

1

›

HotelReservations

element

1

› ›

HotelReservation

element

1 - ∞

CreateDateTime

dateTime (\S+)

1

LastModifyDateTime

dateTime (\S+)

0 - 1

ResStatus

string enum (Requested|Reserved|Cancelled|Modify)

1

RoomStayReservation

boolean (\S+)

0 - 1

› › ›

UniqueID

element

1

Type

string enum (14|15)

1

ID

string(1-32)

1

› › ›

RoomStays

element

0 - 1

› › › ›

RoomStay

element

1 - ∞

RoomStayGroupID

string(1-32)

0 - 1

› › › › 5

RoomTypes

element

0 - 1

› › › › 6

RoomType

element

1

RoomTypeCode

string(1-8)

0 - 1

RoomClassificationCode

0 - 1

RoomType

string enum (1|2|3|4|5|6|7|8|9)

0 - 1

› › › › 5

RatePlans

element

0 - 1

› › › › 6

RatePlan

element

1

RatePlanCode

string(1-16)

0 - 1

› › › › 7

Commission

element

0 - 1

Percent

0 - 1

› › › › 8

CommissionPayableAmount

element

0 - 1

Amount

decimal ([0-9]*\.?[0-9]*)

0 - 1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

0 - 1

› › › › 7

MealsIncluded

element

0 - 1

MealPlanIndicator

string enum (1|true)

1

MealPlanCodes

string enum (1|3|10|12|14)

1

› › › › 5

RoomRates

element

0 - 1

› › › › 6

RoomRate

element

1

RatePlanCode

string(1-16)

1

RoomTypeCode

string(1-8)

1

› › › › 7

Rates

element

1

› › › › 8

Rate

element

1 - ∞

EffectiveDate

date (\S+)

1

ExpireDate

date (\S+)

0 - 1

ExpireDateExclusiveInd

boolean (\S+)

0 - 1

RateTimeUnit

string enum (Day)

0 - 1

UnitMultiplier

integer ([0-9]+)

0 - 1

› › › › 9

Base

element

1

AmountAfterTax

decimal ([0-9]*\.?[0-9]*)

0 - 1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

0 - 1

› › › › 5

GuestCounts

element

0 - 1

› › › › 6

GuestCount

element

1 - 99

Count

1

Age

0 - 1

› › › › 5

TimeSpan

element

1

Start

date (\S+)

0 - 1

End

date (\S+)

0 - 1

Duration

string pattern P[0-9]+N

0 - 1

› › › › 6

StartDateWindow

element

0 - 1

EarliestDate

date (\S+)

1

LatestDate

date (\S+)

1

› › › › 5

Guarantee

element

0 - 1

› › › › 6

GuaranteesAccepted

element

1

› › › › 7

GuaranteeAccepted

element

1

› › › › 8

PaymentCard

element

1

› › › › 5

Total

element

0 - 1

AmountAfterTax

decimal ([0-9]*\.?[0-9]*)

1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

1

› › › › 5

ResGuestRPHs

element

0 - 1

› › › › 5

ServiceRPHs

element

0 - 1

› › › › 6

ServiceRPH

element

1 - ∞

RPH

string pattern [0-9]{1,8}

1

› › ›

Services

element

0 - 1

› › › ›

Service

element

1 - ∞

ID

string(1-32)

1

Type

string enum (16)

1

ServiceCategoryCode

string enum (BOARD|SUPPLEMENT|SPA|FOOD|BEVERAGE|ACTIVITY|TOURISTTAX|TRANSFER|PACKAGE|RESOURCE|OTHER)

1

ServiceInventoryCode

string(1-16)

1

ServiceRPH

string pattern [0-9]{1,8}

0 - 1

ServicePricingType

string enum (Per night|Per person|Per person per night|Per stay|Per use)

1

Inclusive

1

Quantity

1

› › › › 5

ServiceDetails

element

1

› › › › 6

GuestCounts

element

0 - 1

› › › › 7

GuestCount

element

1 - 99

Age

0 - 1

Count

1

› › › › 6

TimeSpan

element

0 - 1

Start

1

End

0 - 1

› › › › 6

Comments

element

0 - 1

› › › › 7

Comment

element

1

› › › › 8

Text

string(1-∞)

1

TextFormat

string enum (PlainText)

1

› › › › 6

Total

element

1

AmountAfterTax

decimal ([0-9]*\.?[0-9]*)

1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

1

› › › › 6

ServiceDescription

element

0 - 1

› › › › 7

Text

string(1-∞)

1

TextFormat

string enum (PlainText)

1

› › ›

ResGuests

element

0 - 1

› › › ›

ResGuest

element

1 - ∞

ResGuestRPH

string ([0-9]\{1,8})

0 - 1

› › › › 5

Profiles

element

1

› › › › 6

ProfileInfo

element

1

› › › › 7

Profile

element

1

› › › › 8

Customer

element

1

› › ›

ResGlobalInfo

element

0 - 1

› › › ›

Comments

element

0 - 1

› › › › 5

Comment

element

1 - 3

Name

string enum (included services|customer comment|additional info)

1

Start choice

› › › › 6

ListItem

string(1-∞)

0 - ∞

ListItem

integer ([0-9]+)

1

Language

([a-z][a-z])

1

End choice

Start choice

› › › › 6

Text

string(1-∞)

0 - 1

End choice

› › › ›

SpecialRequests

element

0 - 1

› › › › 5

SpecialRequest

element

1 - ∞

RequestCode

string(1-16)

1

CodeContext

string enum (ALPINEBITS|HOTEL)

1

› › › › 6

Text

element

0 - 1

TextFormat

string enum (PlainText)

1

› › › ›

DepositPayments

element

0 - 1

› › › › 5

GuaranteePayment

element

1 - ∞

Start

dateTime (\S+)

0 - 1

GuaranteeCode

string(1-32)

0 - 1

› › › › 6

AcceptedPayments

element

1

› › › › 7

AcceptedPayment

element

1

GuaranteeTypeCode

string enum (3|28|46)

0 - 1

GuaranteeID

string(1-64)

0 - 1

PaymentTransactionTypeCode

string enum (charge|reserve|refund)

0 - 1

Start choice

› › › › 8

PaymentCard

element

0 - 1

End choice

Start choice

› › › › 8

BankAcct

element

0 - 1

› › › › 9

BankAcctName

string(1-64)

0 - 1

› › › › 9

BankAcctNumber

element

1

Mask

string pattern [0-9a-zA-Z]{1,32}

0 - 1

› › › › 10

PlainText

string(1-64)

1

End choice

Start choice

› › › › 8

Voucher

element

0 - 1

ElectronicIndicator

boolean pattern 1|true

1

Identifier

string(1-64)

1

End choice

› › › › 6

AmountPercent

element

0 - 1

Amount

decimal ([0-9]*\.?[0-9]*)

1

CurrencyCode

string(3-3) ([a-zA-Z]{3})

0 - 1

› › › ›

CancelPenalties

element

0 - 1

› › › › 5

CancelPenalty

element

1

› › › › 6

PenaltyDescription

element

1

› › › › 7

Text

string(1-∞)

1

› › › ›

HotelReservationIDs

element

0 - 1

› › › › 5

HotelReservationID

element

1 - ∞

ResID_Type

1

ResID_Value

string(1-64)

0 - 1

ResID_Source

string(1-64)

0 - 1

ResID_SourceContext

string(1-64)

0 - 1

› › › ›

Profiles

element

0 - 1

› › › › 5

ProfileInfo

element

1 - 3

› › › ›

BasicPropertyInfo

element

1

See file files/schema-xsd/alpinebits.xsd in the AlpineBits® documentation kit.

4.2.14. Tabular representation of OTA_HotelResNotifRS

Level Element Attribute Type Cardinality

OTA_HotelResNotifRS

element

1

Start choice

›

Success

element

1

›

HotelReservations

element

0 - 1

› ›

HotelReservation

element

1 - ∞

› › ›

UniqueID

element

1

Type

string enum (14|15)

1

ID

string(1-32)

1

End choice

See file files/schema-xsd/alpinebits.xsd in the AlpineBits® documentation kit.