@EchoToken

string

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

string

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

string

0..1

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

@PrimaryLangID

string

0..1

The default language of the property

ISO-639-1 (2-char code)

@ID

string

1

A unique identifying value assigned by the creating system. In the context of protel IO, this will be the unique hotel ID where the profile was created.

@Type

OTA_CodeType UIT

1

A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists Unique ID Type (UIT)

Unique ID Type (UIT)

@ID_Context

string

1

Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value

“protelIO”

@Primary

boolean

0..1

Indicates whether the enumerated booking channel is the primary means of connectivity used by the source.

• "true" 

• "false"

@Type

OTA_CodeType BCT

1

The type of booking channel. Refer to the OTA code lists Booking Channel Type (BCT).

Booking Channel Type (BCT)

@FiscalDate

date

0..1

This attribute transfers the actual date of the PMS system.

yyyy-mm-dd

OnPrem: by default not displayed, but if needed, it can be enabled

@ID

string

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

string

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).

Unique ID Type (UIT)

@ChainCode

string

0..1

The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors.

@HotelCode

string

0..1

The code that uniquely identifies a single hotel property. 

@HotelCodeContext

string

0..1

A text field used to communicate the context.

"protelIO"

@HotelName

string

0..1

A text field used to communicate the proper name of the hotel.

@Type 

OTA_CodeType UIT

1

A reference to the type of object defined by the UniqueID element. Refer to OpenTrave Code list UIT.

Unique ID Type (UIT)

@ID

string

1

A unique identifying value assigned by the creating system. 

@ID_Context

string

1

Used to identify the source of the identifier.

"protelIO"

@RoomID

string

0..1

A string value representing the unique identification of a room

@IsRoom

boolean

1

Indicates the room is a guest room when true.

• "true"

• "false"

@RoomID

string

0..1

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

@RoomTypeCode

string

0..1

Indicates the category of the room.

@RoomType

string

0..1

A code value that indicates the type of room for which  this request is made e.g - double, king etc. Values may use the Hotel Descriptive.Content table or a codes specific to the property or hotel brand.

@Name

string

0..1

In case the description repeats, this will allow to define the information that is being sent.

e.g. "Description"

@TextFormat

PlainText

0..1

Indicates the format of the text used in the description

"PlainText"

@EffectiveDate

dateTime

0..1

Date of arrival (CI date)

e.g. 2019-03-21T12:00:00+01:00

@ExpireDate

dateTime

0..1

Departure Date (CO date)

e.g. 2019-03-22T12:00:00+01:00

@RoomStatus

RoomStatusType

0..1

The current room status defined with an integer. 

(would normally be 1 = Dirty)

IO Types#RoomStatusType

@RoomID

string

0..1

A string value representing the unique identification of a room

@IsRoom

boolean

1

Indicates the room is a guest room when true.

@RoomID

string

0..1

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

@RoomTypeCode

string

0..1

Indicates the category of the room.

@RoomType

string

0..1

A code value that indicates the type of room for which  this request is made e.g - double, king etc. Values may use the Hotel Descriptive.Content table or a codes specific to the property or hotel brand.

@Name

string

0..1

In many case the description repeats , this will allow you to define the information that is being sent , typically used when multiple occurrences of Paragraph Type are being sent .

@TextFormat

PlainText

0..1

Indicates the format of the text used in the description 

"PlainText"

@EffectiveDate

dateTime

0..1

Check in date

@ExpireDate

dateTime

0..1

Check out date 

@RoomStatus

RoomStatusType

0..1

The current room status defined with an integer. 

(would normally be 1 = Dirty)

IO Types#RoomStatusType

@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

1

Version of the message

@PrimaryLangID

xs.language

1

Default language of the property.

Example: "en"

@Type 

OTA_CodeType

1

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

Error Warning Type (EWT)

@Code 

OTA_CodeType

0..1 

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

Error Codes (ERR)

@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."

@Type 

OTA_CodeType

1

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

Error Warning Type (EWT)

@Code 

OTA_CodeType

0..1 

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

Error Codes (ERR)

@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."