OTA_HotelResNotifRS / OTA_HotelResNotifRS

The OTA_HotelResNotifRS messages are used to send the following elements to the Hotel-Spider system:

  • Confirm the reservations / modifications / cancellations


Every time a third party software client retrieves a reservation / modifications / cancellation from the Hotel-Spider system, it is required to confirm that it has properly imported it. This can be done by using the OTA_HotelResNotifRS / OTA_HotelResNotifRS message pair. At the same time, the reservation ID, under which the reservation has been stored in the third party software client, needs to be communicated to the Hotel-Spider system.


The use of this message in an asynchronuous communication is actually a incorrect application of the OTA logic. However due to

Endpoints

Example request and response

OTA_HotelResNotifRS request
<OTA_HotelResNotifRS Version="1.000" TimeStamp="2015-12-08T18:30:47+01:00" EchoToken="123456789">
  <Success/>
  <HotelReservations>
    <HotelReservation>
      <ResGlobalInfo>
        <HotelReservationIDs>
          <HotelReservationID ResID_Source="ONLINEBOOKINGSYSTEMID" ResID_SourceContext="ONLINEBOOKINGSYSTEMNAME" ResID_Type="14" ResID_Value="ABCD-668591"/>
          <HotelReservationID ResID_SourceContext="Hotel-Spider" ResID_Type="40" ResID_Value="HOTELSPIDERRSERVATIONID"/>
          <HotelReservationID ResID_SourceContext="PMSNAME" ResID_Type="10" ResID_Value="PMSRESERVATIONID"/>
        </HotelReservationIDs>
      </ResGlobalInfo>
    </HotelReservation>
  </HotelReservations>
</OTA_HotelResNotifRS>
OTA_HotelResNotifRS request
<OTA_HotelResNotifRS Version="1.000" TimeStamp="2015-12-08T18:30:48+01:00" EchoToken="123456789">
  <Success/>
</OTA_HotelResNotifRS>

Request structure

OTA_HotelResNotifRS

Parent: None (Root element)

Mandatory: yes

Attributes:

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

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

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

VersionYes

The default value should be "1.000"

EchoTokenYesThe value will be returned in the OTA_HotelResNotifRS response

Child elements: Success, Warnings, Errors, HotelReservations


Success

Parent: OTA_HotelResNotifRS

Mandatory: no

Attributes: None

Child elements: None


HotelReservations

Parent: OTA_HotelResNotifRS

Mandatory: no

Attributes: None

Child elements: None


HotelReservation

Parent: HotelReservations

Mandatory: no

Attributes: None

Child elements: None


ResGlobalInfo

Parent: HotelReservation

Mandatory: no

Attributes: None

Child elements: None


HotelReservationIDs

Parent: ResGlobalInfo

Mandatory: no

Attributes: None

Child elements: None


HotelReservationID

Parent: HotelReservationIDs

Mandatory: yes

Attributes:

NameMandatoryDescription
ResID_TypeYes

Mandatory values are:

  • 40 (HotelSpider Confirmation ID)
  • 14 (Reservation) or 15 (Cancellation)
  • 10 (PMS Confirmation ID)

See Unique Id Type (UIT) for other possible values if needed

ResID_ValueYes

The reservation number as provided by the online booking system to the end customer/guest

ResID_SourceContextNoThe name of the online booking system
ResID_SourceYesThe ID of the online booking system as defined on the Hotel-Spider system.

Child elements: None

Use case 1: Confirming a reservation

If the third party software client imported a reservation using OTA_ReadRQ / OTA_HotelResNotifRQ or OTA_ResRetrieveRS , it needs return 1 HotelReservationID element containing the same ResID_Value, ResID_Source, ResID_SourceContext and ResID_Type="14" attribute values. In a second HotelReservationID element, a ResID_Type="40" with the ResID_Value attribute containing the Hotel-Spider internal reservation ID must be returned.

Use case 2: Confirming a cancellation

If the Hotel-Spider system imported a cancellation using OTA_ReadRQ / OTA_HotelResNotifRQ or OTA_ResRetrieveRS, it needs to return 1 HotelReservationID element containing the same ResID_Value, ResID_Source, ResID_SourceContext and ResID_Type="15" attribute values. In a second HotelReservationID element, a ResID_Type="40" with the ResID_Value attribute containing the Hotel-Spider internal reservation ID must be returned.

In all cases, a third HotelReservationID element with ResID_Type="10" and the ResID_Value attribute containing the PMS internal reservation ID must be returned.


Errors

Parent: OTA_HotelResNotifRS

Mandatory: No

Attributes: None

Child elements: Error


Error

Parent: Errors

Mandatory: yes

Attributes:

Name
Mandatory
Description
CodeYesThe unique error code assigned by the online booking system
TypeYes
StatusYes

Possible values are:

  • NotProcessed
  • Incomplete
  • Complete
  • Unknown
ShortTextYesA short textual explanation of the error
TagYesIndicates which element and/or attribute provoked the error to occur

Child elements: None



Response structure

OTA_NotifReportRS

Parent: None (Root element)

Mandatory: yes

Attributes:

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

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

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

VersionYes

The default value should be "1.000"

EchoTokenYesThe value will be returned in the OTA_HotelResNotifRS response

Child elements: Success, Warnings, Errors


Success

Parent: OTA_NotifReportRS

Mandatory: no

Attributes: None

Child elements: None


Errors

Parent: OTA_HotelResNotifRS

Mandatory: No

Attributes: None

Child elements: Error


Error

Parent: Errors

Mandatory: yes

Attributes:

Name
Mandatory
Description
CodeYesThe unique error code assigned by the online booking system
TypeYes
StatusYes

Possible values are:

  • NotProcessed
  • Incomplete
  • Complete
  • Unknown
ShortTextYesA short textual explanation of the error
TagYesIndicates which element and/or attribute provoked the error to occur

Child elements: None