Message Description

protel I/O uses this request and response message pair to notif external systems about room status. This message can be used by external system to send Room status (cleaning) transfer via phone, PBX to PMS.

Message Attributes

HTNG_HotelRoomStatusUpdateNotifRQ

| Source | RequestorIDThis identifies the system that is sending the reservation

Element | @Attribute

Type

Num

Description

Comments + Content outbound

pAIR

OnPrem

Comments + Content inbound

pAIR

OnPrem

HTNG_HotelRoomStatusUpdateNotifRQ

1

Root element of the message.

@EchoToken

stringStringLength1to128

0..1

A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns.

@CorrelationID

stringStringLength1to64

1

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp

dateTime

1

Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock

(e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

YYYY-MM-DDThh:mm:ssZ

@Version

stringdecimal

0..1

For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.

HTNG_HotelRoomStatusUpdateNotifRQ | POS

0..1

Point of sale object.

HTNG_HotelRoomStatusUpdateNotifRQ | POS | Source

1..10

Provides information on the source of a request.

HTNG_HotelRoomStatusUpdateNotifRQ | POS | Source | RequestorID

0..1

This identifies the system that is sending the room status update.

@Type

OTA_CodeType UIT

1

A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type

HTML
<a href="https:/

@Type

OTA_CodeType UIT

1

A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@ID

StringLength1to32

1The ID will transfer the HotelID @ID

string

1The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.

@ID_Context

stringStringLength1to32

0..1Used to identify where the ID comes from.“protelIO”

“protelIO”

HTNG_HotelRoomStatusUpdateNotifRQ | POS | Source | BookingChannel
0..1This element is used to pass the booking source for the message. To send secondary booking channel information an additional Source element needs to be sent.

@TypeOTA_CodeType BCT1Indicates the type of booking channel. Refer to OpenTravel Code List Booking Channel Type (BCT).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810183" target="_blank">Booking Channel Type (BCT)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810183" target="_blank">Booking Channel Type (BCT)</a>

@Primaryboolean0..1Primary attribute would be set to “true” if only one booking channel is transferred. Only one source should be marked “true” if multiple sources are sent.

"true"
"false"

"true"
"false"

HTNG_HotelRoomStatusUpdateNotifRQ | POS | Source | TPA_Extensions
0..1Allows extensions to be added to the OpenTravel specification per trading partner agreement.

HTNG_HotelRoomStatusUpdateNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions
1Used to transport extensions on POS level for the system which initiated the transaction.the transaction.

@FiscalDatedate0..1This attribute transfers the actual date of the PMS system.yyyy-mm-dd

-

HTNG_HotelRoomStatusUpdateNotifRQ | UniqueID
0..1The unique identifier element allows the trading partners to uniquely identify each room status update message.

@ID

StringLength1to32

1

A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.

@ID_Context

StringLength1to32

1

Used to identify where the ID comes from.

"protelIO"

@Type

OTA_CodeType UIT

1

A reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UIT).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

HTNG_HotelRoomStatusUpdateNotifRQ | UniqueID | CompanyName

@FiscalDatedate0..1This attribute transfers the actual date of the PMS system.yyyy-mm-ddIdentifies the company that is associated with the UniqueID

-

HTNG_HotelRoomStatusUpdateNotifRQ | UniqueID1The unique identifier element allows the trading partners to uniquely identify each.@Code
0..1Identifies a company by the company code"2794"

@ID

string

1

@CodeContext
0..1Identifies the context of the identifying code, such as DUNS, IATA or internal code, etc."protelIO"A unique identify value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.

@CompanyShortName
0..@ID_Context

string

1Used to identify where the ID comes from."protelIO"provide the company common name

"protelIO"

@Type

OTA_CodeType UIT

1

@TravelSector
0..1The travel sector the company is associated with, such as air, car and hotelA reference to the type of object defined by the UniqueID element. Refer to Open Travel Code List Unique ID Type (UITTravel Sector (TVS).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=

117810178

117825146" target="_blank"

>Unique

>Travel

ID

Sector

Type

UIT

TVS)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=

117810178

117825146" target="_blank"

>Unique

>Travel

ID Type

Sector (

UIT

TVS)</a>

HTNG_HotelRoomStatusUpdateNotifRQ | PropertyInfo

1

The HotelReferenceGroup identifies a specific hotel. The codes used are agreed upon by trading partners.

@ChainCode

stringStringLength1to8

0..1The code that identifies a hotel chain or management group. n/a

@HotelCode

stringStringLength1to16

0..1The code that uniquely identifies a single hotel property.

@HotelCodeContext

stringStringLength1to32

0..1A text field used to communicate the context.protelIO

@HotelName

stringStringLength1to128

0..1A text field used to communicate the name of the hotel."protel_IO_Testhotel_pAir_2000053"

HTNG_HotelRoomStatusUpdateNotifRQ | Room

1

Used to convey information about a single room or a suite comprised of room components.

@RoomID

stringStringLength1to64

0..1

(string) room number

"0820"

HTNG_HotelRoomStatusUpdateNotifRQ | Room | TelephoneExtensions

0..1

A collection of telephone extensions.

HTNG_HotelRoomStatusUpdateNotifRQ | Room | TelephoneExtensions | TelephoneExtention

string

1..n

A telephone extention that is part of a single room or a suite of component rooms.

"0820"

HTNG_HotelRoomStatusUpdateNotifRQ | Room | HKStatus

HTNG_HousekeepingStatusType

0..1

The current housekeeping status of the room.

HTML
<a href="https://confluence.protel.net/display/PIODOC/HTNG_HousekeepingStatusType" target="_blank">HTNG_HousekeepingStatusType</a>

HTML
<a href="https://confluence.protel.net/display/PIODOC/HTNG_HousekeepingStatusType" target="_blank">HTNG_HousekeepingStatusType</a>

HTNG_HotelRoomStatusUpdateNotifRQ | Room | RoomType
0..1Provides details regarding rooms, usually guest rooms.

@IsRoom

boolean

0..1Indicates the room is a sleeping room if true.IsRoom = "true" - regular room
IsRoom = "false" - pseudo room

IsRoom = "true" - regular room
IsRoom = "false" - pseudo room

@RoomID

stringStringLength1to64

0..1A string value representing the unique identification of a room if the request is looking for a specific room.

@RoomTypeCode

stringStringLength1to64

0..1A code value that indicates the type of room for which this request is made."SUP"

"SUP"

@RoomType

StringLength1to16

0..1A code value that indicates the type of room for which this request is made.

@RoomType@NumberOfUnitsstringinteger0..1A code value that indicates the type of room for which this request is madeThe number of rooms that have been combined to create this room type.

HTNG_HotelRoomStatusUpdateNotifRQ | Room | RoomType | RoomDescription
0..1Textual information regarding the room."Superior King Studio"

"Superior King Studio"

@NamestringStringLength1to640..1Defines the information that is being sent.

HTNG_HotelRoomStatusUpdateNotifRQ | Room | RoomType | RoomDescription | Text
0..nFormatted text content.

@TextFormatPlainText0..1Indicates the format of text used in the description.

HTNG_HotelRoomStatusUpdateNotifRQ | Room | TPA_Extensions

0..1

A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement.

HTNG_HotelRoomStatusUpdateNotifRQ | Room | TPA_Extensions | px:RoomStatusExtensions

0..1

Holds additional information about a room's status.

HTNG_HotelRoomStatusUpdateNotifRQ | Room | TPA_Extensions | px:RoomStatusExtensions | px:HouseKeepingInfo

0..1

Attribute for room status transfer from PBX to PMS.

@RoomStatus

RoomStatusType

0..1

An integer that shows the current room status.

HTML
<a href="https://confluence.protel.net/display/PIODOC/IO+Types#IOTypes-RoomStatusType" target="_blank">IO Types#RoomStatusType</a>

HTML
<a href="https://confluence.protel.net/display/PIODOC/IO+Types#IOTypes-RoomStatusType" target="_blank">IO Types#RoomStatusType</a>

HTNG_HotelRoomStatusUpdateNotifRS

Element | @Attribute

Type

Num

Description

Comments + Content outbound

pAIR

OnPrem

Comments + Content inbound

pAIR

OnPrem

HTNG_HotelRoomStatusUpdateNotifRS

1

Root element of the message.

@EchoToken

StringLength1to128

0..1

A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

@CorrelationID

StringLength1to64

0..1

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp

xs:dateTime

1

Timestamp of the transaction.

@Version

xs:decimal

0..1

Version of the message

@PrimaryLangID

xs.language

0..1

Default language of the property.

Example: "en"

HTNG_HotelRoomStatusUpdateNotifRS | Success

1

Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors.

HTNG_HotelRoomStatusUpdateNotifRS | Warnings

0..1

Collection of warnings.

HTNG_HotelRoomStatusUpdateNotifRS | Warnings | Warning

1..n999

Used when a message has been successfully processed to report any warnings or business errors that occurred.

@Type

OTA_CodeType EWT

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>

@Code

OTA_CodeType ERR

0..1

Refers to the OTA Code List: Error Codes (ERR).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

@RecordID

StringLength1to64

0..1

If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here.

@ShortText

StringLength1to64

0..1

Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided."

HTNG_HotelRoomStatusUpdateNotifRS | Errors

1

A collection of errors that occurred during the processing of a message.

HTNG_HotelRoomStatusUpdateNotifRS | Errors | Error

1..n99

Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.

@Type

OTA_CodeType EWT

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>

@Code

OTA_CodeType ERR

0..1

Refers to the OTA Code List: Error Codes (ERR).

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>

@RecordID

StringLength1to64

0..1

If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here.

@ShortText

StringLength1to64

0..1

Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided."

Target audience	PBX, In-room systems, Kiosk, Housekeeping
Version	3.0
Authentication	Bearer Token
Message type	Asynchronous, Push
Direction	Inbound, Outbound

Seitenhierarchie

Versionen im Vergleich

Alte Version 3

Neue Version Aktuell

Schlüssel

Message Description

Message Attributes

HTNG_HotelRoomStatusUpdateNotifRQ

HTNG_HotelRoomStatusUpdateNotifRS

Seitenhierarchie

Seitenhistorie

Versionen im Vergleich

Alte Version 3

Neue Version Aktuell

Schlüssel

Message Description

Message Attributes

HTNG_HotelRoomStatusUpdateNotifRQ

HTNG_HotelRoomStatusUpdateNotifRS