Message Description
protel I/O uses a request and response message pair to inform external system about the current protel date. With the request message external system can request the current protel date. Protel will not trigger automatically the message.
Message Attributes
IO_SystemStatusRQ
| Element | @Attribute | Type | Num | Description | Comments + Content inbound | pAir | OnPrem |
|---|---|---|---|---|---|---|
| IO_SystemStatusRQ | 1 | Request a system's status |  | | ||
| @CorrelationID | string | 1 | Used to match result messages (*RS) to request messages (*RQ), therefore mandatory. | | | |
| @Version | string | 0..1 | The version of the message. | "1.00" | | |
| @TimeStamp | dateTime | 1 | ISO DateTime of message creation | | | |
| @EchoToken | string | 0..1 | EchoToken for RQ and RS | | | |
| @PrimaryLangID | string | 0..1 | The default language of the property | ISO-639-1 (2-char code) | | |
| IO_SystemStatusRQ | StatusRequest | 1 | | | |||
| @HotelCode | string | 0..1 | HotelID of the property the system status is requested for. | | |
IO_SystemStatusRS
| Element | @Attribute | Type | Num | Description | Comments + Content Outbound | pAir | OnPrem |
|---|---|---|---|---|---|---|
| IO_SystemStatusRS | 1 | | | |||
| @CorrelationID | string | 1 | Used to match result messages (*RS) to request messages (*RQ), therefore mandatory. | | | |
| @Version | string | 0..1 | The version of the message. | "1.00" | | |
| @TimeStamp | dateTime | 0..1 | ISO DateTime of message creation | | | |
| @EchoToken | string | 0..1 | EchoToken for RQ and RS | | | |
| @PrimaryLangID | string | 0..1 | The default language of the property | ISO-639-1 (2-char code) | | |
| IO_SystemStatusRS | Success | boolean | 0..1 | The presence of the Success element explicitly indicates that the message succeeded | "true" | | |
| IO_SystemStatusRS | Warnings | Warning | 0..n | Used in conjunction with the Success element to define a business error. | | | ||
| @Type | string | 0..1 | The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT). | | | |
| @Code | string | 0..1 | If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR). | | | |
| @ShortText | string | 0..1 | Short text to describe the warning | | | |
| IO_SystemStatusRS | Warnings | Warning | Message | string | 0..1 | Description of the issue | | | |
| IO_SystemStatusRS | Errors | Error | 0..n | An error that occurred during the processing of a message. | | | ||
| @Type | string | 0..1 | The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT). | | | |
| @Code | string | 0..1 | If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR). | | | |
| @ShortText | string | 0..1 | Short text to describe the error. | | | |
| IO_SystemStatusRS | Errors | Error | Message | string | 0..1 | Description of the issue | | | |
| IO_SystemStatusRS | StatusResult | 1 | | | |||
| @HotelCode | string | 0..1 | HotelID of the property the system status is sent for | | | |
| @HotelID | string | 0..1 | Internal HotelID of the property | |  | |
| @HotelName | string | 0..1 | Full name of the property | | | |
| @ChainCode | string | 0..1 | The code that identifies a hotel chain or management group. The hotel code is decided btw vendors. The attribute is optional if the hotel is an independent property that can be identified by the HotelCode Attribute. | | | |
| @CurrentBookingDate | date | 0..1 | Current booking date of the property | "2020-08-25" | | |
| IO_SystemStatusRS | StatusResult | Status | 1..n | Name / Value pairs of several status of the property | | | ||
| IO_SystemStatusRS | StatusResult | Status | Name | string | 1 | Name of the status information | "TimeZone" | | |
| IO_SystemStatusRS | StatusResult | Status | Value | string | 1 | Value of the status information | "Europe/Berlin" | | |