OTA_HotelRoomListRQ / OTA_HotelRoomListRS

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

The room type structure
The rate plan 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 or the combination of the OTA_HotelDescriptiveInfoRQ/OTA_HotelDescriptiveInfoRS and OTA_HotelRatePlanRQ/OTA_HotelRatePlanRS

Endpoints

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

Example request and response

OTA_HotelRoomListRQ request

<OTA_HotelRoomListRQ PrimaryLangID="en" TimeStamp="2015-06-30T17:26:26+02: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_HotelRoomListRQ.xsd">
    <POS>
    <Source>
      <RequestorID ID="USERNAME" MessagePassword="PASSWORD" />
    </Source>
  </POS>
  <HotelRoomLists>
    <HotelRoomList HotelCode="1234abc"></HotelRoomList>
  </HotelRoomLists>
</OTA_HotelRoomListRQ>

OTA_HotelRoomListRS response

<OTA_HotelRoomListRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2015-11-19T08:37:01+01:00" CorrelationID="00Q564d7c1dc9822">
  <HotelRoomLists>
    <HotelRoomList HotelName="Hotel Monopole" HotelCode="00P5519244d6895d">
      <RoomStays>
        <RoomStay>
          <RoomTypes>
            <RoomType IsRoom="true" RoomID="00P55192452c758a">
              <RoomDescription Name="Double"/>
            </RoomType>
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanID="00P551924532f2f7" RatePlanName="Standard"/>
            <RatePlan RatePlanID="00P5519245339021" RatePlanName="Non refundable"/>
            <RatePlan RatePlanID="00P5519245344243" RatePlanName="Hot Deal"/>
          </RatePlans>
        </RoomStay>
        <RoomStay>
          <RoomTypes>
            <RoomType IsRoom="true" RoomID="00P55192452dc947">
              <RoomDescription Name="Single"/>
            </RoomType>
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanID="00P551924532f2f7" RatePlanName="Standard"/>
            <RatePlan RatePlanID="00P5519245339021" RatePlanName="Non refundable"/>
          </RatePlans>
        </RoomStay>
        <RoomStay>
          <RoomTypes>
            <RoomType IsRoom="true" RoomID="00P5519245317baa">
              <RoomDescription Name="Triple"/>
            </RoomType>
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanID="00P551924532f2f7" RatePlanName="Standard"/>
            <RatePlan RatePlanID="00P5519245339021" RatePlanName="Non refundable"/>
            <RatePlan RatePlanID="00P5566c93f87980" RatePlanName="B2B"/>
          </RatePlans>
        </RoomStay>
        <RoomStay>
          <RoomTypes>
            <RoomType IsRoom="true" RoomID="00P55a7bf24b4715">
              <RoomDescription Name="Twin"/>
            </RoomType>
          </RoomTypes>
          <RatePlans>
            <RatePlan RatePlanID="00P5566c93f87980" RatePlanName="B2B"/>
          </RatePlans>
        </RoomStay>
      </RoomStays>
    </HotelRoomList>
  </HotelRoomLists>
  <Success></Success>
</OTA_HotelRoomListRS>

Request structure

OTA_HotelRoomListRQ

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), HotelRoomLists

HotelRoomLists

Parent: OTA_HotelRoomListRQ

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: HotelRoomList

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.

HotelRoomList

Parent: HotelRoomLists

Mandatory: yes

Attributes: None

Children: None

Response structure

OTA_HotelRoomListRS

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: HotelRoomLists, Success, Warnings, Errors

HotelRoomLists

Parent: OTA_HotelRoomListRS

Mandatory: Yes

Attributes: None

Child elements: HotelRoomList

HotelRoomList

Parent: HotelRoomList

Mandatory: yes

Attributes:

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

Child elements: RoomStays

Roomstays

Parent: HotelRoomList

Mandatory: Yes

Attributes: None

Child elements: RoomStay

Roomstay

Parent: RoomStays

Mandatory: Yes

Attributes: None

Child elements: RoomTypes, RatePlans

RoomTypes

Parent: RoomStay

Mandatory: No

Attributes: None

Child elements: RoomStay

RoomType

Parent: RoomTypes

Mandatory: yes

Attributes:

Name	Mandatory	Description
IsRoom	Yes	The default value will be "true"
RoomID	Yes	The Hotel-Spider room ID

Child elements: RoomDescription

RoomDescription

Parent: RoomType

Mandatory: yes

Attributes:

Name	Mandatory	Description
Name	Yes	The name of the room type as configured in the Hotel-Spider system

Child elements: None

RatePlans

Parent: RoomStay

Mandatory: No

Attributes: None

Child elements: RatePlan

RatePlan

Parent: RatePlans

Mandatory: yes

Attributes:

Name	Mandatory	Description
RatePlanID	Yes	The Hotel-Spider rate plan ID
RoomID	Yes	The name of the rate plan as configured in the Hotel-Spider system

Child elements: None

Success

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: None

Warnings

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: None

Warning

Parent: Warnings

Mandatory: yes (If Warnings is provided)

Attributes:

Name	Mandatory	Description
Type	Yes	OTA EWT type code
Code	Yes	OTA ERR error code
Status	Yes	Possible values: NotProcessed \| Incomplete \| Complete \| Unknown
ShortText	Yes	Textual explanation of the error.

Child elements: None

Errors

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: Error

Error

Parent: Error

Mandatory: yes (If Errors is provided)

Attributes:

Name	Mandatory	Description
Type	Yes	OTA EWT type code
Code	Yes	OTA ERR error code
Status	Yes	Possible values: NotProcessed \| Incomplete \| Complete \| Unknown
ShortText	Yes	Textual explanation of the error.

Child elements: None