OTA_HotelRatePlanRQ / OTA_HotelRatePlanRS

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

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 in combination with the OTA_HotelDescriptiveInfoRQ/OTA_HotelDescriptiveInfoRS 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_HotelRatePlanRQ
- Production: https://api.hotel-spider.com/ota/2014A/OTA_HotelRatePlanRQ
SOAP
- Staging: https://staging-api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014A/OTAService#OTA_HotelRatePlanRQ
- Production: https://api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014A/OTAService#OTA_HotelRatePlanRQ
JSON (We recommend using OTA via XML, if you want to use JSON interface please contact us)

Example request and response

OTA_HotelRatePlanRQ request

<OTA_HotelRatePlanRQ TimeStamp="2011-07-28T16:35:00" Target="Production" 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_HotelRatePlanRQ.xsd" PrimaryLangID="en">
  <POS>
    <Source>
      <RequestorID ID="USERNAME" MessagePassword="PASSWORD"></RequestorID>
    </Source>
  </POS>
  <RatePlans>
    <RatePlan>
      <HotelRef HotelCode="HOTELCODE" HotelName="HOTELNAME" />
      <DateRange Start="2018-01-01" End="2018-01-02" />
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanRQ>

OTA_HotelRatePlanRS response

<OTA_HotelRatePlanRS xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2015-11-23T13:47:20+01:00" Target="Test" Version="1.0" schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelRatePlanRQ.xsd" PrimaryLangID="en" CorrelationID="00Q56530ad885ad6">
  <Success></Success>
  <RatePlans>
    <RatePlan RatePlanCode="00P5566c93f87980">
      <Description>
        <Text>B2B</Text>
      </Description>
      <SellableProducts>
        <SellableProduct InvCode="00P5519245317baa">
          <UniqueID ID="00P564c6fdd1604b"/>
          <Description>
            <Text>Triple / B2B</Text>
          </Description>
        </SellableProduct>
        <SellableProduct InvCode="00P55a7bf24b4715">
          <UniqueID ID="00P564c6fdd15cf9"/>
          <Description>
            <Text>Twin / B2B</Text>
          </Description>
        </SellableProduct>
      </SellableProducts>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanRS>

Request structure

OTA_HotelRatePlanRQ

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

RatePlans

Parent: OTA_HotelDescriptiveInfos

Mandatory: yes

Attributes: None

Children: None

RatePlan

Parent: RatePlans

Mandatory: yes

Attributes: None

Children: HotelRef

HotelRef

Parent: RatePlan

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

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.

Response structure

OTA_HotelRatePlanRS

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, RatePlans, Errors

Success

Parent: OTA_HotelRatePlanRS

Mandatory: No

Attributes: None

Child elements: None

RatePlans

Parent: OTA_HotelRatePlanRS

Mandatory: Yes

Attributes: None

Child elements: RatePlan

RatePlan

Parent: RatePlans

Mandatory: yes

Attributes:

Name	Mandatory	Description
RatePlanCode	Yes	The Hotel-Spider rate plan ID

Child elements: Description, SellableProducts

Description

Parent: RatePlan

Mandatory: Yes

Attributes: None

Child elements: Text

Text

Parent: Description

Mandatory: Yes

Attributes: None

Child elements: None

SellableProducts

Parent: RatePlan

Mandatory: Yes

Attributes: None

Child elements: SellableProduct

SellableProduct

Parent: SellableProducts

Mandatory: yes

Attributes:

Name	Mandatory	Description
InvCode	Yes	The Hotel-Spider room ID

Child elements: UniqueID, Description

UniqueID

Parent: SellableProduct

Mandatory: yes

Attributes:

Name	Mandatory	Description
ID	Yes	The Hotel-Spider product (room type + rate plan) ID

Child elements: None

Product ID

Within the Hotel-Spider system every room type + rate plan combination is called a Product. Just like every other data entity it has its own ID: the SellableProduct ID.

Description

Parent: SellableProduct

Mandatory: Yes

Attributes: None

Child elements: Text

Text

Parent: Description

Mandatory: Yes

Attributes: None

Child elements: None