Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Overview

The OTA_HotelBookingRuleNotifRQ operation sends a notification of the rules and restrictions affecting the availability status of a property.

Request

Node / @Attribute

Quantity

Type

Description

OTA_HotelBookingRuleNotifRQ

1

Root element

@TimeStamp

0..1

DateTime

ISO 8601 encoded timestamp indicating the creation date and time of the message

@Version

0..1

Decimal

The OpenTravel message version indicated by a decimal value

UniqueID

0..1

The unique identifier element allows the trading partners to uniquely identify each Rate being uploaded

@Type

1

Integer

A reference to the type of object defined by the UniqueID element.

@ID

1

String

A unique identifying value assigned by the creating system

@Instance

An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated

RuleMessages

A collection of RuleMessages

@HotelCode

1

String

The code that uniquely identifies a single hotel property

@HotelName

0..1

String

A text field used to communicate the proper name of the hotel

RuleMessage

1

A collection of BookingRules

StatusApplicationControl

1

Information on what the RateAmountMessage Message applies to

@Start

1

Date

The starting value of the time span

@End

1

Date

The ending value of the time span

@Mon

0..1

Boolean

When true, apply to Monday

@Tue

0..1

Boolean

When true, apply to Tuesday

@Weds

0..1

Boolean

When true, apply to Wedsneday

@Thur

0..1

Boolean

When true, apply to Thursday

@Fri

0..1

Boolean

When true, apply to Friday

@Sat

0..1

Boolean

When true, apply to Saturday

@Sun

0..1

Boolean

When true, apply to Sunday

@RatePlanCode

1

String

A code that identifies the rate plan

@InvTypeCode

1

String

A code that identifies a room type

BookingRules

0..1

Container for the collection of Booking Rules which apply for the information indicated in the StatusApplicationControl element.A collection of BookingRule

BookingRule

1

The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination

@Start

1

Date

The starting value of the time span

@End

1

Date

The ending value of the time span

RestrictionStatus

0..1

Availability status assigned to the room rate combination

@Restriction

1

String

Identifies the restriction the status applies to

@Status

1

String

Identifies the availability status of an item

LengthsOfStay

0..1

Collection of Length of Stay elements

LengthOfStay

1

A collection of patterns defining allowable lengths of stay (LOS)

@MinMaxMessageType

String

An enumerated type used to define how the minimum and maximum LOS is applied

@Time

1

Integer

Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements

AvailableDaysOfWeek

0..1

Days of week in which the guest can stay

ArrivalDaysOfWeek

0..1

Days of week in which the guest can arrive

DepartureDaysOfWeek

0..1

Days of week in which the guest can depart

@Mon

0..1

Boolean

When true, apply to Monday

@Tue

0..1

Boolean

When true, apply to Tuesday

@Weds

0..1

Boolean

When true, apply to Wedsneday

@Thur

0..1

Boolean

When true, apply to Thursday

@Fri

0..1

Boolean

When true, apply to Friday

@Sat

0..1

Boolean

When true, apply to Saturday

@Sun

0..1

Boolean

When true, apply to Sunday

Sample

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Header>
    <HTNGHeader xmlns="http://htng.org/1.1/Header/">
      <From>
        <systemId>API Debug</systemId>
        <Credential>
          <userName>username</userName>
          <password>password</password>
        </Credential>
      </From>
      <To>
        <systemId>Convert5</systemId>
      </To>
      <echoToken>1717058372</echoToken>
    </HTNGHeader>
  </soap:Header>
  <soap:Body>
    <OTA_HotelBookingRuleNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" TimeStamp="2024-05-30T08:39:32" EchoToken="1717058372" Version="4">
      <UniqueID Type="16" ID="1522835138" Instance="DeltaLoad"/>
      <RuleMessages HotelCode="1853" HotelName="TestHotel Mahony">
        <RuleMessage>
          <StatusApplicationControl Start="2024-05-30" End="2024-06-29" RatePlanCode="EXT1" InvTypeCode="DBL"/>
          <BookingRules>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <!-- close for stay, arrival and departure -->
              <RestrictionStatus Restriction="Arrival" Status="Close"/>
              <RestrictionStatus Restriction="Departure" Status="Close"/>
            </BookingRule>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <!-- close for stay -->
              <RestrictionStatus Restriction="Stay" Status="Close"/>
            </BookingRule>
          </BookingRules>
        </RuleMessage>
        <RuleMessage>
          <StatusApplicationControl Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true" RatePlanCode="EXT1" InvTypeCode="DBL"/>
          <BookingRules>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <!-- close for stay, arrival and departure -->
              <RestrictionStatus Restriction="Master" Status="Close"/>
            </BookingRule>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <!-- close for arrival -->
              <RestrictionStatus Restriction="Arrival" Status="Close"/>
            </BookingRule>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <!-- close for departure -->
              <RestrictionStatus Restriction="Departure" Status="Close"/>
            </BookingRule>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <LengthsOfStay>
                <!-- set minLOS (on arrival) to 1, maxLOS (on arrival) to 3 -->
                <LengthOfStay Time="1" TimeUnit="Day" MinMaxMessageType="SetMinLOS"/>
                <LengthOfStay Time="3" TimeUnit="Day" MinMaxMessageType="SetMaxLOS"/>
              </LengthsOfStay>
            </BookingRule>
            <BookingRule Start="2024-05-30" End="2024-06-29">
              <DOW_Restrictions>
                <AvailableDaysOfWeek Mon="false" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
                <ArrivalDaysOfWeek Mon="true" Tue="false" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/>
                <DepartureDaysOfWeek Mon="true" Tue="true" Weds="false" Thur="true" Fri="true" Sat="true" Sun="true"/>
              </DOW_Restrictions>
            </BookingRule>
          </BookingRules>
        </RuleMessage>
      </RuleMessages>
    </OTA_HotelBookingRuleNotifRQ>
  </soap:Body>
</soap:Envelope>

Response

Node / @Attribute

Quantity

Type

Description

OTA_HotelBookingRuleNotifRS

1

Root element

@TimeStamp

0..1

DateTime

ISO 8601 encoded timestamp indicating the creation date and time of the message

@Version

0..1

Decimal

The OpenTravel message version indicated by a decimal value

Success

0..1

Indicates that the incoming request message was processed successfully

Erorrs

0..1

A collection of errors that occurred during the processing of a message

Warnings

0..1

A collection of warning that occurred during the processing of a message

Sample

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
  <soap:Header>
    <wsa:Action>OTA_HotelBookingRuleNotifRS</wsa:Action>
  </soap:Header>
  <soap:Body>
    <OTA_HotelBookingRuleNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.100" TimeStamp="2024-05-30T08:39:38Z">
      <Success/>
    </OTA_HotelBookingRuleNotifRS>
  </soap:Body>
</soap:Envelope>

  • No labels