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_HotelProductRQ operation will return a list of products. A product comprises of RatePlans and the RoomTypes available for each RatePlan.

Request

Element / @Attribute

Quantity

Type

Description

OTA_HotelProductRQ

1

Root element.

@TimeStamp

0..1

DateTime

ISO 8601 format date string indicating the date and time the message was transmitted.

@EchoToken

0..1

String

A reference for additional message identification, assigned by the requesting host system.

@Version

0..1

Integer|Decimal

The OTA message version.

HotelProducts

1

Specifies the criteria for which hotel products should be returned.

@HotelCode

1

String

The hotel code that uniquely identifies the property in the IBE.

@HotelName

0..1

String

The hotel name that uniquely identifies the property in the IBE.

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>1716975956</echoToken>
    </HTNGHeader>
  </soap:Header>
  <soap:Body>
    <OTA_HotelProductRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2024-05-29T09:45:56" Version="4">
      <HotelProducts HotelCode="1853" HotelName="TestHotel Mahony"/>
    </OTA_HotelProductRQ>
  </soap:Body>
</soap:Envelope>

Response

Element / @Attribute

Quantity

Type

Description

OTA_HotelProductRS

1

Root Element.

Success

0..1

Indicates that the incoming request message was processed successfully.

Errors

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.

HotelProducts

1

A collection of products.

@HotelCode

1

String

The hotel code that uniquely identifies the property in the IBE.

@HotelName

0..1

String

The hotel name that uniquely identifies the property in the IBE.

HotelProduct

0..1

Specifies product information for a hotel.

RatePlans

0..1

A collection of rate plans.

RatePlan

1

An individual rate plan.

@RatePlanCode

1

String

A code that identifies the rate plan.

@RatePlanName

1

String

Provides the name of the rate plan. Typically used with RatePlanType to further describe the rate plan.

@RatePlanType

1

String

Specifies the category of rate plan. Refer to OpenTravel Code List Rate Plan Type (RPT).

@CurrencyCode

1

String

Specifies the currency code of the rate plan.

SellDateRange

0..1

The date range for which this rate plan is offered for sell.

@Start

1

Date

The starting value of the time span.

@End

1

Date

The ending value of the time span.

Descriptions

0..1

A collection of description information.

Description

0..1

Description information related to the rate plan.

Text

1

String

Text description related to rate plan.

RoomTypes

0..1

A collection of room types.

RoomType

1

An individual room type.

@RoomTypeCode

0..1

String

A code that identifies a room type.

@RoomTypeName

0..1

String

The name of the room type.

@MinAdultOccupancy

0..1

Integer

Minimum number of adults allowed in a room type.

@MaxAdultOccupancy

0..1

Integer

Maximum number of adults allowed in a room type.

@MaxChildOccupancy

0..1

Integer

Maximum number of children allowed in a room type.

@MaxInfantOccupancy

0..1

Integer

Maximum number of infants allowed in a room type.

@MaxOccupancy

0..1

Integer

Maximum number of guests allowed in a room type.

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">
   <soap:Header>
      <wsa:Action>OTA_HotelProductRS</wsa:Action>
   </soap:Header>
   <soap:Body>
      <OTA_HotelProductRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="1.100" TimeStamp="2024-05-29T09:46:02Z">
         <Success />
         <HotelProducts HotelCode="1853" HotelName="TestHotel Mahony">
            <HotelProduct>
               <RatePlans>
                  <RatePlan RatePlanCode="EXT1" RatePlanName="External Rate 1" CurrencyCode="EUR">
                     <SellDateRange Start="2000-01-01" End="2999-12-31" />
                     <Descriptions>
                        <Description>
                           <Text>This is a sample external rate</Text>
                        </Description>
                     </Descriptions>
                  </RatePlan>
               </RatePlans>
               <RoomTypes>
                  <RoomType RoomTypeCode="SGL" RoomTypeName="Single Room" MaxAdultOccupancy="1" MaxChildOccupancy="0" MaxInfantOccupancy="0" MaxOccupancy="1" />
                  <RoomType RoomTypeCode="DBL" RoomTypeName="Double Room" MaxAdultOccupancy="2" MaxChildOccupancy="1" MaxInfantOccupancy="0" MaxOccupancy="2" />
               </RoomTypes>
            </HotelProduct>
            <HotelProduct>
               <RatePlans>
                  <RatePlan RatePlanCode="EXT2" RatePlanName="External Rate 2" CurrencyCode="EUR">
                     <SellDateRange Start="2000-01-01" End="2999-12-31" />
                     <Descriptions>
                        <Description>
                           <Text>This is another sample external rate.</Text>
                        </Description>
                     </Descriptions>
                  </RatePlan>
               </RatePlans>
               <RoomTypes>
                  <RoomType RoomTypeCode="SGL" RoomTypeName="Single Room" MaxAdultOccupancy="1" MaxChildOccupancy="0" MaxInfantOccupancy="0" MaxOccupancy="1" />
                  <RoomType RoomTypeCode="DBL" RoomTypeName="Double Room" MaxAdultOccupancy="2" MaxChildOccupancy="1" MaxInfantOccupancy="0" MaxOccupancy="2" />
               </RoomTypes>
            </HotelProduct>
         </HotelProducts>
      </OTA_HotelProductRS>
   </soap:Body>
</soap:Envelope>
  • No labels