OTA_HotelDescriptiveInfoRQ / OTA_HotelDescriptiveInfoRS

The OTA_HotelDescriptiveInfo messages are used to request the following elements in the Hotel-Spider system:

The room type structure

Prior to establishing a connection between a third party software client and the Hotel-Spider servers, the room types and rate plans need to be mapped. For this purpose, a third party software provider can use either this request/response pair in combination with the OTA_HotelRatePlanRQ/OTA_HotelRatePlanRS request/response pair or the OTA_HotelRoomListRQ/OTA_HotelRoomListRS request/response pair.

Endpoints

HTTP RAW POST
- Staging: https://staging-api.hotel-spider.com/ota/2014A/OTA_HotelDescriptiveInfoRQ
- Production: https://api.hotel-spider.com/ota/2014A/OTA_HotelDescriptiveInfoRQ
SOAP
- Staging: https://staging-api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014A/OTAService#OTA_HotelDescriptiveInfoRQ
- Production: https://api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014B/HTNG_ARIAndReservationPushService#OTA_HotelDescriptiveInfoRQ
JSON (We recommend using OTA via XML, if you want to use JSON interface please contact us)

Example request and response

OTA_HotelDescriptiveInfoRQ request

<OTA_HotelDescriptiveInfoRQ PrimaryLangID="en" TimeStamp="2011-07-27T14:57:00" Target="Test" Version="1.000" xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelDescriptiveInfoRQ.xsd">
  <POS>
    <Source>
      <RequestorID ID="USERNAME" MessagePassword="PASSWORD">
      </RequestorID>
    </Source>
  </POS>
  <HotelDescriptiveInfos>
    <HotelDescriptiveInfo HotelCode="HOTELCODE" HotelName="HOTELNAME">
      <FacilityInfo SendGuestRooms="true" />
    </HotelDescriptiveInfo>
  </HotelDescriptiveInfos>
</OTA_HotelDescriptiveInfoRQ>

OTA_HotelDescriptiveInfoRS response

<OTA_HotelDescriptiveInfoRS xmlns="http://www.opentravel.org/OTA/2003/05" PrimaryLangID="en" TimeStamp="2015-11-23T13:14:21+01:00" Target="Test" Version="1.0" schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelDescriptiveInfoRQ.xsd" CorrelationID="0025653031d8eb32">
  <Success></Success>
  <HotelDescriptiveContents>
    <HotelDescriptiveContent HotelName="Hotel Monopole">
      <FacilityInfo>
        <GuestRooms>
          <GuestRoom Language="en" MaxAdultOccupancy="2" MaxChildOccupancy="2" MaxOccupancy="2" MinOccupancy="1" RoomTypeName="Double" Sort="1" Quantity="50" ID="00P55192452c758a">
            <TypeRoom StandardOccupancy="2" Composite="0" Quantity="50"/>
          </GuestRoom>
        </GuestRooms>
      </FacilityInfo>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveInfoRS>

Request structure

OTA_HotelDescriptiveInfoRQ

Parent: None (Root element)

Mandatory: yes

Attributes:

Name

Mandatory

Description

TimeStamp

Yes

The format should respect the ISO 8601 2015-11-16T22:23:48+00:00

Target

Yes

When sending updates to the staging environment "Test" must be used.

When sending updates to the production environment "Production" must be used.

Version

Yes

The default value should be "1.000"

Child elements: POS (when using POS authentication. See Authentication methods for more information), HotelDescriptiveInfos

HotelDescriptiveInfos

Parent: OTA_HotelDescriptiveInfos

Mandatory: yes

Attributes: None

Children: None

HotelDescriptiveInfo

Parent: HotelDescriptiveInfos

Mandatory: yes

Attributes:

Name	Mandatory	Description
HotelCode	No	The Hotel-Spider hotel ID which you are updating
HotelName	No	This attribute can be used for readability.

Child elements: FacilityInfo

Identifying one single property

Should the third party software provider have received credentials that grant access to multiple properties then the HotelCode attribute must be provided. Should a third party software provider not know whether or not it has access to multiple properties on the Hotel-Spider system, you can safely provide the HotelCode attribute.

FacilityInfo

Parent: HotelDescriptiveInfo

Mandatory: yes

Attributes:

Name	Mandatory	Description
SendGuestRooms	Yes	The default value should be "true"

Child elements: FacilityInfo

Other possibilities of OTA_HotelDescriptiveInfoRQ

Other elements and attributes are available in the OTA_HotelDescriptiveInfoRQ. However they are not of any use in the scenario of PMS / XML connectivity.

Response structure

OTA_HotelDescriptiveInfoRS

Parent: None (Root element)

Mandatory: yes

Attributes:

Name	Mandatory	Description
TimeStamp	Yes	The format will respect the ISO 8601 2015-11-16T22:23:48+00:00
Target	Yes	The same value, used in the request, will be returned.
Version	Yes	The value wil be "1.000"

Child elements: Success, HotelDescriptiveContents, Errors

Success

Parent: OTA_HotelDescriptiveInfoRS

Mandatory: No

Attributes: None

Child elements: None

HotelDescriptiveContents

Parent: OTA_HotelDescriptiveInfoRS

Mandatory: Yes

Attributes: None

Child elements: HotelRoomList

HotelDescriptiveContent

Parent: HotelDescriptiveContents

Mandatory: yes

Attributes:

Name	Mandatory	Description
HotelCode	Yes	The Hotel-Spider hotel ID for which the third party software has requested the room structure
HotelName	Yes	This attribute is used for readability only

Child elements: FacilityInfo

FacilityInfo

Parent: HotelDescriptiveContent

Mandatory: Yes

Attributes: None

Child elements: GuestRooms

GuestRooms

Parent: FacilityInfo

Mandatory: Yes

Attributes: None

Child elements: GuestRoom

GuestRoom

Parent: GuestRooms

Mandatory: yes

Attributes:

Name	Mandatory	Description
Language	Yes	The default value will be "true"
MinOccupancy	Yes	The minimum possible occupancy for this room type
MaxOccupancy	Yes	The maximum possible occupancy for this room type
RoomTypeName	Yes	The name of the room type as defined in the Hotel-Spider system
Sort	Yes	Which positiion within a list
Quantity	Yes	The maximum number of available rooms of this type that can be set on a daily basis
ID	Yes	The Hotel-Spider room ID

Child elements: TypeRoom

TypeRoom

Parent: GuestRoom

Mandatory: yes

Attributes:

Name	Mandatory	Description
StandardOccupancy	Yes	The default occupancy for this room type
Composite	Yes	The default value will be "0"
Quantity	Yes	The maximum number of available rooms of this type that can be set on a daily basis

Child elements: None

Default occupancy & room based pricing

For channels that only work with room based pricing, the Hotel-Spider will only transmit the price for the default occupancy.