Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

NOTE: pmsXchange will automatically 'Error' (fail) any reservation that meets the following criteria:

  • Delivery attempts: 20 (Has been requested (OTA_ReadRQ) at least 20 times, with no valid  OTA_NotifReportRQ returned from requesting PMS.)
  • Timeout with no delivery attempts: 14 days
  • Timeout with at least 1 delivery attempt: 1 hour (starting from the time of the first delivery attempt)

IMPORTANT: The above-mentioned functionality is a fail-safe feature, we expect to always receive either a 'Success' or 'Error' OTA_NotifReportRQ. This failsafe mechanism cannot be relied upon to fail reservations when they cannot be processed.

...

OTA_NotifReportRQ Specification

Node

Number

Description

OTA_NotifReportRQ

1

Root element

@Version1Current Version 1.0

@EchoToken

1

Globally unique identifier for the request, the value will be returned in the response EchoToken.

@TimeStamp1

Time of the transaction in xml schema dateTime format.
Format like yyyy-MM-dd'T'HH:mm:ssZZ, (i.e '2021-03-09T20:05:52+08:00')

OTA_NotifReportRQ / Success

0..1

Either Success or Error element present

OTA_NotifReportRQ / Errors0..1Contains a list of errors if the reservation, modification or cancellation failed to process.
Errors / Error1..nShould be at least one node if there is an Errors Node.
@Type1

Mandatory if Error present.
Any type from the OTA code table for 'Error Warning Type (EWT)' can be used. In particular, the following types are used.

3: Biz rule (The business rules for the request message were not met)
4: Authentication error (If username and password are not authenticated)
6: Authorization error (If authenticated username is not authorized to alter hotel data)
10: Required field missing (If xml does not meet the schema, i.e missing request fields or invalid data types.)

@Code0..1Any code from the OTA code table for 'Error Codes (ERR)' can be used.

OTA_NotifReportRQ / NotifDetails / HotelNotifReport

1

Container for HotelReservations

HotelNotifReport / HotelReservations / HotelReservation

1..n

One for each reservation being confirmed

@CreateDateTime

0..1

The time the reservation was created on the PMS. Mandatory if ResStatus is "Book".

@LastModifyDateTime0..1The time the reservation was updated on the PMS. Mandatory if ResStatus is Modify or Cancel.

@ResStatus

0..1

Allowed values are "Book", "Modify" or "Cancel"

HotelReservation / UniqueID

1

The identifier of the reservation message as known to PmsXchange
The HotelReservation UniqueID of type 16 from the OTA_ResRetrieveRS response

@Type

1

Value of '16' which refers to 'Reference' in the OTA Unique Id Type (UIT) code table

@ID

1

PmsXchange identifier of the reservation

HotelReservation / ResGlobalInfo

0..1

Present if the reservation is part of a successful delivery batch

HotelReservation / ResGlobalInfo / HotelReservationIDs / HotelReservationID

1

Container for the PMS reservation identifier

@ResID_Type

1

Value of '14' which refers to 'Reservation' in the OTA Unique Id Type (UIT) code table

@ResID_Value

1

The identifier of the reservation created by the PMS

OTA_NotifReportRS

This message is sent to the PMS in response to the OTA_NotifReportRQ message. It confirms the PmsXchange processed the OTA_NotifReportRQ message successfully.

...

OTA_NotifReportRS Specification

ElementNumberType
OTA_NotifReportRS1Root element
@Version1Current version is 1.0

@EchoToken

1

Return the EchoToken from the request message.

@TimeStamp1Time of the transaction in xml schema dateTime format

OTA_NotifReportRS / Success

0..1

Either Success or Error element present

OTA_NotifReportRS / Errors0..1Contains a list of errors if the confirmation failed to process.
Errors / Error1..nShould be at least one node if there is an Errors Node.
@Type1

Mandatory if Error present.
Any type from the OTA code table for 'Error Warning Type (EWT)' can be used. In particular, the following types are used.

3: Biz rule (The business rules for the request message were not met)
4: Authentication error (If username and password are not authenticated)
6: Authorization error (If authenticated username is not authorized to alter hotel data)
10: Required field missing (If xml does not meet the schema, i.e missing request fields or invalid data types.)

@Code0..1Any code from the OTA code table for 'Error Codes (ERR)' can be used.