Вы находитесь на странице: 1из 211

Fidelio Cruise Software GmbH

Borselstrasse 16c
22765 Hamburg, Germany
Tel: +49(0) 40 39807 0
Fax: +49(0) 40 39807 300
e-Mail: sales@fcruise.com

Universal Interface
Technical Specification
Version 7.00.0xx

Copyright
1995-2014 Fidelio Cruise Software GmbH. All rights reserved. No part of this publication may be reproduced,
photocopied, stored on a retrieval system, or transmitted without the express prior written consent of the publisher. Fidelio
Cruise Software GmbH retains the right to update or change the contents of this document without prior notice Fidelio
Cruise Software GmbH assumes no responsibility for the contents of this document. Information in this document is
subject to change without notice. Fidelio Cruise Software GmbH makes no warranty of any kind with regard to this
material, including but not limited to the implied warranties of marketability and fitness for a particular purpose. Fidelio
Cruise Software GmbH shall not be liable for errors contained herein or for incidental or consequential damages in
connection with the furnishing, performance, or use of this material.
Universal Interface Technical Specification 7.00.0xx

Page 1 of 211

Revision History
Version

Date

Description

7.00.0001

7-Jun-2013

Add New Field PGI for PhoneCheckOut and


ExtCheckOut
Add ACE=P for Folio
Add ECD for InquireResponse
Add ACT, ECD for GetPictureResponse,
PictureChange

Teng Le Woi

7.00.0002
7.00.0012
7.00.0016

8-Jun-2013
25-Sep-2013
14-Nov-2013

Teng Le Woi
Teng Le Woi
Teng Le Woi

7.00.0017

15-Nov-2013

7.00.0017
7.00.0017

19-Nov-2013
21-Nov-2013

7.00.0019
7.00.0033

3-Dec-2013
19-Mar-2014

7.00.0038
7.00.0040
7.00.0044

17-Jun-2014
13-Aug-2014
2-Oct-2014

Add EOC for SystemDateChange


Add RunReport
Add NAT, VGD for PhoneCheckIn
Add VGD for PhoneCheckOut and
PhoneCabinMove
Add StartPbx and EndPbx
Add ChangeCabin and
ChangeCabinResponse
Change PhoneCheckIn->CHG from Y and
empty to Y and N
Add PLM for FolioResponse
Add QBP for InquireResponse
Add QBP and ACE for UpdateEMail
Add POI for PaymentResponse
Add PGIx for PostingResponse,
PaymentResponse
Add BID, BPI, PN2 for FolioResponse
Add RRZ, RID, LUG for FolioResponse
Remove SPALocation,
SPALocationResponse,
SPATreatmentGroup,
SPATreatmentGroupResponse,
SPATreatmentItem,
SPATreatmentItemResponse,
SPATreatmentAvailable,
SPATreatmentAvailableResponse,
SPABooking, SPABookingResponse

Universal Interface Technical Specification 7.00.0xx

Author

Teng Le Woi

Teng Le Woi
Teng Le Woi
Teng Le Woi
Teng Le Woi
Teng Le Woi
Teng Le Woi
Teng Le Woi

Page 2 of 211

Contents
Revision History ............................................................................................................................. 2
Contents .......................................................................................................................................... 3
General Overview ........................................................................................................................... 6
Introduction..................................................................................................................................... 7
Connections .................................................................................................................................... 8
Serial Asynchronous Connection.................................................................................................. 8
Modem Connection......................................................................................................................... 9
Network Connection (using TCP/IP protocol) ............................................................................... 9
Message Data Flow ....................................................................................................................... 10
Message Format ........................................................................................................................... 11
Message Components .................................................................................................................. 11
Message Data Block ..................................................................................................................... 12
Message Data Block Type ............................................................................................................ 13
Message Types ............................................................................................................................. 14
Interface Types ............................................................................................................................. 22
Point Of Sales ............................................................................................................................... 22
Call Accounting ............................................................................................................................ 22
Public Telephone Exchange ........................................................................................................ 23
Interactive TV ................................................................................................................................ 24
Dining Room ................................................................................................................................. 25
Time and Attendance.................................................................................................................... 25
Message Types Data Block .......................................................................................................... 26
Inquire ........................................................................................................................................... 26
InquireResponse........................................................................................................................... 28
Posting1 ......................................................................................................................................... 40
PostingResponse1 ........................................................................................................................ 45
Posting2 ......................................................................................................................................... 49
PostingResponse2 ........................................................................................................................ 54
Payment......................................................................................................................................... 57
PaymentResponse ........................................................................................................................ 60
Folio ............................................................................................................................................... 63
FolioResponse .............................................................................................................................. 65
Excursions .................................................................................................................................... 68
ExtExcursions ............................................................................................................................... 69
ExcursionsResponse ................................................................................................................... 71
Booking ......................................................................................................................................... 76
BookingResponse ........................................................................................................................ 80
ExcPackage................................................................................................................................... 83
ExcPackageResponse .................................................................................................................. 84
BookingPackage ........................................................................................................................... 90
BookingPackageResponse .......................................................................................................... 94
ExcFolio......................................................................................................................................... 97
ExcFolioResponse ........................................................................................................................ 98
Call ............................................................................................................................................... 101
CallResponse .............................................................................................................................. 104
CabinStatus................................................................................................................................. 106
PhoneCheckIn ............................................................................................................................. 107
PhoneCheckOut .......................................................................................................................... 110
Universal Interface Technical Specification 7.00.0xx

Page 3 of 211

PhoneCabinMove ........................................................................................................................ 112


PhoneResponse.......................................................................................................................... 115
EnablePhone ............................................................................................................................... 116
DisablePhone .............................................................................................................................. 119
ExtCheckIn .................................................................................................................................. 121
ExtCheckOut ............................................................................................................................... 126
ExtCabinMove ............................................................................................................................. 128
ChangeAirConState .................................................................................................................... 130
ClockIn ........................................................................................................................................ 131
ClockOut...................................................................................................................................... 133
SysMsgReq ................................................................................................................................. 135
SysMsg ........................................................................................................................................ 136
MessageLight .............................................................................................................................. 138
Messages .................................................................................................................................... 140
MessageList ................................................................................................................................ 141
SetPIN .......................................................................................................................................... 143
GetPIN ......................................................................................................................................... 145
PINDetails .................................................................................................................................... 146
UpdatePIN ................................................................................................................................... 148
GetPromoMessage ..................................................................................................................... 150
GetPromoMessageResponse .................................................................................................... 151
Events .......................................................................................................................................... 154
ExtEvents .................................................................................................................................... 155
EventsResponse ......................................................................................................................... 157
EventBooking.............................................................................................................................. 161
EventBookingResponse ............................................................................................................. 164
EventFolio ................................................................................................................................... 167
EventFolioResponse .................................................................................................................. 168
UDFRead ..................................................................................................................................... 171
UDFReadResponse .................................................................................................................... 172
UDFUpdate .................................................................................................................................. 174
UDFUpdateResponse ................................................................................................................. 176
GetCruiseItinerary ...................................................................................................................... 177
GetCruiseItineraryResponse...................................................................................................... 178
SystemDateChange .................................................................................................................... 180
SystemCruiseChange ................................................................................................................. 181
GetExchangeRate ....................................................................................................................... 183
GetExchangeRateResponse ...................................................................................................... 184
GetPicture ................................................................................................................................... 186
GetPictureResponse................................................................................................................... 187
PictureChange ............................................................................................................................ 191
The message detail is identical to GetPictureResponse ......................................................... 191
UpdateEMail ................................................................................................................................ 192
RunReport ................................................................................................................................... 194
RunReportResponse .................................................................................................................. 196
PhoneStart .................................................................................................................................. 197
PhoneEnd .................................................................................................................................... 198
ChangeCabin .............................................................................................................................. 199
ChangeCabinResponse .............................................................................................................. 200
Acknowledge .............................................................................................................................. 201
Failure.......................................................................................................................................... 202
SPMS Events ............................................................................................................................... 205
FC Management .......................................................................................................................... 205
FC Quick Check In ...................................................................................................................... 207
Universal Interface Technical Specification 7.00.0xx

Page 4 of 211

FC ETix Check In, FC Self Check In and FC Security ............................................................... 208


FC Administration ....................................................................................................................... 209
Definitions, Acronyms, and Abbreviations ............................................................................... 210
References .................................................................................................................................. 211

Universal Interface Technical Specification 7.00.0xx

Page 5 of 211

General Overview
The purpose of this document is to explain the Fidelio Cruise Universal Interface (FCUI) provides
descriptions of the connections types, standard transmission frame formats, the external system
request or response messages formats, the Fidelio Cruise Shipboard Property Management System
(FCSPMS) request or response message formats

ACTION: Action item

NOTE: Note of interest

TIP: Tip

WARNING: Warning

Universal Interface Technical Specification 7.00.0xx

Page 6 of 211

Introduction
Fidelio Cruise Universal Interface (FCUI) provides descriptions of the connections types, standard
transmission frame formats, the external system request or response messages formats, the Fidelio
Cruise Shipboard Property Management System (FCSPMS) request or response message formats.
Fidelio Cruise Engineers and Customer Analysts should use this manual, as a
developing programs required interfacing external software with the FCSPMS.
technical information, this chapter is useful to the Customer Analysts and Fidelio
Engineers as it defines the technical requirements necessary to establish the
interface.

Universal Interface Technical Specification 7.00.0xx

reference aid in
As a source of
Cruise Software
communications

Page 7 of 211

Connections
The following is a description of communication methods FCUI can use to exchange information
with external systems:

Serial Asynchronous Connection


The most common, serial asynchronous connection is implemented in FCUI to provide
communications with external systems. One serial cable is required to connect directly two
computers (FCUI computer and external system computer). Any serial port on FCUI can be used for
the connection.
During FCUI and external system installation the parameters are agreed and implemented. The
following is a description of serial line parameters and their values required providing reliable
connection between systems.

Baud Rate
(Bits Per Second)

Specifies the speed of data stream passed between FCUI and external system. The
speed can be set to any value supported by serial ports on both computers. Typical
rates are 9600 BPS (default for FCUI, most common used), 19200 BPS, 28800 BPS,
38400 BPS, 57600 BPS, 115200 BPS and higher. A higher rate does not always mean
faster communication - it also depends on cable length and environment
(electromagnetic noise).

Data Bits

Specifies data bits within one byte. Older systems used 7 bits per byte, nowadays 8
bits per byte are used (default for FCUI, most common used).

Parity

Specifies the parity option used to communicate. FCUI default value for the parameter
is None.

Stop Bits

Specifies number of stop bits to be used to verify communication transmission. FCUI


default value for the parameter is 1.

Flow Control

Specifies communication control link characters maintained by the computer operating


system. FCUI default value for the parameter is None.

Universal Interface Technical Specification 7.00.0xx

Page 8 of 211

Modem Connection
Modem connection (dial-up) can be used to interface with systems that are out of the range of serial
asynchronous connection. This connection can be used for long distance communication.
During normal operation it is expected the line is open at least for the full message transmission.
However, both systems (FCUI and external system) must be able to make a phone call to start
communication and restart communication whenever the line is dropped. Both systems must also
be able to recover from unexpected communication errors (including restart of the serial port).
Standard HAYES compatible commands are used to call, retry call, initiate, send and terminate
connection and they depend on the modem type installed. Serial port parameters set to
communicate with modem depend also on the model installed.

Network Connection (using TCP/IP protocol)


Network provides the most reliable and fastest method that can be used to communicate between
different systems. FCUI support TCP/IP protocol connection to an external system. This connection
is available only when both systems are physically and logically available on the same network
(directly or through gateways/routers, Internet, Intranet).
During FCUI and external system installation the parameters are agreed and implemented. The
following is a description of parameters and their values required providing reliable connection
between systems.
FCUI and External System Computer
Name

Uniquely identifies computers on the network and is set during


operating system installation. It is recommended not to use space
character (20H) when assigning computer name.

FCUI and External System Computer


IP Addresses

Uniquely identifies computer on the network (through its IP


address) and is set typically during operating system installation. It
is highly recommended to make this address fixed and not to use
any dynamically provided addresses.

FCUI and External System Computer


IP Ports

Identifies which IP port a computer is listening to start


communication. The default value for the FCUI that will be used
when listening is set to 2001.

Microsoft Message Queue


1. We only support transactional message queue
2. It only for response message, the message type supported is InquireResponse,
PostingResponse and GetPictureResponse (by option), if ITV MSMQ is enable, all message
will response to MSMQ and Acknowledge will response via TCP/IP or Serial
3. It only applied to PBX and ITV for trigger message.
4. All trigger event can configure to send to MSMQ instead of TCP/IP or Serial.

Universal Interface Technical Specification 7.00.0xx

Page 9 of 211

Message Data Flow


The communication is fully asynchronous i.e. FCUI will send or receive new messages without
waiting for reply to messages already received or send. There are no ACK or NAK communication
characters, reply or lack of reply message is used instead. The application level timeout should be
programmable between 1 and 100 seconds. During FCUI and external system installation timeout is
agreed and implemented. Internally FCUI expects to receive the whole message within 1 second. If
no reply is received, message sender will retry to send the message up to 3 times after which the
message should be aborted and the necessary application-dependent error handling should be
executed.
There is no length definition for data fields, only the maximum recommended length for character
based fields. The recommended length can be extended without notice. When the character field is
considered too long it is truncated to fit maximum recommended length.
Some of the fields will not always be available or implemented in the external system. Fields that
are marked as "Required" () are necessary for the message to be accepted, "Optional" fields can
be skipped.
Additional fields can be added to different messages defined, without notice. External system
should make sure it accepts all the fields defined and skips any unrecognized fields.

Universal Interface Technical Specification 7.00.0xx

Page 10 of 211

Message Format
Message Components
This section describes structure and content of all messages send or received by the FCUI. Add
data messages have the format as below:
STX <TYPE> <DATA> ETX <CHECKSUM>
The following is a description of the individual message components.
Message

Description

STX

Start of Text, serves as a message lead-in character that identifies the start of a new
message. The STX character is represented by the hexadecimal value 02H.

<TYPE>

The field identifies type of message. Message types are fixed and defined in
Message Types section. The length of <TYPE> message is variable and is a
function of message type defined.

<DATA>

The field contains message data block. Characters within a block can be in range
20H through FFH, 1FH. Each field in the message starts with a US character
followed by code that identifies the information and number that identifies sequence
of repeated data fields within message. The parameters within the <DATA> can
vary based on the message type. Field sequence is not important.

ETX

End of Text, serves as a data field lead-out character that identifies the end of the
message data block. The ETX character is represented by the hexadecimal value
03H.

<CHECKSUM>

Contains the checksum characters of the message. This field is a character (in the
range 00H through FFH) calculated from all the characters, including STX and ETX.
Every ASCII value of such character is XOR-ed with the next one.

Universal Interface Technical Specification 7.00.0xx

Page 11 of 211

Message Data Block


<DATA> block consists of fields with values assigned. The format of all the fields is described
below:
US <FLDIDN> <FLDSQN> = <FLDVAL>
The following is a description of the individual data block components.
Data Block

Description

US

Unit Separator, field separator within message data block. It indicates the beginning
of the new field. The US character is represented by the hexadecimal value 1FH.

<FLDIDN>

Field data type identifier. Field types are described for every message separately.
The <FLDIDN> identifier is always 3 characters long.

<FLDSQN>

Field sequence number within data block for messages where the same fields can
be repeated. Not present for messages with one appearance of the field. The
number should start with digit 1 and increase by 1.

The character is used to separate field identifier from value.

<FLDVAL>

Value assigned to the field.

Universal Interface Technical Specification 7.00.0xx

Page 12 of 211

Message Data Block Type


Message data block types for both request and response messages are detailed in terms of field
format. The field description identifies the way in which the data is interpreted. The following is a
description of the four field format data types.
Data Type

Description

Unsigned numeric ASCII character field (without decimal point). Maximum value
accepted 2E31.

9.9

Signed numeric ASCII character field (with decimal point). Dot (.) is always used to
separate integer and fractional part of a number. Maximum value accepted 1E308.
The sign is in front of a value (positive values do not require plus sign).

Date/Time character field. Time part can be skipped. Format accepted: YYYY-MMDD HH:NN:SS where:

X(x)

YYYY Full year including century.


MM Numeric equivalent of month.
DD Numeric equivalent of day.
HH Numeric equivalent of hour in 24-hour format.
NN Numeric equivalent of minutes.
SS Numeric equivalent of seconds.

Alphanumeric ASCII character field. All characters represented by the ASCII


characters in the range 20H through FFH. Numeric values within such fields are
processed rather as string not value. The value "x" defines maximum recommended
length of a field.

Universal Interface Technical Specification 7.00.0xx

Page 13 of 211

Message Types
Message types describe information included in the <DATA> field within the message. Message
types are case insensitive. The following is a description of message types defined.

Message Type

Description

Inquire

This message type is used to request the information from the FCSPMS. If
the identification field does not exist the response will be Failure. Otherwise
the message InquireResponse will be sent.

InquireResponse

This message type is used to respond to the Inquire message. The


response will typically include cabin and name of passengers (or account
name).

Posting1

This message type is used to send general charges, but NOT call charges
to the FCSPMS system. Posting will be made and PostingResponse1
message will be sent if only one account (guest, crew member etc.)
matches the criteria defined in the message. Posting will NOT be made and
PostingResponse1 with a list of accounts (guests, crew members etc.) will
be sent back if more than one account matching criteria is found. If posting
is not accepted the response will be Failure.

PostingResponse1

This message type is used to respond to the Posting1 message. The


response is logically the same as InquireResponse.

Posting2

This message type is used to send general charges AND call charges to the
FCSPMS system. Posting will be made and PostingResponse2 message
will be sent if only one account (guest, crew member etc.) matches the
criteria defined in the message.
Posting will NOT be made and PostingResponse2 with a list of accounts
(guests, crew members etc.) will be sent back if more than one account
matching criteria is found. If posting is not accepted the response will be
Failure.

PostingResponse2

Message type is used to respond to the Posting2 message.

Payment

Message type is used to send payments to the FCSPMS system. Payments


will be made and PaymentResponse message will be sent if only one
account (guest, crew member etc.) matches the criteria defined in the
message. Payment will NOT be made and PaymentResponse with a list of
accounts (guests, crew members etc.) will be sent back if more than one
account matching criteria is found. If payment is not accepted the response
will be Failure.

Universal Interface Technical Specification 7.00.0xx

Page 14 of 211

Message Type

Description

PaymentResponse

Message type is used to respond to the Payment message. The response


is logically the same as PostingResponse1.

Folio

Message type is used to request postings/payments list for an account from


the FCSPMS. If the identification field does not exist the response will be
Failure. Otherwise the message FolioResponse will be sent.

FolioResponse

Message type is used to respond to the Folio message. The response will
typically include list of postings/payments for a selected account.

Excursions

Message type is used to request list of excursions from the FCSPMS. If no


excursion is found the response will be Failure. Otherwise the message
ExcursionsResponse will be sent.

ExtExcursions

Message type is used to request list of excursions from the FCSPMS. If no


excursion is found the response will be Failure. Otherwise the message
ExcursionsResponse will be sent.

ExcursionsResponse

Message type is used to respond to the Excursions & ExtExcursions


message. The response will typically include list of excursions that are
available for a specified period.

Booking

Message type is used to send excursion booking to the FCSPMS system.


Booking will be made, charge applied and BookingResponse message will
be sent if only one account (guest, crew member etc.) matches the criteria
defined in the message. Booking will NOT be made and
BookingResponse with a list of accounts (guests, crew members etc.) will
be sent back if more than one account matching criteria is found. If booking
is not accepted the response will be Failure.

BookingResponse

Message type is used to respond to the Booking message. The response


is logically the same as PostingResponse1.

ExcFolio

Message type is used to request list of booked excursions for an account


from the FCSPMS. If the identification field does not exist the response will
be Failure. Otherwise the message ExcFolioResponse will be sent.

ExcFolioResponse

Message type is used to respond to the ExcFolio message. The response


will typically include list of all excursions booked for a selected account.

Call

Message type is used to send phone call charges to the FCSPMS system.
Posting will be made and CallResponse message will be send back. Call
posting will be always accepted except when parameters are improperly
set-up or double posting is detected. In those cases the response will be
Failure.

Universal Interface Technical Specification 7.00.0xx

Page 15 of 211

Message Type

Description

CallResponse

Message type is used to respond to the Call message. The response is


logically the same as InquireResponse.

CabinStatus

Message type is used to inform cabin status change. Fidelio System will
respond with the Acknowledge message type if status is successfully
changed or Failure message type if otherwise.

PhoneCheckIn

Message type is used to send request to telephone exchange system to


open phone lines and (optionally) register new person with the phone line.
Telephone exchange system must confirm the command was received with
PhoneResponse message. If the command cannot be executed external
system should respond with Failure command.

PhoneCheckOut

Message type is used to send request to telephone exchange system to


close phone lines and (optionally) un-register a person previously registered
with the line. The message is send each time person is checked-out from
FCSPMS system. However, the command includes also the flag that
informs if the last person has been checked-out from the phone line.
Telephone exchange system must confirm the command was received with
PhoneResponse message. If the command cannot be executed external
system should respond with Failure command.

PhoneCabinMove

Message type is used to send request to telephone system to enable the


new cabin and disable the old cabin in order to retain the voice mail and
wakeup call, instead of CheckIn and CheckOut. Telephone exchange
system must confirm the command was received with PhoneResponse
message. If the command cannot be executed external system should
respond with Failure command.

PhoneResponse

Message is received from external system as a confirmation for successful


execution of Phone commands.

EnablePhone

Message type is used to unblock the phone instead of checking in the


phone. Telephone exchange system must confirm the command was
received with PhoneResponse message. If the command cannot be
executed external system should respond with Failure command.

DisablePhone

Message type is used to block the phone instead of checking out the phone.
Telephone exchange system must confirm the command was received with
PhoneResponse Message.
If the command cannot be executed external system should respond with
Failure command.

ExtCheckIn

Message type is used to send Check In information to the external system


based on the InquireResponse message format. External System has to
respond with the Acknowledge message type.

Universal Interface Technical Specification 7.00.0xx

Page 16 of 211

Message Type

Description

ExtCheckOut

Message type is used to send Check Out information to the external


system. External System has to respond with the Acknowledge message
type.

ExtCabinMove

Message type is used to send Cabin Change information to the external


system. External System has to respond with the Acknowledge message
type.

ChangeAirConState

Message type is sent by the FCUI to supply the information to the


external system to change the Air conditional status. External System
has to respond with the Acknowledge message type.

ClockIn

Message is received from external time attendance system when a crew


member is logged or reported in for duty the Acknowledge will be sent
upon received of this message

ClockOut

Message is received from external time attendance system when a crew


member is logged or reported out from duty. The Acknowledge will be sent
to inform external system of a successful received.

SysMsgReq

Message type is used to send request for System Message to FCSPMS.


The reply will be sent with SysMsg.

SysMsg

Message type is used to send the System Message to the external system
when SysMsgReq is received.

MessageLight

Message type is used to send information to the external system for


switching on or off the message light. External System has to respond with
the Acknowledge message type.

Messages

Message type is used to send request for Guest Message to FCSPMS. The
reply will be sent with MessageList.

MessageList

Message type is used to send the list of Messages for the Account specified
by the external system when Messages is received.

Acknowledge

Message type is used for receiving Success or Failure from the external
system for ExtCheckIn, ExtCheckOut & ExtCabinMove messages.

Failure

Message type is used to inform sender the command send was not
accepted or was not correctly transmitted. Message describing failure is
provided.

Universal Interface Technical Specification 7.00.0xx

Page 17 of 211

Message Type

Description

SetPIN

Message type is used to set the PIN code of an account in FCSPMS from
external system. Fidelio System will respond with the Acknowledge
message type if status is successfully changed or Failure message type if
otherwise, with proper reason.

GetPIN

Message type is used to send PIN details to external system of the inquired
account and response will be based on the PINDetails message type.

UpdatePIN

Message type is used to inform external system if there is a change of PIN


code of an account. External System has to respond with the Acknowledge
message type.

SPALocation

SPALocation message type is used to request the SPA Location from the
FCSPMS.
There is 5 message type regard to SPA Booking, each must be call in the
following sequence.
1. Call the SPALocation
2. Call the SPATreatmentGroup
3. Call the SPATreatmentItem
4. Call the SPATreatmentAvailability
5. Call the SPABooking

SPATreatmentGroup

SPATreatmentGroup message type is used to request the SPA Treatment


Group from the FCSPMS.
SPATreatmentItem message type is used to request the SPA Treatment
Item from the FCSPMS
SPATreatmentAvailability message type is used to request the SPA
Treatment Availability (time slot) from the FCSPMS
SPABooking message type is used to make a SPA Booking
GetPromoMessage message type is used to request list of promotion
available from the FCSPMS
Events message type is used to request a list of events available from the
FCSPMS
ExtEvents message type is used to request list of events available from the
FCSPMS
EventBooking message type is sent to the FCUI to insert event booking and
post event charge
EventFolio message type is used to request list of events booked on a
specific account in FCSPMS
UDFRead message type is sent to the FCUI to read the user define type of
a passenger
UDFUpdate message type is sent to the FCUI to update the user define
type of a passenger
GetCruiseItinerary message type is send to the FCUI to get list of cruise
information
Message type is used to send request to external exchange system to
information Fidelio system date had changed. External system must confirm
the command was received with Acknowledge message.
Message type is used to send request to external exchange system to
information Fidelio system cruise had changed. External system must
confirm the command was received with Acknowledge message.
GetExchangerate message type is send to the FCUI to get list of active
exchange rate
GetPicture message type is send to the FCUI to get the guest picture

SPATreatmentItem
SPATreatmentAvailability
SPABooking
GetPromoMessage
Events
ExtEvents
EventBooking
EventFolio
UDFRead
UDFUpdate
GetCruiseItinerary
SystemDateChange

SystemCruiseChange
GetExchangeRate
GetPicture

Universal Interface Technical Specification 7.00.0xx

Page 18 of 211

Message Type
PictureChange
UpdateEmail
PhoneStart
PhoneEnd

Description
Message type is used to send request to ITV and Dining system to inform
them the guest picture had changed.
UpdateEmail message type is send to the FCUI to update the guest
onboard e-mail account
PhoneStart message type is send from FC Admin Batch Check In/Out to
indicate start of batch PBX check-in process
PhoneEnd message type is send from FC Admin Batch Check In/Out to
indicate end of batch PBX check-in process

Universal Interface Technical Specification 7.00.0xx

Page 19 of 211

For the period of full message transmission communication link is to be open. Whole message is
dropped if any part is interrupted during transmission. The following communication message types
are treated as a full message:
Message in blue is those message initialize by the external system.
Message in red is those message trigger by SPMS application.
Inquire InquireResponse / Failure
Posting1 PostingResponse1 / Failure
Posting2 PostingResponse2 / Failure
Payment PaymentResponse / Failure
Folio FolioResponse / Failure
Excursions ExcursionsResponse / Failure
ExtExcursions ExcursionsResponse / Failure
Booking BookingResponse / Failure
ExcFolio ExcFolioResponse / Failure
Call CallResponse / Failure
PhoneCheckIn PhoneResponse / Failure
PhoneCheckOut PhoneResponse / Failure
PhoneCabinMove PhoneResponse / Failure
EnablePhone PhoneResponse / Failure
DisablePhone PhoneResponse / Failure
ExtCheckIn Acknowledge
ExtCheckOut Acknowledge
ExtCabinMove Acknowledge
ChangeAirConState Acknowledge
ClockIn Acknowledge
ClockOut Acknowledge
SysMsgReq SysMsg
MessageLight Acknowledge
Messages MessageList
SetPIN Acknowledge
GetPIN PINDetails
UpdatePIN Acknowledge
SPALocation SPALocationResponse / Failure
SPATreatmentGroupSPATreatmentGroupResponse / Failure
SPATreatmentItemSPATreatmentItemResponse / Failure
SPATreatmentAvailabilitySPATreatmentAvailabilityResponse / Failure
SPABookingSPABookingResponse / Failure
GetPromoMessageGetPromoMessageResponse / Failure
EventsEventsResponse / Failure
ExtEventsEventsResponse / Failure
EventBookingEventBookingResponse / Failure
EventFolioEventFolioResponse / Failure
UDFReadUDFReadResponse / Failure
UDFUpdateUDFUpdateResponse / Failure
GetCruiseItinerary->GetCruiseItineraryResponse/ Failure
SystemDateChange Acknowledge
SystemCruiseChange Acknowledge
GetExchangeRate->GetExchangeRateResponse / Failure
GetPicture->GetPictureResponse / Failure
PictureChange->Acknowledge
UpdateEMail Acknowledge
Universal Interface Technical Specification 7.00.0xx

Page 20 of 211

PhoneStart Acknowledge
PhoneEnd Acknowledge

Universal Interface Technical Specification 7.00.0xx

Page 21 of 211

Interface Types
FCUI is designed to provide communication between FCSPMS and different external systems. The
following is a description of interface systems currently served and messages that has to be
implemented in every external system:

Point Of Sales
The system is used to charge for items sold to customers at different sales locations. Following
message types must be implemented in the POS system to interface properly with FCUI. If Call
Accounting - Call is in used, user should use message format in Posting1 and PostingResponse1.
Otherwise, Posting2 and PostingResponse2 are used for both general and call posting.
Inquire
InquireResponse
Posting1
PostingResponse1
Posting2
PostingResponse2
Failure

Call Accounting
The system is used to charge for phone calls. Its functionality can be combined with Public
Telephone Exchange functionalities. Following message types must be implemented in the Call
Accounting system to interface properly with FCUI. Note that Failure command informs about
critical problems and can be only expected during installation. It should not appear during daily
FCUI usage.
Call
CallResponse
Failure

Universal Interface Technical Specification 7.00.0xx

Page 22 of 211

Public Telephone Exchange


The system is used to enable/disable cabin calls, charge for mini bar consumption, order wake-up,
receives cabin maintenance status. Its functionality can be combined with Call Accounting
commands. Following message types must be implemented in the PBX system to interface properly
with FCUI. When a person is moved from one cabin to another commands PhoneCheckOut and
PhoneCheckIn are send to PBX system or PhoneCabinMove can be sent instead, with a
parameter. Note that Failure command informs about critical problems and can be only expected
during installation. It should not appear during daily FCUI usage.
CabinStatus
PhoneCheckIn
PhoneCheckOut
PhoneCabinMove
PhoneResponse
MessageLight
Messages
MessageList
Failure
EnablePhone
DisablePhone
SetPIN
GetPIN
UpdatePIN
ChangeAirConState
SystemDateChange
SystemCruiseChange

Universal Interface Technical Specification 7.00.0xx

Page 23 of 211

Interactive TV
The system is used to charge for items sold and accepted payments from customers. Following
message types must be implemented in the iTV system to interface properly with FCUI.
Inquire
InquireResponse
Posting1
PostingResponse1
Posting2
PostingResponse2
Payment
PaymentResponse
Folio
FolioResponse
Excursions
ExtExcursions
ExcursionsResponse
Booking
BookingResponse
CabinStatus
ExcFolio
ExcFolioResponse
ExtCheckIn
ExtCheckOut
ExtCabinMove
MessageLight
Messages
MessageList
Acknowledge
Failure
SetPIN
GetPIN
UpdatePIN
SystemDateChange
SystemCruiseChange
GetExchangeRate
GetPicture
PictureChange
UpdateEMail

Universal Interface Technical Specification 7.00.0xx

Page 24 of 211

Dining Room
The system is used to charge for items sold and accepted payments from customers, handle special
requests, etc. Following message types must be implemented in the Dining Room system to
interface properly with FCUI.
Inquire
InquireResponse
Posting1
PostingResponse1
Posting2
PostingResponse2
Payment
PaymentResponse
Folio
FolioResponse
CabinStatus
ExtCheckIn
ExtCheckOut
ExtCabinMove
Messages
MessageList
Acknowledge
Failure
SetPIN
GetPIN
UpdatePIN
SystemDateChange
SystemCrusieChange
GetExchangeRate
GetPicture
PictureChange
UpdateEMail

Time and Attendance


The system used to log down the clocked in and out of crew member that is on/off duty. Its
purposed is to restrict the crew from going offshore when he is reported on duty during that period
of time. When a clocked in is logged, a shore denied list will be created for this user until the next
time he is clocked out from duty.
ClockIn
ClockOut

NOTE: The System Message can be requested by any of the external systems.

Universal Interface Technical Specification 7.00.0xx

Page 25 of 211

Message Types Data Block


Inquire
Inquire message type is used to request the information from the FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status

ACT

X(1)

Account Type

Optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
RES_STATUS translated to
R/C/A/D/S
RES_TAG

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.

Universal Interface Technical Specification 7.00.0xx

Page 26 of 211

ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
N
I
G
E
T
M
H
X
R
F
S
P

Card identification number (RES_BOARDCC)


Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)
Name of a person or company account(UXP_A_NAME_N)
Internal identification number (UXP_A_ID)
Group Id number (RES_GRP)
External identification number (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)
Internal Id number(UXP_C_INTERNALID)
Guest Category(GCT_CODE)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Manning Number/Safety Number
Pre generated Random Number (RES_PGID)

ACS
The field identifies the account current reservation status. The following status values were defined:
R
C
A
D
S
E

Reservations
Checked-In
Active (Reservations and Checked-in)
Disembarked
Disembarked Residents (Owners Valid only for ResidenSea)
Checked-In and all Reservation for the current cruise

ACT
The field identifies the account type. The following account types are defined:
If this field is ignore of blank then it will return all type.
P
R
C
G
V
A
S
Z

Example
Message

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

<STX>Inquire<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-11
14:10:23<US>ACI=0123<US>ACE=A<US>ACS=R<ETX><CHECKSUM>
<STX>Inquire<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-11
14:10:23<US>ACI=0123<US>ACE=A<US>ACS=R<US>ACT=P <ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 27 of 211

InquireResponse
InquireResponse message type is sent by the FCUI to supply the information in response to an
inquiry request from an external system. The message returns only accounts (people) that are
checked-in.
Code

Type

Description

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

Current date and time

ACIx

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

ENBx

Account Enabled

UXP_A_POSTING

NAMx

X(52)

Salutation, Forename and Surname

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME

CABx

X(6)

Cabin Number

optional

RES_CAB

EMBx

Embarkation Date

DISx

Disembarkation Date

DOBx

Date of birth

optional

UXP_H_BIRTHD

EMLx

X(50)

E-mail address

optional

UXP_H_EMAIL

BALx

9.9

Balance

(UXP_A_POS_DEBIT
UXP_A_POS_CREDIT)

FSTx

X(30)

First Name

UXP_A_FSTN

LSTx

X(30)

Last Name

UXP_A_NAME

SALx

X(15)

Salutations

UXP_A_SALUT

TTLx

X(15)

Title

UXP_A_TITEL

GNDx

X(1)

Gender

UXP_H_SEX

MINx

X(1)

Minor

Parameter Adult Min Age


compared to Birthdate

LANx

X(2)

Language

UXP_H_LANG

STAx

X(2)

Reservation Status

RES_STATUS translated to
E/C/D

GRPx

9,X(30)

Group Id & Description [IdDescription]

optional

RES_GRP + UXP_A_NAME

CATx

X(500)

Category Id & Description [Id


Description; IdDescription]

optional

GCT_CODE +
TYP_GCT.TYP_COMMENT

Universal Interface Technical Specification 7.00.0xx

Required

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts
RES_DIS_E for expected &
checked in accounts,
RES_DIS_A for checked out
accounts

Page 28 of 211

Code

Type

Description

Required

SPMS DB Field reference

ADDx

X(30)

Address

optional

UXP_A_STREET

STRx

X(30)

Street

optional

UXP_A_STREET2

CTYx

X(30)

City

optional

UXP_A_CITY

ZIPx

X(10)

ZIP Code

optional

UXP_A_ZIP

STTx

X(20)

State

optional

UXP_A_STATE

CTRx

X(6)

Country Code

optional

UXP_A_COUNTRY

TELx

X(30)

Telephone Number

optional

UXP_H_TELNO

Credit Limit

optional

Credit limit as per assigned


credit department code,
unless individual credit limit is
assigned in UXP_A_CRELIM

Ships e-Mail Id

optional

RES_EMAIL_SHIP

PIN Code

optional

RES_PIN_CODE

Authorization Key

optional

Refer to PAR Value for PARInterfaces-AuthKey Criteria

CLMx

9.9

SMLx

X(72)

PINx

AKYx

X(4)

BIDx

X(100)

Booking ID

optional

RES_BOOKNR

SIDx

X(15)

Shore ID

optional

RES_SHOREID

VGDx

X(50)

Unique Guest ID

optional

RES_V_GUESTID

AWDx

X(6)

Award Level

optional

RES_AWARD_LEVEL

BCCx

X(20)

On board Cabin Card

optional

RES_BOARDCC

ROIx

Routed Account ID

optional

RES_QROUTE_ACC

POSx

Routed Account Enable

optional

UXP_A_POSTING(refer to
the payer)

NATx

X(6)

Passport Nationality

optional

UXP_H_PASSPI_COUNTRY

PICx

Guest Picture (Unlimited Length)

optional

SEC_IMAGE

GIDx

X(15)

Group ID

optional

CSWx

X(100)

Cabin Steward Name

optional

HADx

X(1000)

Handicap Description Separate by


ASCII 28

RES_HANDICAPCODE

HARx

X(50)

Handicap Remarks

RES_HANDIREMARKS

MSTx

X(50)

Muster Station Description

MST_NAME

SHRx

X(1)

Onboard/Shoreside status

RES_OFFBOARD

SFTx

X(20)

Safety Number

optional

UXP_C_POS

SMCx

X(6)

Safety Muster Station Code

optional

ORG_ASSEMBLY(linked to
MST_ID)

Universal Interface Technical Specification 7.00.0xx

RES_SHOREID(refer to
Group)
RES_ACC (linked to
CAB_KEEPER)

Page 29 of 211

Code

Type

Description

Required

SPMS DB Field reference

SMNx

X(50)

Safety Muster Station Description

optional

MST_NAME

EC1x

X(6)

Emergency Muster Station Code 1

optional

ORG_E_MST1(linked to
MST_ID)

EN1x

X(50)

Emergency Muster Station Description


1

optional

MST_NAME

EC2x

X(6)

Emergency Muster Station Code 2

optional

ORG_E_MST2(linked to
MST_ID)

EN2x

X(50)

Emergency Muster Station Description


2

optional

MST_NAME

EC3x

X(6)

Emergency Muster Station Code 3

optional

ORG_E_MST3(linked to
MST_ID)

EN3x

X(50)

Emergency Muster Station Description


3

optional

MST_NAME

EC4x

X(6)

Emergency Muster Station Code 4

optional

ORG_E_MST4(linked to
MST_ID)

EN4x

X(50)

Emergency Muster Station Description


4

optional

MST_NAME

EC5x

X(6)

Emergency Muster Station Code 5

optional

ORG_E_MST5(linked to
MST_ID)

EN5x

X(50)

Emergency Muster Station Description


5

optional

MST_NAME

EC6x

X(6)

Emergency Muster Station Code 6

optional

ORG_E_MST6(linked to
MST_ID)

EN6x

X(50)

Emergency Muster Station Description


6

optional

MST_NAME

NDRx

X(3)

Excuse From Safety Drill (Yes/No)

optional

UXP_C_NODRILL

PSCx

Picture Source

SEC_SOURCE

PMDx

Picture Last Modified Date Time

optional

SEC_MODDATE

FRQx

X(20)

Frequent Traveller Card Number

UXP_A_FRQ_CARDNO

PCTx

X(20)

Price Category

RES_PCATEGORY

CBTx

X(6)

Cabin Type

CAB_TYPE

NCLx

9.9

None Refundable Credit Balance

optional

UXP_A_NR_BAL

SCRx

Current Cruise ID

optional

SCR_ID

OCCx

X(20)

Previous On board Cabin Card

optional

RES_BOARDCC

PASx

X(20)

Passport Number

optional

UXP_H_PASSNO

PAYx

X(10)

Default Payment Type

optional

RES_DEP_PAY

BWFx

X(1)

Y=Yes,N=No, currently always N

optional

N/A

CLRx

X(6)

Reservation Classification/Vip Flag

optional

RES_CLASSFICATION

optional

Routed Account Credit limit


as per assigned credit
department code, unless
individual credit limit is
assigned in UXP_A_CRELIM

RCLx

9.9

Routed Account Credit Limit

Universal Interface Technical Specification 7.00.0xx

Page 30 of 211

Code

Type

Description

Required

SPMS DB Field reference

SDTx

Fidelio Cruise System Date

sys_date

CSDx

Current Cruise Start Date

scr_a_date of current cruise

CSNx

X(10)

Casino ID

RES_ACC padded zero to 10


digits
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written
The field will depend on the
custom sql written

CS1x

X(4000)

Custom SQL Field 1

optional

CS2x

X(4000)

Custom SQL Field 1

optional

CS3x

X(4000)

Custom SQL Field 1

optional

CS4x

X(4000)

Custom SQL Field 1

optional

CS5x

X(4000)

Custom SQL Field 1

optional

CS6x

X(4000)

Custom SQL Field 1

optional

CS7x

X(4000)

Custom SQL Field 1

optional

CS8x

X(4000)

Custom SQL Field 1

optional

CS9x

X(4000)

Custom SQL Field 1

optional

PGIx

X(8)

Pregenerated Random ID

RES_PGID

SCIx

X(15)

Cruise external system identifier

SCR_ITN_ID

REZx

X(40)

External reservation ID

RES_REFERENZ

DEKx

X(6)

Cabin deck code

optional

CAB_DECK

ECDx

X(20)

External Crew ID

UXP_C_EXTERNALID

QBPx

Quick Billing Printing Flag

RES_NOBATCH_INVOICE

RRZx

X(40)

Routed External reservation ID

optional

Payer RES_REFERENZ

RIDx

X(4000)

List of RFID UID separate by ,

optional

RFID_ID

LUGx

X(4000)

List of luggage tag id separate by ,

optional

LUG_RFID

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records of the data to satisfy inquiry criteria. The response
message number one is required while all the others are optional. Record number will not be
present if only one record is returned.
The following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
Universal Interface Technical Specification 7.00.0xx

Page 31 of 211

whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACIx
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
ACTx
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

ENBx
The field identifies the information if an account is enabled (1) or disabled (0).
NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person).
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and the time the account (person) is expected or embarked.
DISx
The field identifies the date and the time the account (person) is expected to disembark.
DOBx
The field identifies the person date of birth. If the account number is returned (not a person) or date
of birth is not present the field is omitted.

EMLx
The field identifies the person e-mail address. If the account number is returned (not a person) or email is not present the field is omitted.
Universal Interface Technical Specification 7.00.0xx

Page 32 of 211

BALx
The field identifies the account (person) current balance. This field can return positive (account is to
be invoiced) or negative (account prepaid) value.
FSTx
The field identifies the forename of an account (person).
LSTx
The field identifies the surname of an account (person).
SALx
The field identifies the salutation of an account (person).
TTLx
The field identifies the title of an account (person).
GNDx
The field identifies the gender of an account (person).
MINx
The field identifies the "Y" or "N" if the account (person) is a Minor. This is matched against a
database parameter.
LANx
The field returns the language of an account (person).
STAx
The field identifies the reservation status [EExpected, CChecked-In, D-Departed] of an account
(person).
GRPx
The field identifies the group Id & the name of the group if a passenger is assigned to a group.
CATx
The field identifies the category Ids & the names of the categories if a passenger is assigned any
categories.
ADDx
The field identifies the address (Line 1).
STRx
The field identifies the street (Line 2).
CTYx
The field identifies the city.
ZIPx
The field identifies the zip code.
STTx
The field identifies the state.

Universal Interface Technical Specification 7.00.0xx

Page 33 of 211

CTRx
The field identifies the country code.
TELx
The field identifies the telephone number.
CLMx
The field identifies the credit limit set for the person(s).
SMLx
The field identifies the Ships e-Mail Id for the person(s).
PINx
The field identifies the telephone PIN code for the person(s). The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKYx
The field identifies the authorization key for the person(s).
BIDx
The field identifies the booking id.
SIDx
The field identifies the shore id.
VGDx
The field identifies the unique guest id.
AWDx
The field identifies the guest award level.
BCCx
It contain Track 2 field 1 value of the on board cabin card excluding start sentinel and end sentinel.
e.g. The value encode in track 2 is ;9910000657580701=20060810?, we will only send
9910000657580701
ROIx
The field identifies the routed account id (payer account id).
POSx
The field identifies the information if the routed account is enabled (1) or disabled (0).
NATx
The field identifies the guest passport nationality
PICx
The field identifies the guest picture. This is control by FCUI options.
The data format will be in Hex. Below is a function in VB to convert the data back to byte array or
binary string.
'Convert the hex string to byte array
Public Function HexToByte(ByVal sString As String) As Byte()
Dim nX As Long
Dim nLen As Long
Universal Interface Technical Specification 7.00.0xx

Page 34 of 211

Dim byLen() As Byte


nLen = Len(sString)
If nLen / 2 <> Int(nLen / 2) Then ' Odd Lenght
sString = "0" & sString
End If
ReDim byStr(Len(sString) / 2 - 1) As Byte
For nX = 1 To Len(sString) Step 2
byStr(nX \ 2) = Val("&H" & Mid(sString, nX, 2))
Next nX
HexToByte = byStr
End Function
'Convert the hex string to string
Public Function HexToStr(ByVal sString As String) As String
Dim nX As Long
Dim nLen As Long
Dim sStr As String
nLen = Len(sString)
If nLen / 2 <> Int(nLen / 2) Then ' Odd Lenght
sString = "0" & sString
End If
ReDim byStr(Len(sString) / 2 - 1) As Byte
For nX = 1 To Len(sString) Step 2
sStr = sStr & Chr("&H" & Mid(sString, nX, 2))
Next nX
HexToStr = sStr
End Function
GIDx
The field identifies the group shore id of the group if a passenger is assigned to a group.
CSWx
The field identifies the housekeeper assign to this cabin
HADx
If the guest had handicapped, it will be shown as, for normal guest it will be blank
e.g. Wheel Chair Require<FS>Deaf
HARx
This is special remark for the handicapped guest.
MSTx
The master station associate with the guest
SHRx
0-Onboard, 1-Shoreide
SFTx
Safety Number (Only apply to crew only)
SMCx
Safety Muster Station Code (Only apply to crew only)
Universal Interface Technical Specification 7.00.0xx

Page 35 of 211

SMNx
Safety Muster Station Description (Only apply to crew only)
EC1x
Emergency Muster Station Code 1 (The emergency type is user define) (Only apply to crew only)
EN1x
Emergency Muster Station Description 1 (Only apply to crew only)
EC2x
Emergency Muster Station Code 2 (The emergency type is user define) (Only apply to crew only)
EN2x
Emergency Muster Station Description 2 (Only apply to crew only)
EC3x
Emergency Muster Station Code 3 (The emergency type is user define) (Only apply to crew only)
EN3x
Emergency Muster Station Description 3 (Only apply to crew only)
EC4x
Emergency Muster Station Code 4 (The emergency type is user define) (Only apply to crew only)
EN4x
Emergency Muster Station Description 4 (Only apply to crew only)
EC5x
Emergency Muster Station Code 5 (The emergency type is user define) (Only apply to crew only)
EN5x
Emergency Muster Station Description 5 (Only apply to crew only)
EC6x
Emergency Muster Station Code 6 (The emergency type is user define) (Only apply to crew only)
EN6x
Emergency Muster Station Description 6 (Only apply to crew only)
NDRx
Excuse From Safety Drill (Yes or No) (Only apply to crew only)
PSCx
Picture Source
-1 = No Picture
0 = Unknow
1 = Web Cam
2 = RFID Passport
3 = Scan Passport Image
4 = Guest History
PMDx

Universal Interface Technical Specification 7.00.0xx

Page 36 of 211

Picture Last Modified Date, due to the size of the picture, it is not efficient to return the picture in
INQ message, so what you need to do is compare the last modified date of the picture store in your
DB and if the picture had been updated, send GetPicture message to get the picture in a separate
call.
FRQx
Frequent Traveller Card Number
PCTx
Booking Price Category (res_pcategory)
CBTx
Cabin Type
NCLx
Non Refundable Credit
SCRx
Current Cruise ID
OCCx
This field only exists when they reprint a new board card, this is the old board card value
It contain Track 2 field 1 value of the on board cabin card excluding start sentinel and end sentinel.
e.g. The value encode in track 2 is ;9910000657580701=20060810?, we will only send
9910000657580701
PASx
Passport Number
PAYx
Default payment department ID
BWFx
Beverage Waiver Flag, current not supported, always return N
CLRx
This field identified the reservation classification/VIP Flag.
RCLx
The field identifies the credit limit set for the routed person(s) (payer account).
SDTx
Current Fidelio cruise system date.
CSDx
Current cruise start date.
CSNx
Casino ID, it a ACIx padded zero to 10 digits
CS1x to CS9x
The return value and data type will depend on the custom SQL written. It will be different from ship
to ship. Please refer to Fidelio Cruise support for more details.

Universal Interface Technical Specification 7.00.0xx

Page 37 of 211

PGIx
Pregenerated Random Number
SCIx
Cruise external system identifier
REZx
External reservation ID
DEKx
Cabin Deck code
ECDx
External Crew ID
QBPx
Quick Billing Printing Flag, 1 Print Invoice, 0 Do no print invoice in the Quick Billing Screen
RRZx
Payer External reservation ID
RIDx
List of RFID separate by ,
LUGx
List of luggage tag id separate by ,

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>InquireResponse<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>ACI1=9001201<US>ACT1=P<US>ENB1=1<US>NAM1=John
Malkovitch<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-09-12<US>DOB1=197004-08<US>EML1=fcsupport@fcruise.com
<US>BAL1=123.45<US>FST1=John<US>LST1=Malkovitch<US>SAL1=<US>TTL1=<US>GND
1=M<US>MIN1=N<US>LAN1=EN<US>STA1=C<US>GRP1=Group1<US>CAT1=Category1<U
S>ADD1=Address<US>STR1=Street<US>CTY1=City<US>ZIP1=12345<US>STT1=State<US>
CTR1=State<US>TEL1=73012343<US>CLM1=2000.00<US>SML1=john@shipname.com
<US>PIN1=15223<US>AKY1=1234<US>BID1=80797755<US>SID1=Shore123<US>VGD1=00
000000000050060272<US>AWD1=Silver<US>BCC1=9841000020957311<US>ROI1=9001202
<US>POS1=1<US>NAT1=SG<US>HAD1=Wheel Chain Require<FS>Deaf<US>HAR1=Need
special assistance<US>MST1=Life Boat Station No. 20<US>SHR1=0<US>PSC1=0<US>PMD1=2011-04-26 14:09:06<US> FRQ1=ABCD<US> PCT1=VA <US> CBT1=AB2
<US>ACI2=9001202<US>ACT2=P<US>ENB2=1 <US>NAM2=Jane
Malkovitch<US>CAB2=0123<US>EMB2=1997-09-11<US>DIS2=1997-09-13<US>DOB2=19730408<US>EML2=test@fcruise.com<US>BAL2=24.12<US>FST2=Jane<US>LST2=Malkovitch<U
S>SAL2=<US>TTL2=<US>GND2=F<US>MIN2=N<US>LAN2=EN<US>STA2=C<US>GRP2=9
002402-Holiday Group<US>CAT2=FQT-Frequent Cruisers;SNR-Senior
Citizen<US>ADD2=Borsel Str.
16C<US>STR2=Altona<US>CTY2=Hamburg<US>ZIP2=22765<US>STT2=Hamburg<US>CTR
2=DE<US>TEL2=+49 (40) 39900163<US>CLM2=2000.00<US>SML2=Jane0123@shipsname.com<US>PIN2=15233<US>AKY

Universal Interface Technical Specification 7.00.0xx

Page 38 of 211

2=1234<US>BID2=80797756<US>SID2=Shore124<US>VGD2=00000000000050060273<US>
AWD2=Silver
<US>BCC2=9841000020957312<US>NAT2=SG<US>HAD2=<US>HAR2=<US>MST2=Fire
Station #5<US>SHR2=0<US>PSC2=0<US>PMD2=2011-04-26 14:09:06<US> FRQ2=1233445
<US> PCT2=SA <US> CBT2=AA <ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 39 of 211

Posting1
Posting1 message type is sent to the FCUI to insert posting charges, except for call postings.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status

POI

X(48)

Unique Posting ID

Outlet ID

POOx

POVx

9.9

Posting Value

POPx

Serving Period

optional

PODx

9.9

Discount Value

optional

POCx

9.9

Service Charge Value

optional

POTx

9.9

Tip Value

optional

Receipt image

optional

Notes

optional

PIN Code

optional

IMG

X(1024)

INF

X(50)

PIN

DTL

FLG

WINx

POXx

9.9

Unlimited Length, refer below for


more detail
Y-Allow posting even the guest has
reached his credit limit or posting is
disable, N-Normal posting

optional
optional

Invoice Windows (0 3)

optional

Tax Value

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
RES_STATUS translated to
R/C
n/a to be provided from
external system
DEP_POS_CODE +
DEP_POS_TYPE
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
RES_PIN_CODE
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Universal Interface Technical Specification 7.00.0xx

Page 40 of 211

The message can accept one or more subgroup levels within one posting transaction. This way the
external system can pass more detailed posting information to the FCSPMS. Record number cannot
be used if only one record is send.

REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
N
I
G
E
T
M
H
X
R
F
P

Card identification number (RES_BOARDCC)


Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)
Name of a person or company account(UXP_A_NAME_N)
Internal identification number (UXP_A_ID)
Group Id number (RES_GRP)
External identification number (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)
Internal Id number(UXP_C_INTERNALID)
Guest Category(GCT_CODE)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

ACS
The field identifies the account current reservation status. The following status values are accepted:
R
C

Reservations
Checked-in

POI
The field identifies the bill (check) uniquely within the whole external system. The field is used as a
cross-reference to obtain detailed information about all the transactions recorded on a check.

Universal Interface Technical Specification 7.00.0xx

Page 41 of 211

POOx
The field identifies the revenue center of the outlet from which the charge originated. The FCSPMS
description equivalent of the Outlet ID will be displayed or printed on a customer invoice.
POVx
The field identifies the actual amount (gross) is being posted. This value represents value in full
(including discount, service charge, tip and tax). This field can have positive (account is debited) or
negative (void) value.
POPx
The field identifies the serving period number that is active when the charge is posted.
PODx
The field identifies the total amount of discounts taken against the transaction total amount. This
field can have positive (account is debited) or negative (void) value.
POCx
The field identifies the total amount of any automatic percentage add-on amounts to the transaction
total. This field can have positive (account is debited) or negative (void) value.
POTx
The field identifies the total amount of any add-on amounts to the transaction total such as tips,
cover charges etc. This value is typically entered manually as per customer specification. This field
can have positive (account is debited) or negative (void) value.
IMG
The field identifies the receipt image that shows the same data as printed on the customer receipt.
This should be plain text with CR & LF characters separating each line of the text. It should be
formatted to be displayed using non-proportional fonts.
INF
The field identifies the additional information send by FCUI.
PIN
The field identifies the telephone code of the reservation account. The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.

Universal Interface Technical Specification 7.00.0xx

Page 42 of 211

DTL
This field identified the items order on the external system. The field contain many sub field, each
field is separated with <FS> ASCII 28. If the external systems do not have the particular field just
pass in the default value indicate in bracket.
Field

Type

Description

X(30)

Guest Count (Default 0)

Table Number (Default 0)

X(60)

6999

Employee Number (Default 0)


Employee Name (Default Blank)

Outlet Name
Variable Length field. Field 6 till 999 represent item details. Each record will
have 4 fields, each field will be separated by pipe |
Field 1: Item Number (9)
Field 2: Item Name X(50)
Field 3: Quantity (9)
Field 4: Sales Total (9.9)

e.g. Guest A order 1 T-Shirt for 10.00 and 2 Key Chain for 2.50 each
DTL=1234<FS>Cashier 1<FS>1<FS>0<FS>Gift Shop<FS>205789412|TShift|1|10.00<FS>205789123|Key Chain|2|5.00
FLG
Y-Allow posting even the guest has reached his credit limit or posting is disabled (This only apply to
check-in guest only), N-Normal posting.
WINx
The invoice windows, a valid value is from 0 to 3, any invalid value will default to 0.
POXx
The field identifies the total amount of any tax to the transaction total. This field can have positive
(account is debited) or negative (void) value.

Universal Interface Technical Specification 7.00.0xx

Page 43 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>Posting<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-11
14:10:32<US>ACI=0123<US>ACE=A<US>ACS=C<US>POI=10982<US>POO=10<US>POP=1
<US>POV=12.34<US>POD=2.1<US>POC=0.12
<US>POT=1<US>INF=VIP<US>PIN=123455<US>IMG= INVOICE - SUPERSTAR LIBRA LTD
BLUE LAGOON
1 CASHIER 1
-------------------------------1/1
4578 GST 1
JUN12'07 6:44PM
-------------------------------1 LIBRA FRIED RICE 12.34
DISCOUNT
2.10SERVICE CHARGE
0.12
TIP
1.00
TOTAL PAID
11.36
05000
XXXN070612184500
MANUAL ENTRY
Cabin/Acc:05000
Ms TONG JEN LEE
CABIN CHARGE
11.36
---1168 CLOSED JUN12 6:45PM---.
SIGN:...........................
.
All Amounts in US Dollars (USD$)
.
<US>DTL=1234<FS>Cashier 1<FS>1<FS>0<FS>Gift
Shop<FS>205789412|T-Shift|1|12.34<ETX><CHECKSUM>
<STX>Posting<US>REF=POS#2<US>RQN=122<US>DTE=1997-09-11
14:10:35<US>ACI=9001201<US>ACE=I<US>ACS=R<US>POI=10982<US>POO1=22<US>PO
V1=12.34<US>POD1=2.1<US>POC1=0.12
<US>POT1=1<US>POO2=24<US>POV2=10<US>INF=VIP<US>PIN=123455<US>WIN=1<ETX
><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 44 of 211

PostingResponse1
PostingResponse1 message type is sent by the FCUI to confirm posting made.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACIx

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(52)

Salutation, Forename and Surname

CABx

X(6)

Cabin Number

EMBx

Embarkation Date

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts

DISx

Disembarkation Date

RES_DIS_E

BALx

9.9

Balance

CRUx

9.9

Posted Cruise ID

POIx

X(48)

OCIx

X(52)

PGIx

X(8)

Original Unique Posting ID from the


Posting message
Original Account ID from the Posting
message
Pregenerated Random ID

Required

SPMS DB Field reference

Code

optional

optional
optional
optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB

(UXP_A_POS_DEBIT
UXP_A_POS_CREDIT)
POS_CRUISE
n/a to be provided from
external system
n/a to be provided from
external system
RES_PGID

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

PostingResponse message can return one or more records that satisfy inquiry criteria. The
response message number 1 is required while all the others are optional. Record number will not be
present if only one record is returned. If one record is returned it serves as a confirmation that the
postings have been made. Final balance after the posting is applied will be send. No posting is
inserted if more than one record is returned. In this case current balance is returned. External
system should send Posting message identifying one account that the posting should apply to.
The following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
Universal Interface Technical Specification 7.00.0xx

Page 45 of 211

FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.

Universal Interface Technical Specification 7.00.0xx

Page 46 of 211

RQN
The field identifies the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACIx
The field identifies the unique account (person) identification. This ID is used for the final posting.
The field is an internal, unique account (person) number (I type).
ACTx
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and the time the account (person) is expected or embarked.
DISx
The field identifies date and the time the account (person) is expected to disembark.
BALx
The field identifies the balance after the posting is applied if one account was found. Otherwise
returns current balance. This field can return positive (account is to be invoiced) or negative
(account prepaid) value.
CRUx
The field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.
POIx
Original POI from the posting message
OCIx
Original ACI from the posting message
Universal Interface Technical Specification 7.00.0xx

Page 47 of 211

PGIx
Pregenerated Random Number

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-11
14:10:24<US>ACI1=9001201<US>ACT1=P<US>NAM1=John
Malkovitch<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-0912<US>BAL1=123.45<US>CRU1=0<US>ACI2=9001202<US>ACT2=P<US>NAM2=Jane
Malkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-0913<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-11
14:10:28<US>ACI=9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-0912<US>BAL=135.79<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 48 of 211

Posting2
Posting2 message type is sent to the FCUI to insert posting charges and call charges.
Code

Type

Description

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status.

PTY

X(1)

POI

POOx

POVx

9.9

POPx

Serving Period

optional

PODx

9.9

Discount Value

optional

POCx

9.9

Service Charge Value

optional

POTx

9.9

Tip Value

optional

Posting Type ('C'Call Accounting,


'P'Generic Posting). Default would
be generic posting.
Unique Posting ID or Unique Call
Posting ID

Required

Outlet ID (For generic posting)

Posting Value (For generic posting)

Receipt image (This field is not


applicable for posting type PTY = C
(Call Posting))
Dialled Number (For Call Accounting
Posting)
Call Start Date or Time (For Call
Accounting Posting)
Call Duration (For Call Accounting
Posting)
Call Type (For Call Accounting
Posting)
Notes (This field is not applicable for
posting type PTY = C (Call Posting))

IMG

X(1024)

NUM

X(30)

BEG

DUR

TYP

X(2)

INF

X(50)

PIN

PIN Code

optional

FLG

Y-Allow posting even the guest has


reached his credit limit or posting is
disable, N-Normal posting

optional

WINx

Invoice Windows (0 3)

optional

POXx

9.9

Tax Value

optional

Universal Interface Technical Specification 7.00.0xx

optional
optional
optional
optional
optional
optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
RES_STATUS translated to
R/C
n/a to be provided from
external system
n/a to be provided from
external system
DEP_POS_CODE +
DEP_POS_TYPE
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
RES_PIN_CODE
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
Page 49 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more subgroup levels within one posting transaction. This way the
external system can pass more detailed posting information to the FCSPMS. Record number cannot
be used if only one record is send.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field identifies the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
I
E
T
H
R
F
P

Card identification number (RES_BOARDCC)


Cabin number or System account. (RES_CAB/UXP_A_SYS_ACC)
Internal identification number (FCSPMS account ID) (UXP_A_ID)
External identification number (e.g. reservation number) (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
Internal Id number (UXP_C_INTERNALID)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

ACS
The field identifies the account current reservation status. The following status values are accepted:
R
C

Reservations
Checked-in

PTY
The field identifies the posting type. The following values are accepted:
P
C

Genenic Posting
Call Accounting

Universal Interface Technical Specification 7.00.0xx

Page 50 of 211

POI
The field identifies the bill (check) uniquely within the whole external system. The field is used as a
cross-reference to obtain detailed information about all the transactions recorded on a check.
POOx
The field identifies the revenue center of the outlet from which the charge originated. The FCSPMS
description equivalent of the Outlet ID will be displayed or printed on a customer invoice.
POVx
The field identifies the actual amount (gross) is posted. This value represents value in full (including
discount, service charge and tip). This field can have positive (account is debited) or negative (void)
value.
POPx
The field identifies the serving period number that is active when the charge is posted.
PODx
The field identifies the total amount of discounts taken against the transaction total amount. This
field can have positive (account is debited) or negative (void) value.
POCx
The field identifies the total amount of any automatic percentage add-on amounts to the transaction
total. This field can have positive (account is debited) or negative (void) value.
POTx
The field identifies the total amount of any add-on amounts to the transaction total such as tips,
cover charges etc. This value is typically entered manually as per customer specification. This field
can have positive (account is debited) or negative (void) value.
IMG
The field identifies the receipt image that shows the same data as printed on the customer receipt.
This should be plain text with CR & LF characters separating each line of the text. It should be
formatted to be displayed using non-proportional fonts.
NUM
The field identifies the phone number called.
BEG
The field identifies the date and the time when the phone call started. Full date and time format is
required.
DUR
The field identifies the phone call duration in seconds.

Universal Interface Technical Specification 7.00.0xx

Page 51 of 211

TYP
The field identifies the phone call type. The following types are defined:
VL
VC
VS
VN
FL
FC
FS
FN
DL
DC
DS
DN

Line Voice Call


Cellular Voice Call
Satellite Voice Call
Non chargeable Voice Call
Line Fax
Cellular Fax
Satellite Fax
Non chargeable Fax
Line Data Call
Cellular Data Call
Satellite Data Call
Non chargeable Data Call

INF
The field identifies the additional information send by FCUI.
PIN
The field identifies the telephone PIN Code of the reservation account. The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
FLG
Y-Allow posting even the guest has reached his credit limit or posting is disabled (This only apply to
check-in guest only), N-Normal posting
WINx
The invoice windows, a valid value is from 0 to 3, any invalid value will default to 0.
POXx
The field identifies the total amount of any tax to the transaction total. This field can have positive
(account is debited) or negative (void) value.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Universal Interface Technical Specification 7.00.0xx

Page 52 of 211

Posting2 (Generic):
<STX>Posting<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-11
14:10:32<US>ACI=0123<US>ACE=A<US>ACS=C<US>PTY=P<US>POI=10982<US>POO=10
<US>POP=1<US>POV=12.34<US>POD=2.1<US>POC=0.12
<US>POT=1<US>INF=VIP<US>PIN=123455<ETX><CHECKSUM>
<STX>Posting<US>REF=POS#1<US>RQN=122<US>DTE=1997-09-11
14:10:35<US>ACI=9001201<US>ACE=I<US>ACS=R<US>PTY=P<US>POI=10982<US>POO
1=22<US>POV1=12.34<US>POD1=2.1<US>POC1=0.12
<US>POT1=1<US>POO2=24<US>POV2=10<US>INF=VIP<US>PIN=123455<ETX><CHECKS
UM>
Example
Message

Posting2 (Call Accounting):


<STX>Posting<US>REF=PBX#1<US>RQN=123<US>DTE=2004-09-11
14:10:32<US>ACI=0123<US>ACE=A<US>ACS=C<US>PTY=C<US>POI=100103<US>POO=1
0<US>POP=1<US>POV=12.34<US>POD=2.1<US>POC=0.12 <US>POT=1<US>
NUM=+1 (343) 324-2343<US>BEG=1997-09-11
14:03:32<US>DUR=234<US>TYP=VC<US>INF=VIP<US>PIN=123455<ETX><CHECKSUM>
<STX>Posting<US>REF=PBX#1<US>RQN=124<US>DTE=2004-09-11
14:10:35<US>ACI=9001201<US>ACE=I<US>ACS=R<US>PTY=C<US>COI=100103<US>PO
O1=22<US>POV1=12.34<US>POD1=2.1<US>POC1=0.12 <US>POT1=1<US>
NUM=+1 (343) 324-2343<US>BEG=1997-09-11 14:03:32<US>DUR=234<US>TYP=VC
<US>POO2=24<US>POV2=10<US>INF=VIP<US>PIN=123455<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 53 of 211

PostingResponse2
PostingResponse2 message type is sent by the FCUI to confirm general posting or call posting
made.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACIx

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(52)

Salutation, Forename and Surname

CABx

X(6)

Cabin Number

EMBx

Embarkation Date

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts

DISx

Disembarkation Date

RES_DIS_E

BALx

9.9

Balance

CRUx

9.9

Posted Cruise ID

POIx

X(48)

OCIx

X(52)

PGIx

X(8)

Original Unique Posting ID from the


Posting message
Original Account ID from the Posting
message
Pregenerated Random ID

Required

SPMS DB Field reference

Code

optional

optional
optional
optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB

(UXP_A_POS_DEBIT
UXP_A_POS_CREDIT)
POS_CRUISE
n/a to be provided from
external system
n/a to be provided from
external system
RES_PGID

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

PostingResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. If one record is returned it serves as a confirmation that
the postings have been made. Final balance after the posting is applied will be send. No posting is
inserted if more than one record is returned. In this case, the current balance is returned. The
External system should send the Posting message to identifying one account that the posting
should apply to.
The following is a description of the fields in the message data block.
REF
The field identifies the source and the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
Universal Interface Technical Specification 7.00.0xx

Page 54 of 211

FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field identifies the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACIx
The field identifies the unique account (person) identification. This ID is used for the final posting.
The field is an internal, unique account (person) number (I type).
ACTx
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and the time the account (person) is expected or embarked.
DISx
The field identifies the date and the time the account (person) is expected to disembark.
BALx
The field identifies the balance after the posting is applied if one account was found. Otherwise
returns current balance. This field can return positive (account is to be invoiced) or negative
(account prepaid) value.
CRUx
The field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.
POIx
Original POI from the posting message

Universal Interface Technical Specification 7.00.0xx

Page 55 of 211

OCIx
Original ACI from the posting message
PGIx
Pregenerated Random Number

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

PostingResponse2 (Generic):

Example
Message

<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-11
14:10:24<US>ACI1=9001201<US>ACT1=P<US>NAM1=John
Malkovitch<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-0912<US>BAL1=123.45<US>CRU1=0<US>ACI2=9001202<US>ACT2=P<US>NAM2=Jane
Malkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-0913<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-11
14:10:28<US>ACI=9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-0912<US>BAL=135.79<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 56 of 211

Payment
Payment message type is sent to the FCUI to insert payments to existing FCSPMS accounts.
Code

Type

Description

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status

POI

X(20)

Unique Payment ID

POO

POV

9.9

INF

X(50)

WIN

Payment Type ID
Payment Value

Required

optional

Notes

optional

Invoice Window (0,1,2 or 3)

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
RES_STATUS translated to
R/C
n/a to be provided from
external system
DEP_POS_CODE+
DEP_POS_TYPE
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field identifies the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.

Universal Interface Technical Specification 7.00.0xx

Page 57 of 211

ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
N
I
G
E
T
M
H
X
R
F
P

Card identification number (RES_BOARDCC)


Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)
Name of a person or company account(UXP_A_NAME_N)
Internal identification number (UXP_A_ID)
Group Id number (RES_GRP)
External identification number (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)
Internal Id number(UXP_C_INTERNALID)
Guest Category(GCT_CODE)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

ACS
The field identifies the account current reservation status. The following status values are accepted:
R
C

Reservations
Checked-in

POI
The field identifies the unique payment identifier within the whole external system. It used for
checking if payment was not repeated.
POO
The field identifies the payment type identifier as per external system. FCSPMS description
equivalent to the Payment Type ID will be displayed or printed on a customer invoice. If not present
default payment department as assigned to the account or default system payment department will
be used. Foreign currency departments can be used. Credit card departments cannot be used with
the exception when the Payment Type ID is not specified and person default payment is credit card.
POV
The field identifies the actual payment amount. Foreign currency, if used, will be converted to base
currency as per current exchange rate defined in FCSPMS system. This field can have positive
(account is credited) or negative (void) value.

Universal Interface Technical Specification 7.00.0xx

Page 58 of 211

INF
The field identifies the additional information send by FCUI.
WIN
This field identifies the invoice window to pay, this only applied when POO is not sent and multiple
credit cards are assigned to the same guest. Valid value from 0 to 3.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>Payment<US>REF=PAY#1<US>RQN=121<US>DTE=1997-09-11
14:10:32<US>ACI=0123<US>ACE=A<US>ACS=C<US>POI=100104<US>POO=101<US>POV
=20.02 <US>INF=External Payment<ETX><CHECKSUM>
<STX>Payment<US>REF=PAY#1<US>RQN=122<US>DTE=1997-09-11
14:10:35<US>ACI=9001201<US>ACE=I<US>ACS=C<US>POI=100105<US>POO=101<US>P
OV=20.02 <US>INF=External Payment<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 59 of 211

PaymentResponse
PaymentResponse message type is sent by the FCUI to confirm payment made.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI x

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(52)

Salutation, Forename and Surname

CABx

X(6)

Cabin Number

EMBx

Embarkation Date

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts

DISx

Disembarkation Date

RES_DIS_E

BALx

9.9

Balance

SYSTEM CALCULATED

CRUx

9.9

Posted Cruise ID

optional

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB

POS_CRUISE

POI

X(20)

Unique Payment ID

The POI from Payment


message

PGIx

X(8)

Pregenerated Random ID

RES_PGID

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

PaymentResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. If one record is returned it serves as a confirmation that
the payment has been made. Final balance after the payment is applied will be send. No payment is
inserted if more than one record is returned. In this case, current balance is returned. External
system should send Payment message identifying one account that the posting should apply to.
The following is a description of the fields in the message data block.

Universal Interface Technical Specification 7.00.0xx

Page 60 of 211

REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACIx
The field identifies the unique account (person) identification. This ID is used for the final payment.
The field is an internal, unique account (person) number (I type).
ACTx
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and time the account (person) is expected or embarked.
DISx
The field identifies the date and time the account (person) is expected to disembark.
BALx
The field identifies the balance after the payment is applied if one account was found. Otherwise
returns current balance. This field can return positive (account is to be invoiced) or negative
(account prepaid) value.
CRUx
The field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.
Universal Interface Technical Specification 7.00.0xx

Page 61 of 211

POI
The field identifies the unique payment identifier within the whole external system. It used for
checking if payment was not repeated. This message is send from payment message.
PGIx
Pregenerated Random Number

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>PaymentResponse<US>REF=PAY#1<US>RQN=121<US>DTE= 1997-091114:10:24<US>ACI1=9001201<US>ACT1=P<US>NAM1=JohnMalkovitch<US>CAB1=0123<
US>EMB1=1997-09-10<US>DIS1=1997-0912<US>BAL1=123.45<US>CRU1=0<US>ACI2=9001202<US>ACT2=P<US>NAM2=Jane
Malkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-0913<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>PaymentResponse<US>REF=PAY#1<US>RQN=121<US>DTE=1997-09-11
14:10:28<US>ACI=9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-0912<US>BAL=102.43<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 62 of 211

Folio
Folio message type is used to request list of postings or payment for a specific account from the
FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Account ID

RES_ACC

PIN

Pin Code

optional

ACE

X(1)

Account ID Entry Type

optional

RES_PIN_CODE
Refer to ACE type definition
below

The message is usually used to display registered postings or payment. The following is a
description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification number. This ID can be obtained
through e.g. Inquire message. The field is an internal, unique account (person) number (I type).
PIN
The field identifies the telephone PIN code for the reservation account. The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined: If this field is not supply it will default to Internal identification number (UXP_A_ID)
P

Pre generated Random Number (RES_PGID)

Universal Interface Technical Specification 7.00.0xx

Page 63 of 211

Example
Message

<STX>Folio<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:23<US>ACI=9001201<ETX><CHECKSUM>
<STX>Folio<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:23<US>ACI=9001201<US>PIN=1234<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 64 of 211

FolioResponse
FolioResponse message type is sent by the FCUI to supply the list of postings or payments
currently registered for the account specified by an external system. The message returns the same
list of postings or payments as visible through FCSPMS system. Main departments are returned
without details that are stored on subdepartment level.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

DPIx

X(10)

Department ID

DEP_MAINID

DPTx

X(1)

Department Type

DEM_FLAG

DPNx

X(50)

Department Description

DEM_COMMENT

PDTx

Posting or Payment Fidelio System


Date

VDTx

9.9

Debit Amount

POS_PDAT OR
POS_MDATE
TOTAL if DEM_FLAG=D

VCTx

9.9

Credit Amount

TOTAL if DEM_FLAG=C

CLSx

X(3)

Closed Posting Flag

POS_CLOSED

NPRx

X(3)

No Print Flag

POS_NOPRINT

WINx

Posting Window

POS_WIN

POIx

X(20)

POS Bill Number

POS_MIB_BILL_NO

BIDx

Buyer Account ID

POS_BUYER

BPIx

X(40)

Pax ID

RES_REFERENZ

PN2x

X(60)

Pos Note 2

POS_POSNOTE_2

BAL

9.9

Balance

Total Invoice Balance

NRB

9.9

Non-refundable balance

UXP_A_NR_BAL

PLM

9.9

Posting Credit Limit Available

Calculated Credit Limit

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records of the data to satisfy inquiry criteria. The response
message number one is required while all the others are optional. Record number will not be
present if only one record is returned.

Universal Interface Technical Specification 7.00.0xx

Page 65 of 211

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
DPIx
The field identifies the department number (revenue centre) where the posting was registered.
DPTx
The field identifies the department type. The following department types are defined:
D
C
P

Debit Posting
Credit Posting
Package Posting

DPNx
The field identifies the full description of the department (revenue centre) where the posting or
payment was registered.
PDTx
The field identifies the posting Fidelio system date.
VDTx
The field identifies the posting value. This field can return positive (charge) or negative (void)
values. For payment departments 0 will be returned.
VCTx
The field identifies the payment value. This field can return positive (payment) or negative (void)
values. For posting departments 0 will be returned.
CLSx
The field identifies the closed posting Flag. This field can return Yes or No values showing if the
posting is closed or not.
NPRx
The field identifies the no print Flag. This field can return Yes or No values showing if the posting is
to be displayed thru the external system or not.

Universal Interface Technical Specification 7.00.0xx

Page 66 of 211

WINx
The field identifies the Window (Invoice No.). This field can return 0 to 9 values showing which
Window (Invoice No.) the posting belongs to.
POIx
The field identifies the check no.
BIDx
The field identifies the buyer account unique.
BPIx
The field identifies the buyer pax id.
BAL
Folio Balance
NRB
Non Refundable Credit Balance
POIx
Unique Posting ID send during Posting Message, for other posting, the value will be undefined
PLM
Posting Credit Limit Available, it will return the smaller value between the buyer limit and payer limit.
The buyer limit check need to enable via PAR->General->Check Buyer Limit.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>FolioResponse<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>DPI1=100<US>DPT1=D<US>DPN1=Sky Light Bar<US>PDT1=1997-09-10
12:34:00<US>VDT1=23.12<US>VCT1=0<US>CLS1=No<US>NPR1=No<US>WIN1=0<US>DPI
2=900<US>DPT2=CB<US>DPN2=Cash<US>PDT2=1997-09-10
13:10:00<US>VDT2=0<US>VCT2=50<US>CLS2=No<US>NPR2=Yes<US>WIN2=1<US>BAL=
50.00<US>NRB=1.00<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 67 of 211

Excursions
Excursions message type is used to request a list of excursions available from the FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

SDT

Excursions starting date

ESE_DATE

EDT

Excursions ending date

ESE_DATE

ACI

Account ID

optional

RES_ACC

The message is usually used to display list of excursions that fall within date starting and ending
criteria. The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
SDT
The field identifies the minimum date the excursions can start from.
EDT
The field identifies the maximum date the excursions must be completed.
ACI
The field identifies the unique account (person) identification number. This ID can be obtained
through e.g. Inquire message. The field is an internal, unique account (person) number (I type).
This field is optional, you will only able to get the promotion info if you pass in this field

Example
Message

<STX>Excursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>SDT=1997-09-12 00:00:00<US>EDT=1997-09-12
23:59:59<US>ACI=250046<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 68 of 211

ExtExcursions
ExtExcursions message type is used to request list of excursions available from the FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

BDT

Excursions Starting Date

ESE_DATE

TYP

X(1)

Code Type

optional

COD

X(50)

Code

optional

ACI

Account ID

optional

Refer to TYP type definition


below
Refer to COD field definition
below
RES_ACC

The message is usually used to display list of excursions that fall within date starting or ending
criteria. The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
BDT
The field identifies the date for the excursions can start from.
TYP
The field identifies the type of the code being passed for querying excursions.
P
N
I
C

Excursion Port Name


Excursion No (ENO)
Excursion Unique ID (EID)
Excursion Category Code

Universal Interface Technical Specification 7.00.0xx

Page 69 of 211

COD
The code for the excursions to run the query on. It can be either the Port name (ESE_PORT), The
Excursion No (ENO) - (ESE_NO), the Unique Id (EID) (ESE_ID) or the Excursion Category Code
(ESE_CATEGORIES).
ACI
The field identifies the unique account (person) identification number. This ID can be obtained
through e.g. Inquire message. The field is an internal, unique account (person) number (I type).
This field is optional, you will only able to get the promotion info if you pass in this field

<STX>ExtExcursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12
00:00:00<US>TYP=P<US>COD=Hamburg<US>ACI=250046<ETX><CHECKSUM>

Example
Message

<STX>ExtExcursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12
00:00:00<US>TYP=N<US>COD=HAM0012<US>ACI=250046<ETX><CHECKSUM>
<STX>ExtExcursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12
00:00:00<US>TYP=I<US>COD=73928740<US>ACI=250046<ETX><CHECKSUM>
<STX>ExtExcursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12
00:00:00<US>TYP=C<US>COD=STR<US>ACI=250046<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 70 of 211

ExcursionsResponse
ExcursionsResponse message type is sent by the FCUI to supply list of excursions that fall within
starting and ending date or time specified by external system.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

EIDx

Excursion ID

ESE_ID

ENOx

X(10)

Excursion Number

ESE_NO

NAMx

X(50)

Excursion Name

ESE_NAME

SDTx

Starting Date and Time

EDTx

Ending Date and Time

ESE_DATE +
ESE_FROMTIME
ESE_DATE + ESE_TOTIME

STAx

X(1)

Booking or Adult Booking Status

SYSTEM CALCULATED

PADx

9.9

Adult Price

ESE_PRICE

PCHx

9.9

Child Price

ESE_PRICE_CHILD

MDTx

MPLx

Meeting Date and Time

optional

X(100)

Meeting Point

optional

CTHx

X(100)

Recommended Clothes

optional

INFx

X(200)

Notes

optional

SIKx

X(3)

BIKx

X(3)

MAXx

CURx

PRTx

X(50)

CATx

X(500)

LANx

X(500)

SITx

X(3)

BITx

X(3)

BCTx

X(3)

ESE_DATE +
ESE_MEETTIME
ESE_MEETPOINT
ESE_CLOTHES
ESE_COMMENT

Show in Kiosk [External Booking


System]
Book in Kiosk [External Booking
System]
Maximum Seats or Maximum Adult
Seats
Seats or Adult Seats Currently
Booked

ESE_SHOW_KIOSK

ESE_SELL_KIOSK

ESE_MAXPER /
ESE_MAXPER_ADULT
SYSTEM CALCULATED

Port Name

Category Id & Description [Id


Description; IdDescription]
Language Id + - + Language
Description
With , as field separator
Show in ITV [External Booking
System]
Book in ITV [External Booking
System]
Book Child Ticket in ITV [External
Booking System]

Universal Interface Technical Specification 7.00.0xx

Optional
Optional

ESE_PORT
ESE_CATEGORIES +
TYP_EXC.TYP_COMMENT
ESE_LANGUAGES +
TYP_LAN.TYP_COMMENT

ESE_SHOW_ITV

ESE_SELL_ITV

ESE_SELLCHILD_ITV

Page 71 of 211

Code

Type

Description

Required

CHSx

Maximum Childs Seats

Optional

CHBx

Child Seats Booked

Optional

STCx

X(1)

Child Booking Status

Optional

PAPx

Promotion Adult Price

Optional

PAAx

Promotion Adult Availability

Optional

PAIx

Adult Promotion ID

Optional

PCPx

Promotion Child Price

Optional

PCAx

Promotion Child Availability

Optional

PCIx

Child Promotion ID

Optional

DSCx

X(1000)

Tour Long Description

SPMS DB Field reference


EXE_MAXPER_CHILD
SYSTEM CALCULATED
SYSTEM CALCULATED
SYSTEM CALCULATED
SYSTEM CALCULATED
PRO_ID
SYSTEM CALCULATED
SYSTEM CALCULATED
PRD_ID
ESE_DESCRIPTION_LONG

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records that satisfy inquiry criteria. The response message
number one is required while all the others are optional. Record number will not be present if only
one record is returned.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
EIDx
The field identifies the unique excursion identifier. This ID can be used for excursion booking. The
field is an internal, unique excursion number.
ENOx
The field identifies the custom, users entered, number that identifies excursion.
Universal Interface Technical Specification 7.00.0xx

Page 72 of 211

NAMx
The field identifies the excursion name (description).
SDTx
The field identifies the excursion starting date and time.
EDTx
The field identifies the excursion ending date and time.
STAx
The field identifies the excursion booking status. If PAR Use Adult/Child Max Counts is enabled, this
is the adult booking status, if the PAR is disabled this is the general booking status.
The following status identifiers values are defined:
A
F
O

Available
Fully booked
Overbooked

PADx
The field identifies the excursion adult price.
PCHx
The field identifies the excursion child price.
MDTx
The field identifies the excursion participants meeting date and time.
MPLx
The field identifies the excursion participants meeting place.
CTHx
The field identifies the recommended clothes for excursions participants.
INFx
The field identifies the additional information about excursion.
SIKx
The flag to denote if the excursion can be shown on the external system, the field returns Yes or
No only.
BIKx
The flag to denote if the excursion can be booked on the external system, the field returns Yes or
No only.
MAXx
If PAR Use Adult/Child Max Counts is enabled, this is the maximum adult seats available on the
excursion, if the PAR is disabled this is the total seats available on the excursion.

Universal Interface Technical Specification 7.00.0xx

Page 73 of 211

CURx
If PAR Use Adult/Child Max Counts is enabled, this is the adult seats currently booked on the
excursion, if the PAR is disabled this is the total seats booked on the excursion.
PRTx
The field identifies the port for the excursion.
CATx
The field identifies the categories for the excursion.
LANx
The field identifies the Language ID (2 digits) + - + Language Description, + , as field separator.
In one tour there could be more then 1 language available
e.g.
EN English
DE German
The field will be EN-English,DE-German
SIKx
The flag to denote if the excursion can be shown on ITV the external system, the field returns Yes
or No only.
BITx
The flag to denote if the excursion can be booked on the ITV external system, the field returns Yes
or No only.
BCTx
The flag to denote if the excursion child ticket can be booked on the ITV external system, the field
returns Yes or No only.
PAPx
This is the adult promotion price, this field will be exists when the availability more then zero.
PAAx
This is the number of seats available for adult promotion price.
PAIx
This is the adult promotion id, it can be use during Booking. Please refer to PROx in Booking
message type for more details. In the even the adult promotion id is different from child promotion
id. You must sent two separate booking message (1 for adult, 1 for child) in order to get the
promotion price.
PCPx
This is the child promotion price, this field will be exists when the availability more then zero.
PCAx
This is the number of seats available for child promotion price.
PCIx
This is the child promotion id, it can be use during Booking. Please refer to PROx in Booking
message type for more details. In the even the adult promotion id is different from child promotion
id. You must sent two separate booking message (1 for adult, 1 for child) in order to get the
promotion price.

Universal Interface Technical Specification 7.00.0xx

Page 74 of 211

CHSx
The field identifies the maximum child seats available on the excursion. This field only exists when
PAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
CHBx
The field identifies the child seats currently booked on the excursion. This field only exists when
PAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
STCx
The field identifies the excursion booking status. If PAR Use Adult/Child Max Counts is enabled, this
is the child booking status, if the PAR is disabled this field will not exists.
The following status identifiers values are defined:
A
F
O

Available
Fully booked
Overbooked

DSCx
Tour long Description intended for ITV usage.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>ExcursionsResponse<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:31<US>EID1=12<US>ENO1=2<US>NAM1=Dining with crocodiles<US>SDT1=1997-0912 17:30:00<US>EDT1=1997-09-12
20:30:00<US>STA1=A<US>PAD1=12.10<US>PCH1=10<US>MDT1=1997-09-12
16:30:00<US>MPL1=Deck A<US>CTH1=Casual<US>INF1=Keep
warm<US>SIK1=Yes<US>BIK1=Yes<US>MAX1=200<US>CUR1=75<US>PRT1=Nice<US>CA
T1=STR-Strenous<US>LAN1=ENEnglish<US>SIT1=Yes<US>BIT1=Yes<US>CHS1=100<US>CHB1=50<US>STC1=A<US>DSC
1=Testing1<US>EID2=13<US>ENO2=4<US>NAM2=Dining on Sundeck<US>SDT2=1997-0912 17:45:00<US>EDT2=1997-09-12
20:30:00<US>STA2=F<US>PAD2=12.00<US>PCH2=9.10<US>MDT2=1997-09-12
16:30:00<US>MPL2=Deck A<US>CTH2=Casual<US>INF2=Keep
warm<US>SIK2=Yes<US>BIK2=No<US>MAX2=150<US>CUR2=125<US>PRT2=Nice<US>C
AT2=AD-All Day;LI-Lunch Included<US>LAN2=ENEnglish<US>SIT2=Yes<US>BIT2=Yes<US>CHS2=100<US>CHB2=50<US>STC2=A<US>PAP
2=10.00<US>PAA2=1<US>PAI2=123<US>PCP2=8.00<US>PCA2=1<US>PCI2=124<US>DSC
2=Testing2<ETX><CHECKSUM>
<STX>ExcursionsResponse<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:31<US>EID=12<US>ENO=2<US>NAM=Dining with crocodiles<US>SDT=1997-09-12
17:30:00<US>EDT=1997-09-12
20:30:00<US>STA=A<US>PAD=12.10<US>PCH=10<US>MDT=1997-09-12
16:30:00<US>MPL=Deck A<US>CTH=Casual<US>INF=Keep warm<US>SIK=Yes<US>
BIK=Yes<US> MAX=250<US> CUR=175<US>PRT=Nice<US>CAT=AD-All Day;LI-Lunch
Included<US>LAN=ENEnglish<US>SIT=Yes<US>CHS1=100<US>CHB1=50<US>STC1=A<US>DSC=Testing<ETX><
CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 75 of 211

Booking
Booking message type is sent to the FCUI to insert excursion booking and post excursion charge.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status

BOI

X(30)

Unique Excursion Booking ID

EIDx

Excursion ID

QADx

Number of Adult Tickets

QCHx

Number of Child Tickets

PROx

Promotion ID

optional

LANx

X(2)

Language ID

optional

INF

X(50)

Notes

optional

PIN

PIN Code

optional

SRC

X(100)

Booking Source

optional

FLG

Y-Allow posting even the guest has


reached his credit limit or posting is
disable, N-Normal posting

optional

PATx

Participant Account ID

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
RES_STATUS translated to
R/C
n/a to be provided from
external system
ESE_ID
n/a to be provided from
external system
n/a to be provided from
external system
PRO_ID
ESE_LANGUAGES
n/a to be provided from
external system
RES_PIN_CODE
n/a to be provided from
external system
n/a to be provided from
external system
RES_ACC

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more excursions within one booking transaction. This way
FCSPMS can assign the whole booking as one transaction that can be traced and voided later on.
Record number cannot be used if only one record is send.

Universal Interface Technical Specification 7.00.0xx

Page 76 of 211

REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
N
I
G
E
T
M
H
X
R
F

Pre generated Random Number (RES_PGID)

Card identification number (RES_BOARDCC)


Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)
Name of a person or company account (UXP_A_NAME_N)
Internal identification number (UXP_A_ID)
Group Id number (RES_GRP)
External identification number (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)
Internal Id number (UXP_C_INTERNALID)
Guest Category (GCT_CODE)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)

ACS
The field identifies the account current reservation status. The following status values are accepted:
R
C

Reservations
Checked-in

BOI
The field identifies the booking (check) unique within the whole external system. The field is used as
a cross-reference to obtain detailed information about all the transactions recorded on a booking.
EIDx
The field identifies the unique excursion identification number. The ID cannot repeat within one
message. This ID can be obtained through e.g. Excursions message. The field is an internal, unique
excursion number.
Universal Interface Technical Specification 7.00.0xx

Page 77 of 211

QADx
The field identifies the number of adult priced tickets to book.
QCHx
The field identifies the number of child priced tickets to book.
PROx
The field identified the promotion id, if this field is ignore, the guest will still entitle for promotion price
if available else normal price will be apply. If promotion id is sent and promotion price no longer
available, an error message will return.
e.g. If promotion price only valid for 1 seat and the guest try to book 2 seats.
With PROx send
An error message will return indicate only 1 seat is available.
Without PROx send
Booking done with 1 seat at promotion price and 1 seat at normal price.
LANx
The field identifies the language id of the tour.
INF
The field identifies the additional information send by FCUI.
PIN
The field identifies the telephone PIN code of the reservation account. The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
SRC
The field identifies the source of the booking. Eg: Workstation Id, Kiosk Id, etc. or any other details
describing the location where the booking was made.
FLG
Y-Allow posting even the guest has reached his credit limit or posting is disabled (This only apply to
check-in guest only), N-Normal posting
PATx
This is the account id for the participant, if other than the buyer. All posting will be posted to the
buyer account regard of the participant, all ticket printed will show the name of the participant.

Universal Interface Technical Specification 7.00.0xx

Page 78 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

<STX>Booking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=0123<US>ACE=A<US>ACS=C<US>BOI=Booking: A23
<US>EID=13<US>QAD=1<US>QCH=0<US>PRO=1<US>LAN=EN<US>INF=VIP
Tickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<US>PAT=2411872<ETX><CHECKSUM>
Example
Message

<STX>Booking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=0123<US>ACE=A<US>ACS=C<US>BOI=Booking: A23
<US>EID1=13<US>QAD1=1<US>QCH1=0<US>PRO1=1<US>LAN1=EN<US>EID2=14<US>Q
AD1=1<US>QCH1=0<US>PRO1=1<US>LAN1=EN <US>INF=VIP
Tickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 79 of 211

BookingResponse
BookingResponse message type is sent by the FCUI to confirm posting made.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACIx

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(52)

Salutation, Forename and Surname

CABx

X(6)

Cabin Number

EMBx

Embarkation Date

DISx

Disembarkation Date

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts
RES_DIS_E

BALx

9.9

Balance

SYSTEM CALCULATED

CRUx

9.9

Posted Cruise ID

optional

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB

POS_CRUISE

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

BookingResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. If one record is returned it serves as a confirmation that
the booking has been made. Final balance after the excursion posting is applied will be send. No
booking is inserted if more than one record is returned. In this case current balance is returned.
External system should send Booking message identifying one account that the excursion booking
should apply to.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.

Universal Interface Technical Specification 7.00.0xx

Page 80 of 211

RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACIx
The field identifies the unique account (person) identification. This ID is used for the final booking.
The field is an internal, unique account (person) number (I type).
ACTx
The field describes the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and time the account (person) is expected or embarked.
DISx
The field identifies the date and time the account (person) is expected to disembark.
BALx
The field identifies the balance after the payment is applied if one account was found. Otherwise
returns current balance. This field can return positive (account is to be invoiced) or negative
(account prepaid) value.
CRUx
The field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.

Universal Interface Technical Specification 7.00.0xx

Page 81 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>BookingResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-11
14:10:49<US>ACI1= 9001201<US>ACT1=P<US>NAM1=John Malkovitch
<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-09-12
<US>BAL1=123.45<US>CRU1=0<US>ACI2=9001202<US>ACT2=P<US>NAM2=Jane
Malkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-0913<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>BookingResponse<US>REF=TV#1<US>RQN= 1218<US>DTE=1997-091114:10:59<US>ACI=9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12
<US>BAL=145.79<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 82 of 211

ExcPackage
Excursions message type is used to request a list of excursions available from the FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

SDT

Package starting date

optional

EDT

Package ending date

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
n/a to be provided from
external system
n/a to be provided from
external system

The message is usually used to display list of excursions package that fall within date starting and
ending criteria. The following is a description of the fields in the message data block. One package
usually contain more than 1 excursion, all tours within the package must fall within the start date
and end date. If either date is ignore, it will return all the package belong to current tour.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
SDT
The field identifies the minimum date the excursions can start from. If ignore it will return the
package belong to current cruise.
EDT
The field identifies the maximum date the excursions must be completed. If ignore it will return the
package belong to current cruise.

Example
Message

<STX>ExcPackage<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>SDT=2007-08-12 00:00:00<US>EDT=2007-08-22 23:59:59<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 83 of 211

ExcPackageResponse
ExcursionsResponse message type is sent by the FCUI to supply list of excursions that fall within
starting and ending date or time specified by external system.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

PIDx

Package ID

ESP_ID

PNOx

X(10)

Package Number

ESP_NO

PNMx

X(40)

Package Description

ESP_NAME

PADx

9.9

Package Adult Price

SUM(ESL_PRICE_ADULT)

PCHx

9.9

Package Child Price

SUM(ESL_PRICE_CHILD)

SIKx

X(3)

ESE_SHOW_KIOSK

BIKx

X(3)

ESE_SELL_KIOSK

MAXx

CURx

Show in Kiosk [External Booking


System]
Book in Kiosk [External Booking
System]
Maximum Package or Maximum Adult
Package
Package or Adult package Currently
Booked

ESE_MAXPER /
ESE_MAXPER_ADULT
SYSTEM CALCULATED

STAx

X(1)

Booking or Adult Booking Status

SYSTEM CALCULATED

AVAx

Package or Adult package available

SYSTEM CALCULATED

CHSx

Maximum Childs Seats

Optional

CHBx

Child Seats Booked

Optional

STCx

X(1)

Child Booking Status

Optional

AVCx

Child Package Available

Optional

PAPx

Promotion Adult Price

Optional

PAAx

Promotion Adult Availability

Optional

PAIx

Adult Promotion ID

Optional

PCPx

Promotion Child Price

Optional

PCAx

Promotion Child Availability

Optional

PCIx

Child Promotion ID

Optional

EIDx

Excursion ID

ESE_ID

ENOx

X(10)

Excursion Number

ESE_NO

Universal Interface Technical Specification 7.00.0xx

Required

SPMS DB Field reference

Code

ESE_MAXPER_CHILD
SYSTEM CALCULATED
SYSTEM CALCULATED
SYSTEM CALCULATED
SYSTEM CALCULATED
SYSTEM CALCULATED
PRO_ID
SYSTEM CALCULATED
SYSTEM CALCULATED
PRO_ID

Page 84 of 211

Type

Description

NAMx

X(50)

Excursion Name

ESE_NAME

SDTx

Starting Date and Time

EDTx

Ending Date and Time

ESE_DATE +
ESE_FROMTIME
ESE_DATE + ESE_TOTIME

MDTx

Meeting Date and Time

optional

MPLx

X(100)

Meeting Point

optional

CTHx

X(100)

Recommended Clothes

optional

INFx

X(200)

Notes

optional

PRTx

X(50)

Port Name

CATx

X(500)

LANx

X(500)

DSCx

X(1000)

Category Id & Description [Id


Description; IdDescription]
Language Id + - + Language
Description
With , as field separator
Tour Long Description

Required

SPMS DB Field reference

Code

ESE_DATE +
ESE_MEETTIME
ESE_MEETPOINT
ESE_CLOTHES
ESE_COMMENT
ESE_PORT

Optional

ESE_CATEGORIES +
TYP_EXC.TYP_COMMENT
ESE_LANGUAGES +
TYP_LAN.TYP_COMMENT

ESE_DESCRIPTION_LONG

Optional

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records that satisfy inquiry criteria. The response message
number one is required while all the others are optional. Record number will not be present if only
one record is returned. In general each package should have more than 1 tour associate with
it. E.g. If one package have 3 tours, there will be 3 records return, all 3 records will have the
same PID, PNO, PNM, PAD, PCH, SIK, BIK, MAX, CUR, STA, AVA, CHS, CHB, STC, AVC, PAP,
PAA, PAI, PCP, PCA, PCI, but different EID, ENO, NAM, SDT, EDT, MDT, MPL, CTH, INF, PRT,
CAT, LAN.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.

Universal Interface Technical Specification 7.00.0xx

Page 85 of 211

PIDx
The field identifies the unique package identifier. This ID can be used for package booking. The field
is an internal, unique excursion number.
PNOx
The field identifies the custom, users entered, number that identifies package.
PNAx
The field identifies the package name (description).
PADx
The field identifies the package adult price.
PCHx
The field identifies the package child price.
SIKx
The flag to denote if the excursion can be shown on the external system, the field returns Yes or
No only.
BIKx
The flag to denote if the excursion can be booked on the external system, the field returns Yes or
No only.
MAXx
If PAR Use Adult/Child Max Counts is enabled, this is the maximum adult package available, if the
PAR is disabled this is the total package available.
CURx
If PAR Use Adult/Child Max Counts is enabled, this is the adult package currently booked, if the
PAR is disabled this is the total package booked.
STAx
The field identifies the package booking status. If PAR Use Adult/Child Max Counts is enabled, this
is the adult booking status, if the PAR is disabled this is the general booking status.
The following status identifiers values are defined:
A
F
O

Available
Fully booked
Overbooked

AVAx
The field identifies the package available count. Because the each tour can be sell independently
from the package, we cannot use the Total Package Total Book to get the total available. If PAR
Use Adult/Child Max Counts is enabled, this is the adult available count, if the PAR is disabled this
is the general available count.

Universal Interface Technical Specification 7.00.0xx

Page 86 of 211

CHSx
The field identifies the maximum child package available. This field only exists when PAR Use
Adult/Child Max Counts is enabled in Fidelio Cruise.
CHBx
The field identifies the child package currently booked on the excursion. This field only exists when
PAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
STCx
The field identifies the package booking status. If PAR Use Adult/Child Max Counts is enabled, this
is the child booking status, if the PAR is disabled this field will not exists.
The following status identifiers values are defined:
A
F
O

Available
Fully booked
Overbooked

AVAx
The field identifies the package available count. Because the each tour can be sell independently
from the package, we cannot use the Total Package Total Book to get the total available. If PAR
Use Adult/Child Max Counts is enabled, this is the child available count, if the PAR is disabled this
field will not exists.
PAPx
This is the adult promotion price, this field will be exists when the availability more then zero.
PAAx
This is the number of seats available for adult promotion price.
PAIx
This is the adult promotion id, it can be use during Booking. Please refer to PROx in Booking
message type for more details. In the even the adult promotion id is different from child promotion
id. You must sent two separate booking message (1 for adult, 1 for child) in order to get the
promotion price.
PCPx
This is the child promotion price, this field will be exists when the availability more than zero.
PCAx
This is the number of seats available for child promotion price.
PCIx
This is the child promotion id, it can be use during Booking. Please refer to PROx in Booking
message type for more details. In the even the adult promotion id is different from child promotion
id. You must sent two separate booking message (1 for adult, 1 for child) in order to get the
promotion price.

Universal Interface Technical Specification 7.00.0xx

Page 87 of 211

EIDx
The field identifies the unique excursion identifier. The field is an internal, unique excursion number.
ENOx
The field identifies the custom, users entered, number that identifies excursion.
NAMx
The field identifies the excursion name (description).
SDTx
The field identifies the excursion starting date and time.
EDTx
The field identifies the excursion ending date and time.
MDTx
The field identifies the excursion participants meeting date and time.
MPLx
The field identifies the excursion participants meeting place.
CTHx
The field identifies the recommended clothes for excursions participants.
INFx
The field identifies the additional information about excursion.
PRTx
The field identifies the port for the excursion.
CATx
The field identifies the categories for the excursion.
LANx
The field identifies the Language ID (2 digits) + - + Language Description, + , as field separator.
In one tour there could be more than 1 language available
e.g.
EN English
DE German
The field will be EN-English,DE-German
DSCx
Tour long Description intended for ITV usage.

Universal Interface Technical Specification 7.00.0xx

Page 88 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>ExcPackageResponse<US>REF=TV#1<US>RQN=121<US>DTE=2007-08-15
14:10:31<US>PID1=1<US>PNO1=001<US>PNM1=City Tour
Package<US>PAD1=12.10<US>PCH1=10<US>SIK1=Yes<US>BIK1=Yes<US>MAX1=200<U
S>CUR1=75<US>STA1=A<US>AVA1=A<US>CHS1=100<US>CHB1=50<US>STC1=A<US>A
VC1=A<US>PAP1=10.00<US>PAA1=1<US>PAI1=123<US>PCP1=8.00<US>PCA1=1<US>PC
I1=12<US>EID1=12<US>ENO1=2<US>NAM1=Dining with crocodiles<US>SDT1=1997-09-12
17:30:00<US>EDT1=1997-09-12 20:30:00 <US>MDT1=1997-09-12 16:30:00<US>MPL1=Deck
A<US>CTH1=Casual<US>INF1=Keep warm<US> PRT1=Nice<US>CAT1=STRStrenous<US>LAN1=EN-English<US>DSC1=Testing1<US>
PID2=1<US>PNO2=001<US>PNM2=City Tour
Package<US>PAD2=12.10<US>PCH2=10<US>SIK2=Yes<US>BIK2=Yes<US>MAX2=200<U
S>CUR2=75<US>STA2=A<US>AVA2=A<US>CHS2=100<US>CHB2=50<US>STC2=A<US>A
VC2=A<US>PAP2=10.00<US>PAA2=1<US>PAI2=123<US>PCP2=8.00<US>PCA2=1<US>PC
I2=12<US>EID2=13<US>ENO2=4<US>NAM2=Dining on Sundeck<US>SDT2=1997-09-12
17:45:00<US>EDT2=1997-09-12
20:30:00<US>STA2=F<US>PAD2=12.00<US>PCH2=9.10<US>MDT2=1997-09-12
16:30:00<US>MPL2=Deck A<US>CTH2=Casual<US>INF2=Keep
warm<US>SIK2=Yes<US>BIK2=No<US>MAX2=150<US>CUR2=125<US>PRT2=Nice<US>C
AT2=AD-All Day;LI-Lunch Included<US>LAN2=ENEnglish<US>DSC2=Testing2<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 89 of 211

BookingPackage
Booking message type is sent to the FCUI to insert excursion booking and post excursion charge.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status

BOI

X(30)

Unique Package Booking ID

PIDx

Package ID

QADx

Number of Adult Tickets

QCHx

Number of Child Tickets

PROx

Promotion ID

optional

LANx

X(2)

Language ID

optional

INF

X(50)

Notes

optional

PIN

PIN Code

optional

SRC

X(100)

Booking Source

optional

FLG

Y-Allow posting even the guest has


reached his credit limit or posting is
disable, N-Normal posting

optional

PATx

Participant Account ID

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
RES_STATUS translated to
R/C
n/a to be provided from
external system
ESP_ID
n/a to be provided from
external system
n/a to be provided from
external system
PRO_ID
ESE_LANGUAGES
n/a to be provided from
external system
RES_PIN_CODE
n/a to be provided from
external system
n/a to be provided from
external system
RES_ACC

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more excursions within one booking transaction. This way
FCSPMS can assign the whole booking as one transaction that can be traced and voided later on.
Record number cannot be used if only one record is send.

Universal Interface Technical Specification 7.00.0xx

Page 90 of 211

REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
N
I
G
E
T
M
H
X
R
F
P

Card identification number (RES_BOARDCC)


Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)
Name of a person or company account(UXP_A_NAME_N)
Internal identification number (UXP_A_ID)
Group Id number (RES_GRP)
External identification number (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)
Internal Id number(UXP_C_INTERNALID)
Guest Category(GCT_CODE)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

ACS
The field identifies the account current reservation status. The following status values are accepted:
R
C

Reservations
Checked-in

BOI
The field identifies the booking (check) unique within the whole external system. The field is used as
a cross-reference to obtain detailed information about all the transactions recorded on a booking.
PIDx

Universal Interface Technical Specification 7.00.0xx

Page 91 of 211

The field identifies the unique package identification number. The ID cannot repeat within one
message. This ID can be obtained through e.g. Excursions message. The field is an internal, unique
package number.
QADx
The field identifies the number of adult priced tickets to book.
QCHx
The field identifies the number of child priced tickets to book.
PROx
The field identified the promotion id, if this field is ignore, the guest will still entitle for promotion price
if available else normal price will be apply. If promotion id is sent and promotion price no longer
available, an error message will return.
e.g. If promotion price only valid for 1 seat and the guest try to book 2 seats.
With PROx send
An error message will return indicate only 1 seat is available.
Without PROx send
Booking done with 1 seat at promotion price and 1 seat at normal price.
LANx
The field identifies the language id of the tour.
INF
The field identifies the additional information send by FCUI.
PIN
The field identifies the telephone PIN code of the reservation account. The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
SRC
The field identifies the source of the booking. Eg: Workstation Id, Kiosk Id, etc. or any other details
describing the location where the booking was made.
FLG
Y-Allow posting even the guest has reached his credit limit or posting is disabled (This only apply to
check-in guest only), N-Normal posting
PATx
This is the account id for the participant, if other than the buyer. All posting will be posted to the
buyer account regard of the participant, all ticket printed will show the name of the participant.

Universal Interface Technical Specification 7.00.0xx

Page 92 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

<STX>BookingPackage<US>REF=TV#1<US>RQN=1214<US>DTE=2007-08-15
4:10:45<US>ACI=0123<US>ACE=A<US>ACS=C<US>BOI=Booking: A23
<US>PID=13<US>QAD=1<US>QCH=0<US>PRO=1<US>LAN=EN<US>INF=VIP
Tickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<US>PAT=2411872<ETX><CHECKSUM>
Example
Message

<STX>BookingPackage<US>REF=TV#1<US>RQN=1214<US>DTE=2007-08-15
14:10:45<US>ACI=0123<US>ACE=A<US>ACS=C<US>BOI=Booking: A23
<US>PID1=13<US>QAD1=1<US>QCH1=0<US>PRO1=1<US>LAN1=EN<US>PID2=14<US>Q
AD1=1<US>QCH1=0<US>PRO1=1<US>LAN1=EN <US>INF=VIP
Tickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 93 of 211

BookingPackageResponse
BookingResponse message type is sent by the FCUI to confirm posting made.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACIx

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(52)

Salutation, Forename and Surname

CABx

X(6)

Cabin Number

EMBx

Embarkation Date

DISx

Disembarkation Date

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts
RES_DIS_E

BALx

9.9

Balance

SYSTEM CALCULATED

CRUx

9.9

Posted Cruise ID

optional

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB

POS_CRUISE

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

BookingResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. If one record is returned it serves as a confirmation that
the booking has been made. Final balance after the excursion posting is applied will be send. No
booking is inserted if more than one record is returned. In this case current balance is returned.
External system should send Booking message identifying one account that the excursion booking
should apply to.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.

Universal Interface Technical Specification 7.00.0xx

Page 94 of 211

RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACIx
The field identifies the unique account (person) identification. This ID is used for the final booking.
The field is an internal, unique account (person) number (I type).
ACTx
The field describes the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and time the account (person) is expected or embarked.
DISx
The field identifies the date and time the account (person) is expected to disembark.
BALx
The field identifies the balance after the payment is applied if one account was found. Otherwise
returns current balance. This field can return positive (account is to be invoiced) or negative
(account prepaid) value.
CRUx
The field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.

Universal Interface Technical Specification 7.00.0xx

Page 95 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>BookingResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-11
14:10:49<US>ACI1= 9001201<US>ACT1=P<US>NAM1=John Malkovitch
<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-09-12
<US>BAL1=123.45<US>CRU1=0<US>ACI2=9001202<US>ACT2=P<US>NAM2=Jane
Malkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-0913<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>BookingResponse<US>REF=TV#1<US>RQN= 1218<US>DTE=1997-091114:10:59<US>ACI=9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12
<US>BAL=145.79<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 96 of 211

ExcFolio
ExcFolio message type is used to request list of excursions booked on a specific account in
FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification number. This ID can be obtained
through e.g. Inquire message. The field is an internal, unique account (person) number (I type).

Example
Message

<STX>ExcFolio<US>REF=TV#1<US>RQN=1209<US>DTE=1997-09-11
14:10:23<US>ACI=9001201<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 97 of 211

ExcFolioResponse
ExcFolioResponse message type is sent by the FCUI to supply the list of excursions currently
booked for the account specified by an external system. The message returns the same list of
excursions that are visible through FCSPMS system.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

EIDx

Excursion ID

ESE_ID

ENOx

X(10)

Excursion Number

ESE_NO

NAMx

X(50)

Excursion Name

ESE_NAME

SDTx

Starting Date and Time

EDTx

Ending Date and Time

ESE_DATE +
ESE_FROMTIME
ESE_DATE + ESE_TOTIME

STAx

X(1)

Excursion Status

SYSTEM CALCULATED

BDTx

Booking Date and Time

EPO_PDAT

BOQx

Number of Tickets Booked

EPO_QUANT

BOVx

9.9

Booking Value

SYSTEM CALCULATED

MDTx

MPLx

Meeting Date and Time

optional

X(100)

Meeting Point

optional

CTHx

X(100)

Recommended Clothes

optional

INFx

X(200)

Notes

optional

TAGx

X(1)

TAG

optional

PCNx

PPEx

X(3)

ESE_DATE +
ESE_MEETTIME
ESE_MEETPOINT
ESE_CLOTHES
ESE_COMMENT
EPO_PRICE_TAG

Ticket Printed Count

EPO_TICKET_PRINTED

Prepaid Status flag

EPO_PREPAID

The message can return one or more records of the data to satisfy inquiry criteria. The response
message number one is required while all the others are optional. Record number will not be
present if only one record is returned. The following is a description of the fields in the message
data block.

Universal Interface Technical Specification 7.00.0xx

Page 98 of 211

REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
EIDx
The field identifies the unique excursion identifier. This ID can be used to link the excursion with
items retrieved through Excursions message. The field is an internal, unique excursion number.
ENOx
The field identifies the custom, users entered, number that identifies excursion.
NAMx
The field identifies the excursion name (description).
SDTx
The field identifies the excursion starting date and time.
EDTx
The field identifies the excursion ending date and time.
STAx
The field identifies the excursion booking status. The following status identifiers values are defined:
A
F
O

Available
Fully Booked
Overbooked

BDTx
The field identifies the excursion booking date and time (real date and time).
BOQx
The field identifies the number of tickets booked.
BOVx
The field identifies the total value of the bookings for the returned excursions.

Universal Interface Technical Specification 7.00.0xx

Page 99 of 211

MDTx
The field identifies the excursion participants meeting date and time.
MPLx
The field identifies the excursion participants meeting place.
CTHx
The field identifies the recommended clothes for excursions participants.
INFx
The field identifies the additional information about excursion.
TAGx
The field identifies the adult or children indicator.
A
C

Adult
Children

PCNx
The field identifies how many times the tickets had been printed.
PPEx
The flag to denote if Booking is Prepaid or not, the field returns Yes or No only.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Exampl
e
Messag
e

<STX>ExcFolioResponse<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:11:12<US>EID=12<US>ENO=2<US>NAM=Dining with crocodiles<US>SDT=1997-09-12
17:30:00<US>EDT=1997-09-12 20:30:00<US>STA=A<US>BDT=1997-09-13
12:34:21<US>BOQ=1<US>BOV=12.10<US>MDT=1997-09-12 16:30:00<US>MPL=Deck
A<US>CTH=Casual<US>INF=Keepwarm<US>TAG=A<US>PCN=1<US>PPE1=No<ETX><CHEC
KSUM>
<STX>ExcFolioResponse<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:11:12<US>EID1=12<US>ENO1=2<US>NAM1=Dining with crocodiles<US>SDT1=1997-09-12
17:30:00<US>EDT1=1997-09-12 20:30:00<US>STA1=A<US>BDT1=1997-09-13
12:34:21<US>BOQ1=1<US>BOV1=12.10<US>MDT1=1997-09-12 16:30:00<US>MPL1=Deck
A<US>CTH1=Casual<US>INF1=Keep
warm<US>TAG1=A<US>PCN1=1<US>EID2=12<US>ENO2=2<US>NAM2=Dining with
crocodiles<US>SDT2=1997-09-12 17:30:00<US>EDT2=1997-09-12
20:30:00<US>STA2=A<US>BDT2=1997-09-13
12:34:21<US>BOQ2=1<US>BOV2=12.10<US>MDT2=1997-09-12 16:30:00<US>MPL2=Deck
A<US>CTH2=Casual<US>INF2=Keepwarm<US>TAG2=C<US>PCN2=1<US>PPE2=Yes<ETX><
CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 100 of 211

Call
Call message type is sent to the FCUI to insert phone call charges.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

COI

X(30)

Unique Call ID

POV

9.9

Call Posting Value

NUM

X(30)

BEG

Dialed Number

optional

Call Start Date and Time

optional

DUR

Call Duration

optional

TYP

X(2)

Call Type

optional

INF

X(50)

Notes

optional

FLG

Y-Allow posting even the guest has


reached his credit limit or posting is
disable, N-Normal posting

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE field definition
below
Refer to ACE type definition
below
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system

The message is usually accepted due to phone call nature. There are only few error commands that
can be returned to PBX system. All those errors would indicate major set-up problem and must be
resolved during installation. When more than one account is found (when using cabin number, trunk
number or person name as account identifier) the posting is assigned to only one person in a cabin.
Phone postings are accepted for checked-in people only.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.

Universal Interface Technical Specification 7.00.0xx

Page 101 of 211

DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Identifier received from external system. Generally contains any information necessary to identify an
account the postings should be inserted into. The field can be account number, card number, cabin
number, trunk number, personal pin code number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
I
E
T
H
R
F
P

Card identification number (RES_BOARDCC)


Cabin number or System account. (RES_CAB/UXP_A_SYS_ACC)
Internal identification number (FCSPMS account ID) (UXP_A_ID)
External identification number (e.g. reservation number) (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
Internal Id number (UXP_C_INTERNALID)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

COI
The field identifies the unique bill (check) within the whole external system. It used to link phone
calls recorded in FCSPMS system with entries stored in the PBX.
POV
The field identifies the actual call value total being posted.
NUM
The field identifies the phone number called.
BEG
The field identifies the date and time when the phone call started. Full date and time format is
required.
DUR
The field identifies the phone call duration in seconds.

Universal Interface Technical Specification 7.00.0xx

Page 102 of 211

TYP
The field identifies the phone call type. The following types are defined:
VL
VC
VS
VN
FL
FC
FS
FN
DL
DC
DS
DN

Line Voice Call


Cellular Voice Call
Satellite Voice Call
Non chargeable Voice Call
Line Fax
Cellular Fax
Satellite Fax
Non chargeable Fax
Line Data Call
Cellular Data Call
Satellite Data Call
Non chargeable Data Call

INF
The field identifies the additional information send by FCUI.
FLG
Y-Allow posting even the guest has reached his credit limit or posting is disabled (This only apply to
check-in guest only), N-Normal posting

Example
Message

<STX>Call<US>REF=PBX#1<US>RQN=121<US>DTE=1997-09-11
14:10:32<US>ACI=0123<US>ACE=T <US>COI=Call: 00103, Line:
121<US>POV=12.34<US>NUM=+1 (343) 324-2343<US>BEG=1997-09-11
14:03:32<US>DUR=234<US>TYP=VC<US>INF=Long Distance Call<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 103 of 211

CallResponse
CallResponse message type is sent by the FCUI to confirm call posting made.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

ACT

X(1)

Account Type

RES_TAG

NAM

X(52)

Salutation, Forename and Surname

CAB

X(6)

Cabin Number

EMB

Embarkation Date

DIS

Disembarkation Date

BAL

9.9

Balance

CRU

9.9

Posted Cruise ID

optional

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB
RES_EMB_E for expected
accounts, RES_EMB_A for
checked in accounts
RES_DIS_E for expected &
checked in accounts,
RES_DIS_A for checked out
accounts
(UXP_A_POS_DEBIT
UXP_A_POS_CREDIT)
POS_CRUISE

CallResponse message serves as a confirmation that the call posting has been made. Final balance
after the payment is applied will be send. Most PBX systems will simply ignore the message. The
following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
This field identifies the unique account (person) identification. This ID was used for the final call
posting. The field is an internal, unique account (person) number (I type).
Universal Interface Technical Specification 7.00.0xx

Page 104 of 211

ACT
This field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAM
This field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CAB
This field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMB
This field identifies the date and time the account (person) embarked.
DIS
This field identifies the date and time the account (person) is expected to disembark.
BAL
This field identifies the balance after the call posting is applied. This field can return positive
(account is to be invoiced) or negative (account prepaid) value.
CRU
This field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.

Example
Message

<STX>CallResponse<US>REF=PBX#1<US>RQN=121<US>DTE=1997-09-11
14:10:24<US>ACI= 9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12
<US>BAL=145.56<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 105 of 211

CabinStatus
CabinStatus message type is used to request cabin status change in FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

CAB

Cabin Number

CAB_ID

STA

X(1)

Status to Change To

n/a to be provided from


external system

The message is usually used to inform FCSPMS when the external system wants to change the
cabins status.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
CAB
The field identifies the cabin in FCSPMS where the status is to change.
STA
The field identifies the type of the status code being passed for change.
VC
VD
OC
OD
PU
FA
VF
Example
Message

Vacant Clean
Vacant Dirty
Occupied Clean
Occupied Dirty
Pickup Require
Verified Failed
Verified

<STX>CabinStatus<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>CAB=2001<US>STA=OC<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 106 of 211

PhoneCheckIn
PhoneCheckIn message type is sent from FCUI to PBX system to open (unblock) phone lines.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided by
system
n/a to be provided by
system
Current date and time

ACIx

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(100)

Salutation, Forename and Surname

LANx

X(2)

Person Language

TYPx

X(1)

Call Types Allowed

NUMx

Phone Line Number

PINx

PIN Code

optional

AKYx

X(4)

Authorization Key

optional

FSTx

X(40)

First Name

Refer to PAR Value for PARInterfaces-AuthKey Criteria


UXP_A_FSTN

LSTx

X(40)

Last Name

UXP_A_NAME

SALx

X(20)

Salutation

UXP_A_SALUTE

TTLx

X(20)

Title

UXP_A_TITLE

GIDx

X(15)

Group ID

CSWx

X(100)

Cabin Steward Name

RES_SHOREID(refer to
Group)
RES_ACC (linked to
CAB_KEEPER)
No db field link, only exists
during data change event

Y Indicate this message is sent


during data change event
N-Indicate this is the message send
during check-in/cabin move

Required

SPMS DB Field reference

Code

Refer to PAR value for PARInterfaces Call Types


Allowed
CAB_TEL/CAB_TEL2
RES_PIN_CODE

CHGx

X(1)

EMBx

Embarkation Date

DISx

Disembarkation Date

VGDx

X(50)

Unique Guest ID

RES_V_GUESTID

NATx

X(6)

Passport Nationality

UXP_H_PASSPI_COUNTRY

Universal Interface Technical Specification 7.00.0xx

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
UXP_H_LANG

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts
RES_DIS_E for expected &
checked in accounts,
RES_DIS_A for checked out
accounts

Page 107 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more phone numbers within one check-in message. This way
FCSPMS can open multiple phone lines for a person being checked-in. Record number will not be
present if only one record is send. The message will be send each time a new person is checked-in
to the cabin with the phone line number specified. PBX system must be able to either support
multiple number of people assigned to one or more phone numbers or ignore any new assignment if
phone line is already open. The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACIx
This field identifies the unique account (person) identifier. It can be used to uniquely identify a
person that is checking-in.
ACTx
This field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of a person
that is being checked-in.
LANx
The field identifies the language of a person that is being checked-in. ISO 2 letter language
identifiers are used.

Universal Interface Technical Specification 7.00.0xx

Page 108 of 211

TYPx
The field identifies the call types that can be made from the number. Some types require that a
person swipes credit or onboard card first before the phone call can be made - this applies to some
types of phone calls only.
B
I
L
A
D
W

Block (No phone calls allowed)


Internal (Local) Only
Long Distance and Internal Only
International, Long Distance and Internal
Long Distance (requiring card swipe) and Internal Only
International and Long Distance (require card swipe) and Internal

PINx
The field identifies the PIN number that a person must key-in before phone call is started. Pin code
is generated by FCSPMS application but validation of the pin code when a person wants to make a
phone call is handles by PBX system. The valid character is 0,1,2,3,4,5,6,7,8,9. Leading zero
support depend on Fidelio Parameter setting.
NUMx
The field identifies the phone line to be opened. Small x denotes fact that the field can be repeated
within <DATA> block which means that multiple phone lines can be open for the person being
checked-in.
AKYx
The field identifies the authorization key for the person(s) that satisfy the inquiry criteria.
GIDx
The field identifies the group shore id of the group if a passenger is assigned to a group.
CSWx
The field identifies the housekeeper assign to this cabin
VGDx
The field identifies the unique guest id.
NATx
The field identifies the guest passport nationality
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>PhoneCheckIn<US>REF=FCUI#1<US>RQN=121<US>DTE= 2001-091114:10:32<US>ACI=1234<US>ACT=P<US>NAM=John
Malkovitch<US>LAN=EN<US>TYP=A<US>NUM=0123<US>INF=VIP<US>PIN=12345<US>AK
Y=5542<ETX><CHECKSUM>
<STX>PhoneCheckIn<US>REF=FCUI#1<US>RQN=122<US>DTE=2001-09-11
14:10:38<US>ACI=4534<US>ACT=P <US>NAM=Wolfgang
Schmidt<US>LAN=DE<US>TYP=L<US>PIN=21334<US>NUM1=0125<US>NUM2=0126<ETX>
<CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 109 of 211

PhoneCheckOut
PhoneCheckOut message type is sent from FCUI to PBX system to close (block) phone lines.
Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

LST

X(1)

Last Person Assigned to Phone


Number

SYSTEM CALCULATED

Phone Line Number

CAB_TEL/CAB_TEL2

NUMx

Description

Required

SPMS DB Field reference

Code

PGI

X(8)

Pregenerated Random ID

RES_PGID

VGDx

X(50)

Unique Guest ID

RES_V_GUESTID

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more phone numbers within one check-out message. This way
FCSPMS can close multiple phone lines for a person being checked-out. The message will be send
each time a person is checked-out from a cabin with the phone line number specified. PBX system
must be able to either support multiple phone number check-outs or ignore all check-outs until the
last person is checked-out from the cabin. Parameter LST is used to determine if the last person is
checking-out from the cabin. PBX should also remove all pending wake-up calls, messages etc. that
are linked to the specified person or phone number. The following is a description of the fields in the
message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.

Universal Interface Technical Specification 7.00.0xx

Page 110 of 211

ACI
The field identifies the unique account (person) identifier. It can be used to uniquely identify a
person that is checking-out.
LST
Boolean value identifying if the last person assigned to the phone number or cabin is checking-out.
Y
N

The last person assigned to the phone number/cabin is checking-out


There are still people assigned to the phone number/cabin

NUMx
The field identifies the phone lines to be closed. Small x denotes fact that the field can be repeated
within <DATA> block which means that multiple phone lines can be closed for the person being
checked-out.
PGI
Pregenerated Random Number
VGDx
The field identifies the unique guest id.
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

<STX>PhoneCheckOut<US>REF=FCUI#1<US>RQN= 1218<US>DTE=2001-091114:18:32<US>ACI=1234<US>LST=N<US>NUM=0123 <ETX><CHECKSUM>


Example
Message

<STX>PhoneCheckOut<US>REF=FCUI#1<US>RQN=1229<US>DTE=2001-09-11
14:19:38<US>ACI=4534<US>LST=Y<US>NUM1=0125<US>NUM2=0126<US>PGI=12345678
<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 111 of 211

PhoneCabinMove
PhoneCabinMove message type is sent by the FCUI to supply the information to the external
system about a Change of Cabin. The Phone System has to respond with an Acknowledge
message type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

ACT

X(1)

Account Type

RES_TAG

OCN

X(6)

Old Cabin Number

RES_CAB

NCN

X(6)

NewCabin Number

RES_CAB

NAM

X(100)

Salutation, Forename and Surname

LAN

X(2)

Person Language

TYP

X(1)

Call Types Allowed

NUMx

Phone Line Number

PIN

PIN Code

optional

AKY

X(4)

Authorization Key

optional

Refer to PAR Value for PARInterfaces-AuthKey Criteria

FST

X(40)

First Name

UXP_A_FSTN

LST

X(40)

Last Name

UXP_A_NAME

SAL

X(20)

Salutation

UXP_A_SALUT

TTL

X(20)

Title

UXP_A_TITEL

GID

X(15)

Group ID

CSW

X(100)

Cabin Steward Name

RES_SHOREID(refer to
Group)
RES_ACC (linked to
CAB_KEEPER)

VGDx

X(50)

Unique Guest ID

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
UXP_H_LAN
Refer to PAR value for PARInterfaces Call Types
Allowed
CAB_TEL/CAB_TEL2
RES_PIN_CODE

RES_V_GUESTID

The following is a description of the fields in the message data block.


REF
The field identifies the source or destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
Universal Interface Technical Specification 7.00.0xx

Page 112 of 211

FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
ACT
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

OCN
The field identifies the Old Cabin No.
NCN
The field identifies the New Cabin No.
NAM
The field identifies the salutation, forename and surname fields (separated with space) of a person
that is being checked-in.
LAN
The field identifies the language of a person that is being checked-in. ISO 2 letter language
identifiers are used.
TYP
The field identifies the call types that can be made from the number. Some types require that a
person swipes credit or onboard card first before the phone call can be made - this applies to some
types of phone calls only.
B
I
L
A
D
W

Block (No phone calls allowed)


Internal (Local) Only
Long Distance and Internal Only
International, Long Distance and Internal
Long Distance (requiring card swipe) and Internal Only
International and Long Distance (require card swipe) and Internal

Universal Interface Technical Specification 7.00.0xx

Page 113 of 211

PIN
The field identifies the PIN number that a person must key-in before phone call is started. Pin code
is generated by FCSPMS application but validation of the pin code when a person wants to make a
phone call is handles by PBX system. The valid character is 0,1,2,3,4,5,6,7,8,9. Leading zero
support depend on Fidelio Parameter setting.
NUMx
The field identifies the phone line to be opened. Small x denotes fact that the field can be repeated
within <DATA> block which means that multiple phone lines can be open for the person being
checked-in.
AKY
The field identifies the authorization key for the person(s) that satisfy the inquiry criteria.
GID
The field identifies the group shore id of the group if a passenger is assigned to a group.
CSW
The field identifies the housekeeper assign to this cabin
VGDx
The field identifies the unique guest id.

Example
Message

<STX>PhoneCabinMove<US>REF=FCUI#1<US>RQN= 121<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>ACT=P<US>OCN=0123<US>NCN=10000<US>NAM=MR
TEST
PAX0005<US>LAN=EN<US>TYP=A<US>NUM=10000<US>PIN=0<US>AKY=1739<US>FST=
TEST<US>LST=PAX0005<US>SAL=MR<US>GID=GGTN79220<US>CSW=1<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 114 of 211

PhoneResponse
PhoneResponse message type is sent by PBX to confirm any Phone command received from
FCUI was successfully executed.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

PhoneResponse message serves as a confirmation that the phone command (e.g. check-in or
check-out) has been made. The following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identifier received in the originating Phone
command.

Example
Message

<STX>PhoneResponse<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-11
14:10:32<US>ACI=1234<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 115 of 211

EnablePhone
EnablePhone message type is sent from FCUI to PBX system to open (unblock) phone lines.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided by
system
n/a to be provided by
system
Current date and time

ACI

X(52)

Account ID

RES_ACC

ACT

X(1)

Account Type

RES_TAG

NAM

X(52)

Salutation, Forename and Surname

LAN

X(2)

Person Language

TYP

X(1)

Call Types Allowed

NUMx

Phone Line Number

PIN

PIN Code

optional

AKY

X(4)

Authorization Key

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
UXP_H_LAN
Refer to PAR value for PARInterfaces Call Types
Allowed
CAB_TEL/CAB_TEL2
RES_PIN_CODE
Refer to PAR Value for PARInterfaces-AuthKey Criteria

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more phone numbers within one enable phone message. Record
number will not be present if only one record is send.
The following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.

Universal Interface Technical Specification 7.00.0xx

Page 116 of 211

DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identifier. It can be used to uniquely identify a
person that is checking-in.
ACT
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAM
The field identifies the salutation, forename and surname fields (separated with space) of a person
that is being checked-in.
LAN
The field identifies the language of a person that is being checked-in. ISO 2 letter language
identifiers are used.
TYP
The field identifies the call types that can be made from the number. Some types require that a
person swipes credit or onboard card first before the phone call can be made - this applies to some
types of phone calls only.
B
I
L
A
D
W

Block (No phone calls allowed)


Internal (Local) Only
Long Distance and Internal Only
International, Long Distance and Internal
Long Distance (requiring card swipe) and Internal Only
International and Long Distance (require card swipe) and Internal

PIN
The field identifies the PIN number that a person must key-in before phone call is started. Pin code
is generated by FCSPMS application but validation of the pin code when a person wants to make a
phone call is handles by PBX system. The valid character is 0,1,2,3,4,5,6,7,8,9. Leading zero
support depend on Fidelio Parameter setting.
NUMx
The field identifies the phone line to be opened. Small x denotes fact that the field can be repeated
within <DATA> block which means that multiple phone lines can be open for the person being
checked-in.

Universal Interface Technical Specification 7.00.0xx

Page 117 of 211

AKY
The field identifies the authorization key for the person(s).

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>EnablePhone<US>REF=FCUI#1<US>RQN=121<US>DTE= 2001-091114:10:32<US>ACI=1234<US>ACT=P<US>NAM=John
Malkovitch<US>LAN=EN<US>TYP=A<US>NUM=0123<US>
PIN=12345<US>AKY=5542<ETX><CHECKSUM>
<STX> EnablePhone <US>REF=FCUI#1<US>RQN=122<US>DTE=2001-09-11
14:10:38<US>ACI=4534<US>ACT=P<US>NAM=Wolfgang
Schmidt<US>LAN=DE<US>TYP=L<US>PIN=21334<US>NUM1=0125<US>NUM2=0126
<US>PIN=12345<US>AKY=5542<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 118 of 211

DisablePhone
DisablePhone message type is sent from FCUI to PBX system to close (block) phone lines.
Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

LST

X(1)

Last Person Assigned to Phone


Number

SYSTEM CALCULATED

Phone Line Number

CAB_TEL/CAB_TEL2

NUMx

Description

Required

SPMS DB Field reference

Code

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more phone numbers within one disable phone message. The
following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identifier. It can be used to uniquely identify a
person that is checking-out.

Universal Interface Technical Specification 7.00.0xx

Page 119 of 211

LST
Boolean value identifying if the last person assigned to the phone number or cabin is checking-out.
Y
N

The last person assigned to the phone number or cabin is checking-out


There are still people assigned to the phone number or cabin

NUMx
The field identifies the phone lines to be closed. Small x denotes fact that the field can be repeated
within <DATA> block which means that multiple phone lines can be closed for the person being
checked-out.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

<STX>DisablePhone<US>REF=FCUI#1<US>RQN=1218<US>DTE=2001-091114:18:32<US>ACI=1234<US>LST=N<US>NUM=0123 <ETX><CHECKSUM>
Example
Message

<STX>DisablePhone<US>REF=FCUI#1<US>RQN=1229<US>DTE=2001-09-11
14:19:38<US>ACI=4534<US>LST=Y<US>NUM1=0125<US>NUM2=0126
<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 120 of 211

ExtCheckIn
ExtCheckIn message type is sent by the FCUI to supply the information to the external system
about a Check-In. The External System has to respond with an Acknowledge message type.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

ACT

X(1)

Account Type

RES_TAG

ENB

Account Enabled

UXP_A_POSTING

NAM

X(52)

Salutation, Forename and Surname

CAB

X(6)

Cabin Number

EMB

Embarkation Date

DIS

Disembarkation Date

DOB

Date of birth

optional

UXP_H_BIRTHD

EML

X(50)

E-mail address

optional

UXP_H_EMAIL

BAL

9.9

Balance

(UXP_A_POS_DEBIT
UXP_A_POS_CREDIT)

FST

X(30)

First Name

UXP_A_FSTN

LST

X(30)

Last Name

UXP_A_NAME

SAL

X(15)

Salutations

UXP_A_SALUT

TTL

X(15)

Title

UXP_A_TITEL

GND

X(1)

Gender

UXP_H_SEX

MIN

X(1)

Minor

Parameter Adult Min Age


compared to Birthdate

LAN

X(2)

Language

UXP_H_LANG

STA

X(2)

RES_STATUS translated to
E/C/D

GRP

9,X(30)

optional

RES_GRP

CAT

X(500)

Reservation Status [EExpected, C


Checked-In, DDeparted]
Group Id & Description [Id
Description]
Category Id & Description [Id
Description; IdDescription]

optional

RES_PPD_TAG

Universal Interface Technical Specification 7.00.0xx

Required

SPMS DB Field reference

Code

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB
RES_EMB_E for expected
accounts, RES_EMB_A for
checked in accounts
RES_DIS_E for expected &
checked in accounts,
RES_DIS_A for checked out
accounts

Page 121 of 211

SPMS DB Field reference

Code

Type

Description

Required

ADD

X(30)

Address

optional

UXP_A_STREET

STR

X(30)

Street

optional

UXP_A_STREET3

CTY

X(30)

City

optional

UXP_A_CITY

ZIP

X(10)

ZIP Code

optional

UXP_A_ZIP

STT

X(20)

State

optional

UXP_A_STATE

CTR

X(6)

Country Code

optional

UXP_A_COUNTRY

TEL

X(30)

Telephone Number

optional

UXP_H_TELNO

Credit Limit

optional

Credit limit as per assigned


credit department code,
unless individual credit limit
is assigned in
UXP_A_CRELIM

Ships e-Mail Id

optional

RES_EMAIL_SHIP

PIN Code

optional

RES_PIN_CODE

optional

CLM

9.9

SML

X(72)

PIN

AKY

X(4)

Authorization Key

BCC

X(20)

On board Cabin Card

AWD

X(6)

Award Level

optional

NAT

X(6)

Passport Nationality

optional

BID

X(100)

Booking ID

optional

GID

X(15)

Group ID

optional

CSW

X(100)

Cabin Steward Name

optional

Refer to PAR Value for


PAR- Interfaces-AuthKey
Criteria
RES_BOARDCC
RES_AWARD_LEVEL
UXP_H_PASSPI_COUNTR
Y
RES_BOOKNR
RES_SHOREID(refer to
Group)
RES_ACC (linked to
CAB_KEEPER)

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field identifies the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.

Universal Interface Technical Specification 7.00.0xx

Page 122 of 211

ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
ACT
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

ENB
The field identifies the information if an account is enabled (1) or disabled (0).
NAM
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person).
CAB
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMB
The field identifies the date and time the account (person) is expected or embarked.
DIS
The field identifies the date and time the account (person) is expected to disembark.
DOB
The field identifies the person date of birth. If the account number is returned (not a person) or date
of birth is not present the field is omitted.
EML
The field identifies the person e-mail address. If the account number is returned (not a person) or email is not present the field is omitted.
BAL
The field identifies the the account (person) current balance. This field can return positive (account
is to be invoiced) or negative (account prepaid) value.
FST
The field identifies the forename of an account (person).
LST
The field identifies surname of an account (person).
SAL
The field identifies the salutation of an account (person).

Universal Interface Technical Specification 7.00.0xx

Page 123 of 211

TTL
The field identifies the title of an account (person).
GND
The field identifies the gender of an account (person).
MIN
The field identifies the "Y" or "N" if the account (person) is a Minor.
LAN
The field identifies the language of an account (person).
GRP
The field identifies the Group Id and the name of the Group if a passenger is assigned to a Group.
CAT
The field identifies the Category Ids and the names of the Categories if a passenger is assigned any
Categories.
ADD
The field identifies the address (Line 1).
STR
The field identifies the street (Line 2).
CTY
The field identifies the city.
ZIP
The field identifies the zip code.
STT
The field identifies the state.
CTR
The field identifies the country code.
TEL
The field identifies the telephone number.
CLM
The field identifies the credit limit.
SML
The field identifies the Ships e-Mail Address.
PIN
The field identifies the telephone PIN code for the person(s). The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKY
The field identifies the authorization key for the person(s) that satisfy the inquiry criteria.

Universal Interface Technical Specification 7.00.0xx

Page 124 of 211

BCC
It contain Track 2 field 1 value of the on board cabin card excluding start sentinel and end sentinel.
e.g. The value encode in track 2 is ;9910000657580701=20060810?, we will only send
9910000657580701
AWD
The field identifies the guest award level.
NAT
The field identifies the guest passport nationality
BID
The field identifies the booking id.
GID
The field identifies the group shore id of the group if a passenger is assigned to a group.
CSW
The field identifies the housekeeper assign to this cabin

Example
Message

<STX>ExtCheckIn<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>ACT=P<US>ENB=1<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US> DIS=1997-0912<US>DOB=1970-0408<US>EML=John@yahoo.com<US>BAL=2000.00<US>FST=John<US>LST=Malkovitch<US>
SAL=<US>TTL=<US>GND=M<US>MIN=N<US>LAN=EN<US>STA=C<US>GRP=9002402Holiday Group<US>CAT=FQT-Frequent Cruisers;SNR-Senior Citizen<US>ADD=Borsel Str.
16C<US>STR=Altona<US>CTY=Hamburg<US>ZIP=22765<US>STT=Hamburg<US>CTR=DE<
US>TEL=+49 (40) 39900163<US>CLM=2000.00<US>SML=John0123@shipsname.com<US>PIN=123452<US>AKY=5
543<US>BCC=9841000020957311<US>AWD=GOLD<US> NAT=SG<US>
BID=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 125 of 211

ExtCheckOut
ExtCheckOut message type is sent by the FCUI to supply the information to the external system
about a CheckOut. The External System has to respond with an Acknowledge message type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

ACT

X(1)

Account Type

RES_TAG

BCC

X(20)

On board Cabin Card

PGI

X(8)

Pregenerated Random ID

Optional

RES_BOARDCC
RES_PGID

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field identifies the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
ACT
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

Universal Interface Technical Specification 7.00.0xx

Page 126 of 211

BCC
It contain Track 2 field 1 value of the on board cabin card excluding start sentinel and end sentinel.
e.g. The value encode in track 2 is ;9910000657580701=20060810?, we will only send
9910000657580701
PGI
Pregenerated Random Number

Example
Message

<STX>ExtCheckOut<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>ACT=P<US>BCC=9841000020957311<US>PGI=12345678
<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 127 of 211

ExtCabinMove
ExtCabinMove message type is sent by the FCUI to supply the information to the external system
about a Change of Cabin. The External System has to respond with an Acknowledge message
type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

ACT

X(1)

Account Type

RES_TAG

OCN

X(6)

Old Cabin Number

RES_CAB/CAB_ID

NCN

X(6)

NewCabin Number

RES_CAB/CAB_ID

BCC

X(20)

On board Cabin Card

Optional

RES_BOARDCC

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).

Universal Interface Technical Specification 7.00.0xx

Page 128 of 211

ACT
The field identifies the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

OCN
The field identifies the Old Cabin No.
NCN
The field identifies the New Cabin No.
BCC
It contain Track 2 field 1 value of the on board cabin card excluding start sentinel and end sentinel.
e.g. The value encode in track 2 is ;9910000657580701=20060810?, we will only send
9910000657580701

Example
Message

<STX>ExtCabinMove<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>ACT=P<US>OCN=0123<US>NCN=0128<US>BCC=9841000
020957311<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 129 of 211

ChangeAirConState
ChangeAirConState message type is sent by the FCUI to supply the information to the external
system to change the Air conditional status. The External System has to respond with an
Acknowledge message type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

CAB

X(6)

Cabin Number

RES_CAB

STA

X(1)

New Status

SYSTEM CALCULATED

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
CAB
The field identifies the cabin number which the air conditional status is affected.
STA
New Air Conditional Status request to be set, status could only be either 0 or 1. ( "0" = Off, "1" = On)

Example
Message

<STX>ChangeAirConState<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-11
14:10:24<US>CAB=07809<US> STA=1<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 130 of 211

ClockIn
ClockIn message type is received by the FCUI from external system about a clock in of a crew
member. FCUI has to respond with an Acknowledge message type.
Code

Type

Description

Required

REF

X(20)

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

CLK

Date and Time Clock In

TML

X(6)

Terminal ID

DES

X(50)

Terminal Description

optional

REM

X(50)

Remarks

optional

ACE

X(1)

Account ID Entry Type

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE for field
definition below
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
Refer to ACE for type
definition below

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
CLK
The field identifies the date and time when the clock in is done by the crew at the terminal.

Universal Interface Technical Specification 7.00.0xx

Page 131 of 211

TML
The field identifies the terminal ID for the terminal where the clock in is done by the crew.
DES
The field identifies the terminal description for the terminal where the clock in is done by the crew.
REM
The field identifies the additional remarks send by external system.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined: The default value is H if this field is omitted or invalid.
C
I
E
H
R
F
P

Example
Message

Card identification number (RES_BOARDCC)


Internal identification number (FCSPMS account ID) (UXP_A_ID)
External identification number (e.g. reservation number) (RES_BOOKNR)
Internal Id number (UXP_C_INTERNALID)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

<STX>ClockIn<US>REF=TIMEATTENDANCE<US>RQN=199<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>CLK=1997-09-11 14:05:44<US>TML=TER001
<US>DES=CREW DECK 5<US>REM=ENGINE DECK ON
DUTY<US>ACE=H<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 132 of 211

ClockOut
ClockOut message type is received by the FCUI from the external system about a clock out of a
crew member. FCUI has to respond with an Acknowledge message type.
Code

Type

Description

Required

REF

X(20)

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

CLK

Date and Time Clock Out

TML

X(6)

Terminal ID

DES

X(50)

Terminal Description

optional

REM

X(50)

Remarks

optional

ACE

X(1)

Account ID Entry Type

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
Refer to ACE for field
definition
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
n/a to be provided from
external system
Refer to ACE for type
definition

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
CLK
The field identifies the date and time when the clock out is done by the crew at the terminal.

Universal Interface Technical Specification 7.00.0xx

Page 133 of 211

TML
The field identifies the terminal ID for the terminal where the clock out is done by the crew.
DES
The field identifies the terminal description for the terminal where the clock out is done by the crew.
REM
The field identifies the additional remarks send by external system.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined: The default value is H if this field is omitted or invalid.
C
I
E
H
R
F
P

Example
Message

Card identification number (RES_BOARDCC)


Internal identification number (FCSPMS account ID) (UXP_A_ID)
External identification number (e.g. reservation number) (RES_BOOKNR)
Internal Id number (UXP_C_INTERNALID)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)
Pre generated Random Number (RES_PGID)

<STX>ClockOut<US>REF=TIMEATTENDANCE<US>RQN=199<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>CLK=1997-09-11 14:05:44<US>TML=TER001
<US>DES=CREW DECK 5<US>REM=ENGINE DECK OFF
DUTY<US>ACE=H<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 134 of 211

SysMsgReq
SysMsgReq message type is used to request the details of the System from the FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time

The message is usually used to display the details of the System. The following is a description of
the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.

Example
Message

<STX>SysMsgReq<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:11:12<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 135 of 211

SysMsg
SysMsg message type is sent by the FCUI to supply the details of the Fidelio system to the external
system.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

SHP

X(50)

Ships Name

SYS_SHIPSNAME

SDT

System Date

SYS_DATE

SCR

X(75)

Cruise Id & Name [IdDescription]

ITN

X(10)

Itinerary Id

SYS_CRUISE +
SCR_COMMENT
SCR_ITN_ID

CUR

X(75)

Currency Id & Description [Id


Description]

VER

X(8)

Version No. of the FCUI

SCR_CUR +
DEP_COMMENT
SYSTEM CALCULATED

CSD

Cruise Start Date

SCR_A_DATE

CED

Cruise End Date

SCR_A_DATE

The message returns the details of the System as described below. There is always ONLY one
response.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
SHP
The field identifies the name of the Ship.
SDT
The field identifies the current Fidelio Cruise system date.

Universal Interface Technical Specification 7.00.0xx

Page 136 of 211

SCR
The field identifies the current cruise id and the description.
ITN
The field identifies the current itinerary id.
CUR
The field identifies the currency id and the name of the current cruise.
VER
The field identifies the version number of the current FCUI. The format is x.yy.zzz.
CSD
Current Cruise Start Date
CED
Current Cruise End Date
X
YY
ZZZ

Example
Message

Major Version
Minor Version
ZZZ-Revision

<STX>SysMsg<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11 14:10:31<US>SHP=The
Voyager<US>SDT=1997-09-11<US>SCR=3959-Caribbean Cruise
14<US>ITN=VY0014<US>CUR=9005-US Dollars<US>VER=7.00.044<US>CSD=1997-0911<US>CED=1997-09-15<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 137 of 211

MessageLight
MessageLight message type is sent by the FCUI to inform the external system about turning on or
off the message light for a given cabin. The External System has to respond with an Acknowledge
message type.
Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

CAB

X(6)

Cabin Number

RES_CAB

NAM

X(52)

Salutation, Forename and Surname

NUMx

Phone Line Number

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
CAB_TEL/CAB_TEL2

Light State [On / Off]

SYSTEM_CALCULATED

LIT

X(3)

Description

Required

SPMS DB Field reference

Code

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).

Universal Interface Technical Specification 7.00.0xx

Page 138 of 211

CAB
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
NAM
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
NUMx
The field identifies the phone number for the light to be enabled or disabled. Small x denotes fact
that the field can be repeated within <DATA> block which means that multiple phone can be
managed for the person receiving the message.
LIT
The field identifies the status for the Message Light. The possible values are "On" or "Off".

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>MessageLight<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<US>CAB=4002<US>NAM=John
Malkovitch<US>NUM=4002<US>LIT=On<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 139 of 211

Messages
Messages message type is sent to the FCUI by the external system to request all messages for an
account. The FCUI responds with a MessageList message type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).

Example
Message

<STX>Message<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>ACI=9001201<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 140 of 211

MessageList
MessageList message type is sent by the FCUI to the external system with a list of all messages
for an account for a Messages message type.
Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

TXTx

X(52)

Message Text

MSG_TEXT

TKNx

Taken at Date and Time

MSG_TAKEN

TBYx

X(20)

Taken By

USR_LOGIN

SNDx

X(50)

Sender

MSG_SENDER

LIT

X(3)

Light State [On / Off]

MSG_LIGHTON

Delivery Date and Time

optional

DELx

Description

Required

SPMS DB Field reference

Code

MSG_DELIVERED

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
TXTx
The field identifies the message Text.

Universal Interface Technical Specification 7.00.0xx

Page 141 of 211

TKNx
The field identifies the date and the time when message was received.
TBYx
The field identifies the taken by user.
SNDx
The field identifies the message sent by.
LITx
The field identifies the status of the message light (On/Off).
DELx
The field identifies the date and the time when message was delivered.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>MessageList<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>TXT1=Please call the office<US>TKN1=2002-1206<US>TBY1=David<US>SND1=Irish<US>LIT1=Off<US>DEL1=2002-1214<US>TXT2=Please call your daughter.<US>TKN2=2002-1212<US>TBY2=Jose<US>SND2=Kelly Arison<US>LIT2=Off<US>DEL2=2002-1214<US>TXT3=PLEASE CALL THE OFFICE.<US>TKN3=2002-1212<US>TBY3=Jose<US>SND3=Irish<US>LIT3=Off<US>DEL3=2002-1214<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 142 of 211

SetPIN
SetPIN message type is sent by the external system to set the PIN code of an account in FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

CAB

X(6)

Cabin Number

RES_CAB

AKY

X(4)

Authorization Key

PIN

PIN code

Refer to PAR Value for PARInterfaces-AuthKey Criteria


RES_PIN_CODE

SetPIN message is used to set the telephone PIN code of an account in FCSPMS. The following is
a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
CAB
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.

Universal Interface Technical Specification 7.00.0xx

Page 143 of 211

PIN
The field identifies the telephone PIN code for the person(s) that satisfy the inquiry criteria. The valid
character is 0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKY
The field identifies the authorization key for the person(s) that satisfy the inquiry criteria.

Example
Message

<STX>SetPIN<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-11
14:10:32<US>ACI=98010<US>CAB=2001<US>PIN=882771<US>AKY=4883<ETX><CHECKS
UM>

Universal Interface Technical Specification 7.00.0xx

Page 144 of 211

GetPIN
GetPIN message type is sent by the external system to confirm the PIN code of an account from the
FCUI.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

GetPIN message is to get the PIN code of an account from FCSPMS for validation. The following is
a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).

Example
Message

<STX>GetPIN<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-11
14:10:32<US>ACI=20331<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 145 of 211

PINDetails
PINDetails message type is sent to the external system as response to GetPIN command.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

LST

X(30)

Last Name

UXP_A_NAME

FST

X(30)

First Name

UXP_A_FSTN

CAB

X(6)

Cabin Number

RES_CAB

AKY

X(4)

Authorization Key

PIN

PIN code

Refer to PAR Value for PARInterfaces-AuthKey Criteria


RES_PIN_CODE

PINDetails will display the pin details regarding an account inquired. The following is a description of
the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
FST
The field identifies the forename of an account (person) to satisfy inquiry criteria.

Universal Interface Technical Specification 7.00.0xx

Page 146 of 211

LST
The field identifies the surname of an account (person) to satisfy inquiry criteria.
CAB
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
PIN
The field identifies the telephone PIN code for the person(s) that satisfy the inquiry criteria. The valid
character is 0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKY
The field identifies the authorization key for the person(s) that satisfy the inquiry criteria.

Example
Message

<STX>PINDetails<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-11
14:10:32<US>ACI=20031<US>LST=Jane<US>FST=Mary<US>CAB=2001<US>AKY=2443<U
S>PIN=0878111<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 147 of 211

UpdatePIN
UpdatePIN message type is sent to the external system to update any changes on the PIN code of
an account in FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Account ID

RES_ACC

LST

X(30)

Last Name

UXP_A_NAME

FST

X(30)

First Name

UXP_A_FSTN

CAB

X(6)

Cabin Number

RES_CAB

AKY

X(4)

Authorization Key

PIN

PIN code

Refer to PAR Value for PARInterfaces-AuthKey Criteria


RES_PIN_CODE

UpdatePIN message serves as a command to update external system that PIN code changes has
been made. The following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
FST
The field identifies the forename of an account (person) to satisfy inquiry criteria.

Universal Interface Technical Specification 7.00.0xx

Page 148 of 211

LST
The field identifies the surname of an account (person) to satisfy inquiry criteria.
CAB
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
PIN
The field identifies the telephone PIN code for the person(s) that satisfy the inquiry criteria. The valid
character is 0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKY
The field identifies the the authorization key for the person(s) that satisfy the inquiry criteria.

Example
Message

<STX>UpdatePIN<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-11
14:10:32<US>ACI=20031<US>LST=Jane<US>FST=Mary<US>CAB=2001<US>AKY=2443<U
S>PIN=0878111<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 149 of 211

GetPromoMessage
GetPromoMessage message type is used to request list of promotion available from the FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Account ID

RES_ACC

The message is usually used to display list of promotion that belong to the current guest. The
following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification number. This ID can be obtained
through e.g. Inquire message. The field is an internal, unique account (person) number (I type).

Example
Message

<STX>GetPromoMessage<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>ACI=250046<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 150 of 211

GetPromoMessageResponse
GetPromoMessageResponse message type is sent by the FCUI to supply list of promotion for the
specified guest.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

PROx

Promotion ID

PRD_ID

PTYx

Promotion Type

PRO_TYPE

PNMx

X(100)

Promotion Title

PRD_NAME

PDSx

X(500)

Promotion Description

PRD_DESC

EIDx

Value depend on Promotion Type

ESE_ID

ENOx

X(10)

Value depend on Promotion Type

ESE_NO

NAMx

X(50)

Value depend on Promotion Type

ESE_NAME

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records that satisfy inquiry criteria. The response message
number one is required while all the others are optional. Record number will not be present if only
one record is returned.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.

Universal Interface Technical Specification 7.00.0xx

Page 151 of 211

DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
PROx
The field identifies the unique promotion id
PTYx
The field identifies the promotion type.
1
2
3

Excursion
Excursion Package
Micros POS

PNMx
The promotion title.
PDSx
The promotion detail description.
EIDx
The value depend on promotion type
For 1. Excursion
The field identifies the unique excursion identifier. This ID can be used for excursion booking. The
field is an internal, unique excursion number.
For 2. Excursion Package
The field identifies the unique package identifier. This ID can be used for package booking. The field
is an internal, unique excursion number.
For 3. Micros POS
This field is not used.
ENOx
The value depend on promotion type
For 1. Excursion
The field identifies the custom, users entered, number that identifies excursion.
For 2. Excursion Package
The field identifies the custom, users entered, number that identifies package.
For 3. Micros POS
This field is not used.

Universal Interface Technical Specification 7.00.0xx

Page 152 of 211

NAMx
The value depend on promotion type
For 1. Excursion
The field identifies the excursion name (description).
For 2. Excursion Package
The field identifies the package name (description).
For 3. Micros POS
This field is not used.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>GetPromoMessageResponse<US>REF=Comp1<US>RQN=125<US>DTE=1997-09-11
14:11:34<US>PID1=304<US>PTY1=1<US>PNM1=2 Days before Excursion till
Excursion<US>PDS1=112345<US>EID1=48642<US>ENO1=VADL-1<US>NAM1=Adelaide
City / Glenelg<US>PID2=304<US>PTY2=1<US>PNM2=2 Days before Excursion till
Excursion<US>PDS2=112345<US>EID2=48644<US>ENO2=VBUN-1<US>NAM2=The
Ultimate Dolphin Experience<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 153 of 211

Events
Events message type is used to request a list of events available from the FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

SDT

Event starting date

EDT

Event ending date

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
n/a to be provided from
external system
n/a to be provided from
external system

The message is usually used to display list of events that fall within date starting and ending criteria.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
SDT
The field identifies the minimum date the event can start from.
EDT
The field identifies the maximum date the event must be completed.

Example
Message

<STX>Events<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>SDT=1997-09-12 00:00:00<US>EDT=1997-09-12 23:59:59<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 154 of 211

ExtEvents
ExtEvents message type is used to request list of events available from the FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

BDT

Event Starting Date

TYP

X(1)

Code Type

optional

COD

X(50)

Code

optional

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
n/a to be provided from
external system
Refer to TYP type definition
below
Refer to COD field definition
below

The message is usually used to display list of events that fall within date starting or ending criteria.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
BDT
The field identifies the date for the event can start from.
TYP
The field identifies the type of the code being passed for querying events.
L
N
I

Event Location Name


Event No (ENO)
Event Unique ID (EID)

Universal Interface Technical Specification 7.00.0xx

Page 155 of 211

COD
The code for the Events to run the query on. It can be either the location code (LOC_TITLE), The
Event No (ENO) (TKBE_CODE), the Unique Id (EID) (TKBE_ID).

<STX>ExtEvents<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12 00:00:00<US>TYP=L<US>COD=Cinema<ETX><CHECKSUM>

Example
Message

<STX>ExtEvents<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12
00:00:00<US>TYP=N<US>COD=HAM0012<ETX><CHECKSUM>
<STX>ExtEvents<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>BDT=1997-09-12
00:00:00<US>TYP=I<US>COD=73928740<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 156 of 211

EventsResponse
EventsResponse message type is sent by the FCUI to supply list of events that fall within starting
and ending date or time specified by external system.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

EIDx

Event ID

TKBE_ID

ENOx

X(20)

Event Number

TKBE_CODE

NAMx

X(50)

Event Name

TKBE_NAME

SDTx

Starting Date and Time

EDTx

Ending Date and Time

LDTx

Last Call Time

optional

TKBE_DATE +
TKBE_FROMTIME
TKBE_DATE +
TKBE_TOTIME
TKBE_LASTCALL_TIME

STAx

X(1)

Booking Status

SYSTEM CALCULATED

PCTx

X(6)

Price Category Code

TKPB_PRICE_CATEGORY

PCNx

X(50)

Price Category Description

TYP_TKP.TYP_COMMENT

PGTx

X(6)

Person Group Code

TKPB_PERSON_GROUP

PGNx

X(50)

Person Group Description

TYP_TKG.TYP_COMMENT

PCAx

9.9

Price

SYSTEM_CALCULATED

INFx

X(200)

Event Description

TKBE_DESCRIPTION

SIKx

X(3)

TKBE_SHOW_KIOSK

BIKx

X(3)

Show in Kiosk [External Booking


System]
Book in Kiosk [External Booking
System]

TKBE_SELL_KIOSK

MAXx

Maximum Seats

TKBE_MAXPER

CURx

Seats Currently Booked

SYSTEM CALCULATED

LOCx

X(50)

Location Name

LOC_TITLE

SITx

X(3)

Show in ITV [External Booking


System]

TKBE_SHOW_ITV

BITx

X(3)

Book in ITV [External Booking System]

TKBE_SELL_ITV

DSCx

X(1000)

Event Long Description

TKBE_LONG_COMMENT

OTLx

X(3)

1 Ticket per Person limit is enabled or


not

TKBE_ONE_TICKET_LIMIT

Universal Interface Technical Specification 7.00.0xx

Required

SPMS DB Field reference

Code

Page 157 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records that satisfy inquiry criteria. The response message
number one is required while all the others are optional. Record number will not be present if only
one record is returned.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
EIDx
The field identifies the unique event identifier. This ID can be used for event booking. The field is an
internal, unique event number.
ENOx
The field identifies the custom, users entered, number that identifies event.
NAMx
The field identifies the event name (description).
SDTx
The field identifies the event starting date and time.
EDTx
The field identifies the event ending date and time.
LDTx
The field identifies the last call time, please ignore the date part.
STAx
The field identifies the event booking status. The following status identifiers values are defined:
A
F
O

Available
Fully booked
Overbooked

Universal Interface Technical Specification 7.00.0xx

Page 158 of 211

PCTx
The field identifies the event price category code, this field is required during booking.
E.g.

Gold (Gold Class)


Silver (Silver Class)

PCNx
The field identifies the event price category description.
PGTx
The field identifies the person group code, this field is required during booking.
e.g.

Adult
Child
Senior

PGNx
The field identifies the person group description.
PCAx
The field identifies the event selling price.
INFx
The field identifies the additional information about event.
SIKx
The flag to denote if the event can be shown on the external system, the field returns Yes or No
only.
BIKx
The flag to denote if the event can be booked on the external system, the field returns Yes or No
only.
MAXx
Total seats available on the event.
Note: For the same event id the same seat could be sold at different price depend on the price
category and person group. So the total seats appear on different price category and person group
will be representing the same seats.
e.g. The below mean the event 1 only have 50 seats available, for the same EID will always have
the same MAX value.
EID
1
1
1
1

PCT
Gold
Silver
Gold
Silver

PGT
Adult
Adult
Child
Child

MAX
50
50
50
50

CURx
This is the total seats booked on the evens.

Universal Interface Technical Specification 7.00.0xx

Page 159 of 211

LOCx
The field identifies the location name of the event.
SITx
The flag to denote if the event can be shown on ITV the external system, the field returns Yes or
No only.
BITx
The flag to denote if the event can be booked on the ITV external system, the field returns Yes or
No only.
DSCx
Event long Description intended for ITV usage.
OTLx
The flag to denote if Event has the 1 Ticket per Person limit enabled or not, the field returns Yes or
No only.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX> EventsResponse <US>REF=Comp1<US>RQN=125<US>DTE=1997-09-11


14:11:34<US>EID1=1<US>ENO1=TEST<US>NAM1=Test<US>SDT1=2009-04-06
00:00:01<US>EDT1=2009-04-07
00:00:00<US>STA1=F<US>PCT1=TEST<US>PCN1=Test<US>PGT1=TEST<US>PGN1=Test<
US>PCA1=10<US>INF1=Test<US>SIK1=Yes<US>BIK1=Yes<US>MAX1=0<US>CUR1=0<US
>LOC1=Test<US>SIT1=Yes<US>BIT1=Yes<US>DSC1=Test<US>OTL1=Yes<US>EID2=2<US
>ENO2=TEST<US>NAM2=Test<US>SDT2=2008-11-28 00:00:01<US>EDT2=2008-11-29
00:00:00<US>STA2=O<US>PCT2=TEST<US>PCN2=Test<US>PGT2=TEST<US>PGN2=Test
<US>PCA2=11<US>INF2=Test<US>SIK2=Yes<US>BIK2=Yes<US>MAX2=0<US>CUR2=3<U
S>LOC2=Test<US>SIT2=Yes<US>BIT2=Yes<US>DSC2=Test<US>OTL2=Yes<ETX><CHECK
SUM>

Universal Interface Technical Specification 7.00.0xx

Page 160 of 211

EventBooking
EventBooking message type is sent to the FCUI to insert event booking and post event charge.
Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

ACI

X(52)

Account ID

ACE

X(1)

Account ID Entry Type

ACS

X(1)

Account Status

BOI

X(30)

Unique Event Booking ID

EIDx

Event ID

Refer to ACE field definition


below
Refer to ACE type definition
below
RES_STATUS translated to
R/C
n/a to be provided from
external system
TKBE_ID

PCTx

X(6)

Price Category Code

TKPB_PRICE_CATEGORY

PGTx

X(6)

Person Group Code

TKPB_PERSON_GROUP

QTYx

Quantity

INF

X(50)

PIN

SRC

X(100)

FLG

Description

Required

SPMS DB Field reference

Code

Notes

optional

PIN Code

optional

Booking Source

optional

Y-Allow posting even the guest has


reached his credit limit or posting is
disable, N-Normal posting

optional

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

n/a to be provided from


external system
n/a to be provided from
external system
RES_PIN_CODE
n/a to be provided from
external system
n/a to be provided from
external system

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one or more events within one booking transaction. This way FCSPMS
can assign the whole booking as one transaction that can be traced and voided later on. Record
number cannot be used if only one record is send.

Universal Interface Technical Specification 7.00.0xx

Page 161 of 211

REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Entered by the external system operator (manually or through a magnetic card reader) and
generally contains any information necessary to identify account. The field can be account number,
card number, cabin number or person name.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined:
C
A
N
I
G
E
T
M
H
X
R
F

Pre generated Random Number (RES_PGID)

Card identification number (RES_BOARDCC)


Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)
Name of a person or company account (UXP_A_NAME_N)
Internal identification number (UXP_A_ID)
Group Id number (RES_GRP)
External identification number (RES_BOOKNR)
Phone trunk number (CAB_TEL or CAB_TEL2)
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)
Internal Id number (UXP_C_INTERNALID)
Guest Category (GCT_CODE)
RFID UID (RFID_ID)
Loyalty Number (UXP_A_FRQ_CARDNO)

ACS
The field identifies the account current reservation status. The following status values are accepted:
R
C

Reservations
Checked-in

BOI
The field identifies the booking (check) unique within the whole external system. The field is used as
a cross-reference to obtain detailed information about all the transactions recorded on a booking.
EIDx
The field identifies the unique event identification number. The ID + Price Category + Person Group
cannot repeat within one message. This ID can be obtained through e.g. Events message. The field
is an internal, unique event number.
Universal Interface Technical Specification 7.00.0xx

Page 162 of 211

PCTx
The field identifies the Price Category. The ID + Price Category + Person Group cannot repeat
within one message. This Price Category can be obtained through e.g. Events message. The field is
an internal, unique event number.
PGTx
The field identifies the Person Group. The ID + Price Category + Person Group cannot repeat within
one message. This Person Group can be obtained through e.g. Events message. The field is an
internal, unique event number.
QTYx
The field identifies the number of tickets to book.
INF
The field identifies the additional information send by FCUI.
PIN
The field identifies the telephone PIN code of the reservation account. The valid character is
0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
SRC
The field identifies the source of the booking. Eg: Workstation Id, Kiosk Id, etc. or any other details
describing the location where the booking was made.
FLG
Y-Allow posting even the guest has reached his credit limit or posting is disabled (This only apply to
check-in guest only), N-Normal posting
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

<STX>EventBooking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=0123<US>ACE=A<US>ACS=C<US>BOI=Booking: A23
<US>EID=13<US>PCT=Gold<US>PGT=Adult<US>QTY=1<US>INF=VIP
Tickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<ETX><CHECKSUM>
Example
Message

<STX>EventBooking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=0123<US>ACE=A<US>ACS=C<US>BOI=Booking: A23
<US>EID1=13<US>PCT1=Gold<US>PGT1=Adult<US>QTY1=1<US>EID2=14<US>PCT2=Silve
rUS>PGT2=Adult<US>QTY2=1<US>INF=VIP Tickets<US>PIN=12345<US>SRC=Shorex Kiosk
12<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 163 of 211

EventBookingResponse
EventBookingResponse message type is sent by the FCUI to confirm posting made.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACIx

X(52)

Account ID

RES_ACC

ACTx

X(1)

Account Type

RES_TAG

NAMx

X(52)

Salutation, Forename and Surname

CABx

X(6)

Cabin Number

EMBx

Embarkation Date

DISx

Disembarkation Date

RES_EMB_E for expected


accounts, RES_EMB_A for
checked in accounts
RES_DIS_E

BALx

9.9

Balance

SYSTEM CALCULATED

CRUx

9.9

Posted Cruise ID

optional

optional

UXP_A_SALUT,
UXP_A_FSTN,
UXP_A_NAME
RES_CAB

POS_CRUISE

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

EventBookingResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. If one record is returned it serves as a confirmation that
the booking has been made. Final balance after the event posting is applied will be send. No
booking is inserted if more than one record is returned. In this case current balance is returned.
External system should send Booking message identifying one account that the event booking
should apply to.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.

Universal Interface Technical Specification 7.00.0xx

Page 164 of 211

RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACIx
The field identifies the unique account (person) identification. This ID is used for the final booking.
The field is an internal, unique account (person) number (I type).
ACTx
The field describes the account type. The following account types are defined:
P
R
C
G
V
A
S
Z

Passenger (Guest)
Resident (Guest)
Crew member
Group
Visitor
System account
Staff
Gift Card

NAMx
The field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and time the account (person) is expected or embarked.
DISx
The field identifies the date and time the account (person) is expected to disembark.
BALx
The field identifies the balance after the payment is applied if one account was found. Otherwise
returns current balance. This field can return positive (account is to be invoiced) or negative
(account prepaid) value.
CRUx
The field identifies the posted cruise id if posting is applied when one account was found. Otherwise
returns zero.

Universal Interface Technical Specification 7.00.0xx

Page 165 of 211

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>EventBookingResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-11
14:10:49<US>ACI1= 9001201<US>ACT1=P<US>NAM1=John Malkovitch
<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-09-12
<US>BAL1=123.45<US>CRU1=0<US>ACI2=9001202<US>ACT2=P<US>NAM2=Jane
Malkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-0913<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>EventBookingResponse<US>REF=TV#1<US>RQN= 1218<US>DTE=1997-091114:10:59<US>ACI=9001201<US>ACT=P<US>NAM=John
Malkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12
<US>BAL=145.79<US>CRU=12345<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 166 of 211

EventFolio
EventFolio message type is used to request list of events booked on a specific account in
FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

X(52)

Account ID

RES_ACC

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification number. This ID can be obtained
through e.g. Inquire message. The field is an internal, unique account (person) number (I type).

Example
Message

<STX>EventFolio<US>REF=TV#1<US>RQN=1209<US>DTE=1997-09-11
14:10:23<US>ACI=9001201<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 167 of 211

EventFolioResponse
EventFolioResponse message type is sent by the FCUI to supply the list of events currently
booked for the account specified by an external system. The message returns the same list of
events that are visible through FCSPMS system.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

EIDx

Event ID

TKBE_ID

ENOx

X(10)

Event Number

TKBE_CODE

NAMx

X(50)

Event Name

TKBE_NAME

SDTx

Starting Date and Time

EDTx

Ending Date and Time

STAx

X(1)

Event Status

TKBE_DATE +
TKBE_FROMTIME
TKBE_DATE +
TKBE_TOTIME
SYSTEM CALCULATED

BDTx

Booking Date and Time

TKPO_SDAT

PCTx

X(6)

Price Category Code

TKPB_PRICE_CATEGORY

PCNx

X(50)

Price Category Description

TYP_TKP.TYP_COMMENT

PGTx

X(6)

Person Group Code

TKPB_PERSON_GROUP

PGNx

X(50)

Person Group Description

TYP_TKG.TYP_COMMENT

LOCx

X(50)

Location Name

LOC_TITLE

QTYx

Number of Tickets Booked

SYSTEM CALCULATED

BOVx

9.9

Booking Value

SYSTEM CALCULATED

INFx

X(200)

PRNx

PPEx

X(3)

Notes

Required

SPMS DB Field reference

Code

optional

TKPO_COMMENT

Ticket Printed Count

TKPO_TICKET_PRINTED

Prepaid Status flag

TKPO_PREPAID

The message can return one or more records of the data to satisfy inquiry criteria. The response
message number one is required while all the others are optional. Record number will not be
present if only one record is returned. The following is a description of the fields in the message
data block.

Universal Interface Technical Specification 7.00.0xx

Page 168 of 211

REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
EIDx
The field identifies the unique event identifier. This ID can be used to link the event with items
retrieved through events message. The field is an internal, unique event number.
ENOx
The field identifies the custom, users entered, number that identifies event.
NAMx
The field identifies the event name (description).
SDTx
The field identifies the event starting date and time.
EDTx
The field identifies the event ending date and time.
STAx
The field identifies the event booking status. The following status identifiers values are defined:
A
F
O

Available
Fully Booked
Overbooked

BDTx
The field identifies the event booking date and time (real date and time).
PCTx
The field identifies the event price category code, this field is required during booking.
E.g.

Gold (Gold Class)


Silver (Silver Class)

PCNx
The field identifies the event price category description.

Universal Interface Technical Specification 7.00.0xx

Page 169 of 211

PGTx
The field identifies the person group code, this field is required during booking.
e.g.

Adult
Child
Senior

PGNx
The field identifies the person group description.
LOCx
The field identifies the location name of the event.
QTYx
The field identifies the number of tickets booked.
BOVx
The field identifies the total value of the bookings for the returned events.
INFx
The field identifies the additional information about event.
PRNx
The field identifies how many times the tickets had been printed.
PPEx
The flag to denote if Booking is Prepaid or not, the field returns Yes or No only.

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>EventFolioResponse<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:11:12<US>EID1=12<US>ENO1=2<US>NAM1=Dining with crocodiles<US>SDT1=1997-0912 17:30:00<US>EDT1=1997-09-12 20:30:00<US>STA1=A<US>BDT1=1997-09-13
12:34:21<US> PCT1=TEST<US>PCN1=Test<US>PGT1=TEST<US>PGN1=Test<US>
LOC1=Ciname<US>QTY1=1<US>BOV1=12.10<US> INF1=Keep warm<US>
PCN1=1<US>PPE1=No <US>EID2=12<US>ENO2=2<US>NAM2=Dining with
crocodiles<US>SDT2=1997-09-12 17:30:00<US>EDT2=1997-09-12
20:30:00<US>STA2=A<US>BDT2=1997-09-13 12:34:21<US>
PCT2=TEST<US>PCN2=Test<US>PGT2=TEST<US>PGN2=Test<US>
LOC2=Ciname<US>QTY2=1<US>BOV2=12.10<US> INF2=Keep
warm<USPCN2=1<US>PPE2=Yes <ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 170 of 211

UDFRead
UDFRead message type is sent to the FCUI to read the user define type of a passenger.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Unique Account ID

RES_ACC

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one guest at a time only. Record number cannot be used if only one
record is send.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Unique Account ID (Internal identification number (FCSPMS account ID)).

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>UDFRead<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=2089734<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 171 of 211

UDFReadResponse
UDFReadResponse message type is sent by the FCUI to retrieve the user define field
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Account ID

RES_ACC

UIDx

User Define Type ID

UDF_ID

UVLx

X(100)

User Define Type Value

UDD_VALUE

UNMx

X(50)

User Define Type Field Name

UDF_NAME

ULBx

X(30)

User Define Type Display Caption

UDF_LABEL

URMx

X(200)

User Define Type Remarks

UDF_REMARKS

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

UDFReadResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. The following is a description of the fields in the message
data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.

Universal Interface Technical Specification 7.00.0xx

Page 172 of 211

RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification..
UIXx
The field describes the unique ID for the user defined type. This field is require when call
UDFUpdate.
UVLx
The field identifies the value user enter for this user defined type.
UMNx
The field name identifies the user defined type.
ULBx
The field identifies caption display on SPMS Application for this user defined type.
URMx
The field identifies the remarks for the user defined type. This field is not visible to the end user.
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>UDFReadResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-11
14:10:49<US>ACI= 2089734<US>UID1=1<US>UVL1=Test <US>UMN1=Field
1<US>ULB1=Field 1<US>URM1=Testing User Defined Field 1<US>UID2=2<US>UVL2=Test
2<US>UMN2=Field 2<US>ULB2=Field 2<US>URM2=Testing User Defined Field
2<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 173 of 211

UDFUpdate
UDFUpdate message type is sent to the FCUI to update the user define type of a passenger.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Unique Account ID

RES_ACC

UIDx

User Define Type ID

UDF_ID

UVLx

X(100)

User Define Type Value

n/a to be provided from


external system

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can accept one guest at a time only. Record number cannot be used if only one
record is send.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Unique Account ID (Internal identification number (FCSPMS account ID)).
UIXx
The field describes the unique ID for the user defined type. This field is return from the UDFRead.

Universal Interface Technical Specification 7.00.0xx

Page 174 of 211

UVLx
The field identifies the value user enter for this user defined type.

Example
Message

<STX>UDFUpdate<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=2089734<US>UID=1<US>UVL=Test 1<ETX><CHECKSUM>
<STX>UDFUpdate<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-11
14:10:45<US>ACI=2089734<US>UID1=1<US>UVL1=Test 1<US>UID2=1<US>UVL2=Testing
1<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 175 of 211

UDFUpdateResponse
UDFUpdateResponse message type is sent by the FCUI to acknowledge the successfully of
updating user define fields.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Account ID

RES_ACC

UDFUpdateResponse message can return one or more records that satisfy inquiry criteria. The
response message number one is required while all the others are optional. Record number will not
be present if only one record is returned. The following is a description of the fields in the message
data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
The field identifies the unique account (person) identification.

Example
Message

<STX>UDFUpdateResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-11
14:10:49<US>ACI= 2089734<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 176 of 211

GetCruiseItinerary
GetCruiseItinerary message type is used to request list of cruise port information from the
FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

SDT

Cruise starting date

EDT

Cruise ending date

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
n/a to be provided from
external system
n/a to be provided from
external system

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
SDT
The field identifies the start date of the cruise. Date only, no time.
EDT
The field identifies the end date of the cruise. Date only, no time.

Example
Message

<STX>GetCruiseItinerary<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>SDT=2011-01-01<US>EDT=2011-01-02<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 177 of 211

GetCruiseItineraryResponse
GetCruiseItineraryResponse message type is sent by the FCUI to supply list of cruise information
for the specified date.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

CIDx

Cruise Itinerary ID

SCD_ID

DCTx

X(2)

Departure Country ISO Code

SCD_A_COUNTRY

DPTx

X(6)

Departure Port

SCD_PORT_ID

DDTx

Date

Departure Date

SCD_DATE

DTMx

X(4)

Departure Time in HHMM

SCD_DEPART_TIME

ACTx

X(2)

Arrival Country ISO Code

SCD_A_COUNTRY

APTx

X(6)

Arrival Port

SCD_PORT_ID

ADTx

Date

Arrival Date

SCD_DATE

ATMx

X(4)

Arrival Time in HHMM

SCD_ARRIVE_TIME

APNx

X(250)

Arrival Port Name

TYP_HRB.TYP_COMMENT

DPNx

X(25)

Departure Port Name

TYP_HRB.TYP_COMMENT

SCRx

Cruise ID

SCR_ID

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records that satisfy inquiry criteria. The response message
number one is required while all the others are optional. Record number will not be present if only
one record is returned.
The following is a description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.

Universal Interface Technical Specification 7.00.0xx

Page 178 of 211

RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
CIDx
The field identifies the unique cruise itinerary ID
DCTx
The field identifies departure country ISO Code as setup in FC Administrator.
DPTx
The field identifies departure port as setup in FC Administrator.
DDTx
The field identifies departure date.
DTMx
The field identifies departure time.
ACTx
The field identifies arrival country ISO Code as setup in FC Administrator.
ADPx
The field identifies arrival port as setup in FC Administrator.
ADTx
The field identifies arrival date.
ATMx
The field identifies arrival time.
ADNx
The field identifies arrival port name as setup in FC Administrator.
DPNx
The field identifies departure port name as setup in FC Administrator.
SCRx
The field identifies the cruise ID (scr_id)
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>GetCruiseItineraryResponse<US>REF=Comp1<US>RQN=125<US>DTE=1997-09-11
14:11:34<US>CID1=304<US>DCT1= MY<US>DPT1=PKL<US>DDT1=2011-0101<US>DTM1=2300<US>ACT1=MY<US>APT1=PKL<US>ADT1=2011-0101<US>ATM1=0900<US>CID2=305<US>DCT2= TH <US>DPT2= HKT <US>DDT1=2011-0104<US>DTM2=0900<US>ACT2= TH<US>APT2=HKT<US>ADT2=2011-0103<US>ATM2=1300<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 179 of 211

SystemDateChange
SystemDateChange message type is sent by the FCUI to inform the external system that Fidelio
have change the system date. The External System has to respond with an Acknowledge message
type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

SDT

Current Fidelio System Date

ASYS.SYS_DATE

EOC

Y=Today is End Of Cruise

Compare the current system


date with scr_a_date of next
cruise

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
SDT
The field identifies the new Fidelio system date.
EOC
Compare the current system date with scr_a_date of next cruise, if same return Y else return N

Example
Message

<STX>SystemDateChange<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>SDT=2011-02-02 <US>EOC=N<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 180 of 211

SystemCruiseChange
SystemCruiseChange message type is sent by the FCUI to inform the external system that Fidelio
have change the system cruise. The External System has to respond with an Acknowledge
message type.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

CID

Cruise Itinerary ID

SCR_ID

ITN

Cruise Itinerary Id

SCR_ITN_ID

SCR

Cruise Comment

SCR_COMMENT

SDT

Cruise Start Date

SCR_A_DATE

EDT

Cruise End Date

SCR_A_DATE (of next


cruise)

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
CID
The field identifies the unique cruise itinerary ID
ITN
The field identifies the current itinerary id.

Universal Interface Technical Specification 7.00.0xx

Page 181 of 211

SCR
The field identifies the current cruise description.
SDT
Current cruise start date
EDT
Current cruise end date = next cruise start date
Example
Message

<STX>SystemCruiseChange<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-11
14:10:24<US>CID=1234 <US> ITN=3334 <US> SCR=09/02/2012 CRUISE<ETX>
<CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 182 of 211

GetExchangeRate
GetExchangeRate message type is used to request the current active exchange from the
FCSPMS.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time

The following is a description of the fields in the message data block.


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.

Example
Message

<STX>GetExchangeRate<US>REF=FCUI#1<US>RQN=121<US>DTE=2007-10-03
14:10:32<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 183 of 211

GetExchangeRateResponse
GetExchangeRateResponse message type is sent by the FCUI to supply the information in
response to an inquiry request from an external system. The message returns current active
exchange rate configure in FC SPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

CURx

X(3)

Currency Code

DEP_CUR

CUNx

X(50)

Currency Name

DEP_COMMENT

CUBx

9.9

Normal Buy Rate

CUR_BUY

CUSx

9.9.

Normal Sell Rate

CUR_SELL

CCBx

9.9

Crew Buy Rate

CUR_CREW_BUY

CCSx

9.9

Crew Sell Rate

CUR_CREW_SELL

NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

The message can return one or more records of the data to satisfy inquiry criteria. The response
message number one is required while all the others are optional. Record number will not be
present if only one record is returned.
The following is a description of the fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
CURx
The field identifies the currency code.
Universal Interface Technical Specification 7.00.0xx

Page 184 of 211

CUNx
The field identifies the currency description.
CUBx
This field identified buy rate for guest.
CUSx
This field identified sell rate for guest.
CCBx
This field identified buy rate for crew.
CCSx
This field identified sell rate for crew.
Note: Exchange Rate
All exchange rates are bases on board currency again the foreign current.
e.g. If on board currency is USD and foreign currency is EURO and assume 1 EURO = 1.3 USD
then the exchange will be 0.7692
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>GetExchangeRateResponse<US>REF=POS#1<US>RQN=121<US>DTE=2007-10-03
14:10:32<US>CUR1=USD<US>CUN1=US
Dollar<US>CUB1=1.235<US>CUS1=1.23<US>CCB1=1.23<US>CUS1=1.23<US>
CUR2=AUD<US>CUN2=Australia
Dollar<US>CUB2=1.135<US>CUS2=1.13<US>CCB2=1.13<US>CUS2=1.13<ETX><CHECKS
UM>

Universal Interface Technical Specification 7.00.0xx

Page 185 of 211

GetPicture
GetPicture message type is used to request guest picture from the FCSPMS.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Unique Account ID return from


InquireResponse

optional

RES_ACC

MOD

Last modified date of the picture

optional

SEC_MODDATE

The message is used to return the picture belong to the current guest. The following is a description
of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Unique Account ID return from InquireResponse
MOD
Last modify date of the picture
Note: We need to pass in either ACI or MOD, if both field is ignore, we will return all picture
Example
Message

<STX>GetPicture<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>ACI=13273495<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 186 of 211

GetPictureResponse
GetPictureResponse message type is sent by the FCUI to supply the picture for the specified
guest.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACIx

Unique Account ID

RES_ACC

CABx

X(6)

Cabin Number

RES_CAB

FSTx

X(30)

First Name

UXP_A_FSTN

LSTx

X(30)

Last Name

UXP_A_NAME

BIDx

X(100)

Booking ID

RES_BOOKNR

CSDx

Current Cruise Start Date

scr_a_date of current cruise

BCCx

X(20)

On board Cabin Card

RES_BOARDCC

SEQx

Sequence Number

RES_CAB_SEQ

PICx

Picture in Base64 string, unlimited


length

SEC_IMAGE

PGIx

X(8)

Pregenerated Random ID

RES_PGID

SCIx

X(15)

Cruise external system identifier

SCR_ITN_ID

REZx

X(40)

External reservation ID

RES_REFERENZ

SIDx

X(15)

Shore ID

RES_SHOREID

ACTx

X(1)

Account Type

RES_TAG

ECDx

X(20)

External Crew ID

UXP_C_EXTERNALID

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.

Universal Interface Technical Specification 7.00.0xx

Page 187 of 211

DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACIx
The field identifies the unique account ID
CABx
The field identifies the cabin number that the account (person) occupies. If the account number is
returned (not a person) cabin number field is omitted.

FSTx
The field identifies the forename of an account (person).
LSTx
The field identifies the surname of an account (person).
BIDx
The field identifies the booking id.
CSDx
Current cruise start date.
BCCx
It contain Track 2 field 1 value of the on board cabin card excluding start sentinel and end sentinel.
e.g. The value encode in track 2 is ;9910000657580701=20060810?, we will only send
9910000657580701
SEQx
This sequence number is populate via DGS from the reservation system
PICx
The picture string in Base64 encoding.
PGIx
Pregenerated Random Number
SCIx
Cruise external system identifier
REZx
External reservation ID
SIDx
The field identifies the shore id.
ACTx
The field identifies the account type. The following account types are defined:
P
R
C

Passenger (Guest)
Resident (Guest)
Crew member

Universal Interface Technical Specification 7.00.0xx

Page 188 of 211

G
V
S

Group
Visitor
Staff

ECDx
External Crew ID
VB.NET sample code
Convert.FromBase64String(sString as String)

Below is a sample code in VB6 to decode the message


Public Function Decode64(sString As String) As String
Dim bOut() As Byte, bIn() As Byte, bTrans(255) As Byte, lPowers6(63) As Long, lPowers12(63) As Long
Dim lPowers18(63) As Long, lQuad As Long, iPad As Integer, lChar As Long, lPos As Long, sOut As String
Dim lTemp As Long
sString = Replace(sString, vbCr, vbNullString)
sString = Replace(sString, vbLf, vbNullString)

'Get rid of the vbCrLfs. These could be in...


'either order.

lTemp = Len(sString) Mod 4


'Test for valid input.
If lTemp Then
Call Err.Raise(vbObjectError, "MyDecode", "Input string is not valid Base64.")
End If
If InStrRev(sString, "==") Then
iPad = 2
ElseIf InStrRev(sString, "=") Then
iPad = 1
End If

'InStrRev is faster when you know it's at the end.


'Note: These translate to 0, so you can leave them...
'in the string and just resize the output.

For lTemp = 0 To 255


Select Case lTemp
Case 65 To 90
bTrans(lTemp) = lTemp - 65
Case 97 To 122
bTrans(lTemp) = lTemp - 71
Case 48 To 57
bTrans(lTemp) = lTemp + 4
Case 43
bTrans(lTemp) = 62
Case 47
bTrans(lTemp) = 63
End Select
Next lTemp

'Fill the translation table.

'A - Z
'a - z
'1 - 0
'Chr(43) = "+"
'Chr(47) = "/"

For lTemp = 0 To 63
'Fill the 2^6, 2^12, and 2^18 lookup tables.
lPowers6(lTemp) = lTemp * cl2Exp6
lPowers12(lTemp) = lTemp * cl2Exp12
lPowers18(lTemp) = lTemp * cl2Exp18
Next lTemp
bIn = StrConv(sString, vbFromUnicode)
ReDim bOut((((UBound(bIn) + 1) \ 4) * 3) - 1)

'Load the input byte array.


'Prepare the output buffer.

For lChar = 0 To UBound(bIn) Step 4


lQuad = lPowers18(bTrans(bIn(lChar))) + lPowers12(bTrans(bIn(lChar + 1))) + _
lPowers6(bTrans(bIn(lChar + 2))) + bTrans(bIn(lChar + 3))
'Rebuild the bits.
lTemp = lQuad And clHighMask
'Mask for the first byte
Universal Interface Technical Specification 7.00.0xx

Page 189 of 211

bOut(lPos) = lTemp \ cl2Exp16


lTemp = lQuad And clMidMask
bOut(lPos + 1) = lTemp \ cl2Exp8
bOut(lPos + 2) = lQuad And clLowMask
lPos = lPos + 3
Next lChar

'Shift it down
'Mask for the second byte
'Shift it down
'Mask for the third byte

sOut = StrConv(bOut, vbUnicode)


'Convert back to a string.
If iPad Then sOut = Left$(sOut, Len(sOut) - iPad) 'Chop off any extra bytes.
Decode64 = sOut
End Function
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.

Example
Message

<STX>GetPictureResponse<US>REF=Comp1<US>RQN=125<US>DTE=1997-09-11
14:11:34<US>ACI=13273495<US>CAB=06002<US>FST=TEST<US>LST=MA<US>BID=
<US>CSD=2013-01-24 00:00:00<US>BCC=9841000193535004<US>SEQ=<US>PIC=<BASE64 Encoded Content><ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 190 of 211

PictureChange
PictureChange message type is sent by the FCUI to inform the external system about the update
of the guest picture. The External System has to respond with an Acknowledge message type.

The message detail is identical to GetPictureResponse

Universal Interface Technical Specification 7.00.0xx

Page 191 of 211

UpdateEMail
UpdateEMail message type is sent by the external system to set/update the onboard email of an
account in FCSPMS.
Description

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

Current date and time

ACI

Unique Account ID return from


InquireResponse

RES_ACC

EML

X(72)

E-Mail Address

RES_EMAIL_SHIP

QBP

Optional

RES_NOBATCH_INVOICE

ACE

X(1)

Refer to ACE type definition


below

Quick Billing Printing Flag


Account ID Entry Type

Required

SPMS DB Field reference

Code

n/a to be provided from


external system
n/a to be provided from
external system

The message is used to update the email address belong to the current guest. The following is a
description of the fields in the message data block.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Unique Account ID return from InquireResponse
EML
eMail address, accept blank and it will remove the e-mail address.
QBPx
Quick Billing Printing Flag, 1 Print Invoice, 0 Do no print invoice in the Quick Billing Screen,
blank will skip update this field.
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined: Default = I is no value pass int
C

Card identification number (RES_BOARDCC)

Universal Interface Technical Specification 7.00.0xx

Page 192 of 211

I
P

Example
Message

Internal identification number (UXP_A_ID)


Pre generated Random Number (RES_PGID)

<STX>UpdateEMail<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>ACI=13273495<US>EML=lwteng@fcruise.com<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 193 of 211

RunReport
RunReport is to run a crystal report and export it to PDF file.
Description

SPMS DB Field reference

Code

Type

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

ACI

Unique Account ID return from


InquireResponse

RES_ACC

REP

Report ID

REP_ID

SE1

Selecting String 1

optional

SE2

Selecting String 2

optional

SE3

Selecting String 3

optional

SE4

Selecting String 4

optional

ACE

X(1)

Account ID Entry Type

optional

Crystal Report Selection


Formula variable
Crystal Report Selection
Formula variable
Crystal Report Selection
Formula variable
Crystal Report Selection
Formula variable
Refer to ACE type definition
below

The message is used to return the Exported PDF file, it is the customer responsibility to not run a
lengthy report.
REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
ACI
Unique Account ID return from InquireResponse, the crystal report formulation field =
SACCOUNTID
REP
Crystal Report report id, the report must be create and exists in SPMS first
SE1
Crystal report selection formula variable field = SSELSTRING, it can be any value depend on the
configure in the report setup
Universal Interface Technical Specification 7.00.0xx

Page 194 of 211

SE2
Crystal report selection formula variable field = SSELSTRING2, it can be any value depend on the
configure in the report setup
SE3
Crystal report selection formula variable field = SSELSTRING3, it can be any value depend on the
configure in the report setup
SE4
Crystal report selection formula variable field = SSELSTRING4, it can be any value depend on the
configure in the report setup
ACE
The field identifies the type of entry in the Account ID field. The following Account ID Entry Types
are defined: Default = I is no value pass int
C
I
P
Example
Message

Card identification number (RES_BOARDCC)


Internal identification number (UXP_A_ID)
Pre generated Random Number (RES_PGID)
<STX>RunReport<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>ACI=13273495<US>REP= PaxAutoBill1<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 195 of 211

RunReportResponse
RunReportResponse message type is sent by the FCUI to supply the exported PDF file for the
specific report.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

PDF

PDF File content in Base64 string,


unlimited length

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
PDF
This is the PDF file content in base64 encoded string. Please refer to GetPictureResponse how to
decode the string.

Universal Interface Technical Specification 7.00.0xx

Page 196 of 211

PhoneStart
PhoneStart message type is sent by the FCUI to inform the external system that Fidelio had start
the batch phone check-in process. The External System has to respond with an Acknowledge
message type.
Code

Type

Description

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

Universal Interface Technical Specification 7.00.0xx

Required

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time

Page 197 of 211

PhoneEnd
PhoneEnd message type is sent by the FCUI to inform the external system that Fidelio had start
the batch phone check-in process. The External System has to respond with an Acknowledge
message type.
Code

Type

Description

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

Universal Interface Technical Specification 7.00.0xx

Required

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time

Page 198 of 211

ChangeCabin
ChangeCabin message type is sent to FCUI to request cabin change.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

CAB

X(20)

Cabin Number

res_cab

ACI

Unique Account ID

res_acc

REA

X(100)

Reason to change the cabin

clg_reason

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
CAB
This is cabin number you want to assign the guest/crew to.
ACI
Unique Account ID
Note:
For crew we will not check for cabin availability, for guest we will make sure the cabin is not
overbook.

Universal Interface Technical Specification 7.00.0xx

Page 199 of 211

ChangeCabinResponse
ChangeCabinResponse message type is sent by FCUI to indicate cabin change is successful.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time

The following is a description of the fields in the message data block.


REF
The field identifies the message source or the destination. Identifier must be unique within the whole
system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the message
computer name will be used as identifier. If message is passed from FCSPMS through FCUI to an
external system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.

Universal Interface Technical Specification 7.00.0xx

Page 200 of 211

Acknowledge
Acknowledge message type is sent by the external system to confirm any triggered message
commands successfully received & executed from the FCUI.
Code

Type

Description

Required

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

COD

Acknowledgement Status

SPMS DB Field reference


n/a to be provided from
external system
n/a to be provided from
external system
Current date and time
n/a to be provided from
external system

The following is a description of the fields in the message data block:


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. This field is also
used to eliminate possibility of double postings. Full date and time format is required.
COD
The field identifies the status of the acknowledgement (0Success, 1-Failure).

Example
Message

<STX>Acknowledge<US>REF=FCUI#1<US>RQN=121<US>DTE=2006-10-11
14:11:12<US>COD=0<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 201 of 211

Failure
Failure message type is used to inform sender the requested command was not accepted or data
received was in the wrong format.
Description

Required

SPMS DB Field reference

Code

Type

REF

Sender Reference

RQN

Sender Request Number

DTE

Date and Time

n/a to be provided from


external system
n/a to be provided from
external system
Current date and time

FID

99

Failure ID

SYSTEM CLACULATED

INF

X(50)

Description

SYSTEM CLACULATED

The following is a description of the fields in the message data block:


REF
The field identifies the source or the destination of a message. Identifier must be unique within the
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates the
message computer name will be used as identifier. If message is passed from FCSPMS through
FCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTE
The field identifies the date and the time when the message was created. This date and time does
not change even when the message is repeated due to communication errors. Full date and time
format is required.
FID
The field identifies the error number. The following codes were defined:
00
01
02
03

Internal error
Communication error
No data found
Request not accepted

Universal Interface Technical Specification 7.00.0xx

Page 202 of 211

INF
The field identifies the text message describing the failure. The following error messages may be
returned:
100
101
102
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
150
151
152
153
154
155
156
157
158
159
160
161

Unknown error
Account not found
Undefined revenue centre
Credit limit exceeded
Posting already exists
Undefined payment type
Payments to credit card departments not allowed
Exchange rate not defined
Payment already exists
Cannot make posting to a credit department
Cannot make payment to a debit department
Payment failed
Error account has not been found
Undefined call type
Undefined phone number
No postings or payments found
Undefined excursion
No excursions found
Nothing to book
Booking or posting failed
Phone number not correct
Buyer postings disabled
Payer postings disabled
Booking failed. Excursion is already fully booked
Booking failed. Only x Adult or Child booking(s) available
Booking failed. Excursion is not available for Adults or Children
Clock In Already exist
Already Clocked Out
No Messages for this Account
Invalid Authorization Key
Invalid PIN Code
Undefined Cabin
Invalid Cabin Status
Booking failed. Only x Adult promotion booking(s) available
Booking failed. Only x Child promotion booking(s) available
Booking failed. Only x Adult and Child promotion booking(s) available
Invalid Promotion ID or Promotion End
Invalid Language ID
Only one tour per pax is allow for Overnight Tour
Casino Credit Limit Exceeded
Excursion not allow to book via ITV
Child Ticket not allow to book via ITV
Excursions Package not found.
Undefined package.
Booking failed. Package is not available for Adults.
Booking failed. Package is already fully booked.
Booking failed. Package is not available for Children.
Please select an invoice for multiple credit card
Account must have credit card registered as the payment type

Universal Interface Technical Specification 7.00.0xx

Page 203 of 211

162
163
164
165
166
167
168
201
202
203
204
205
206
207
208
209
300
301
302
303
304

305

Booking failed. Account has already reached the 1 Ticket per Person Limit for
this Event.
Booking failed. Event has only 1 Ticket per Person Limit.
No User Define Field Define
User Define Field Value exceed 100 characters
Invalid User Define ID
Invalid cabin number
Invalid call type
Invalid phone number
Error getting System Details.
Incorrect parameter values.

306
400
401
402
403
404
405
406
999

Example
Message

Invalid email address


The passenger is underage, casino charges are not allowed
Invalid Report ID
Invalid Account ID
Error message variable depend on the crystal report engine
Cabin Change only valid for Crew and Guest only
Reason change cabin fail
Treatment Group not defines.
Treatment Item not found.
No Treatment Available.
The reason why the SPA booking fail.
No Promotion Available
Fidelio DB is Down
No Active Exchange Rate
Participant Not Found
Picture not found
Event Not Found.
Invalid Price Category.
Undefined event.
Event not allow to book via ITV
Booking failed. Event is already fully booked.

<STX>Failure<US>REF=POS#2<US>RQN=125<US>DTE=1997-09-11
14:11:36<US>FID=101<US>INF=Account not found.<ETX><CHECKSUM>

Universal Interface Technical Specification 7.00.0xx

Page 204 of 211

SPMS Events
FC Management
Change Cabin - This message will trigger when guest is already check-in.
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger for old cabin and new cabin
If Aircon Message is not enable via PBX system
When PAR entry Interfaces->Use CICO for PBX CabinMove is enable
FCUI will send PHONECHECKOUT follow by PHONECHECKIN
When PAR entry Interfaces->Use CICO for PBX CabinMove is disable
FCUI will send a PHONECABINMOVE
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger for old cabin and new cabin
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCABINMOVE.
Edit Guest, Crew, Staff Information Message will only trigger when guest already check-in
Change of guest name, birth date, on board e-mail address (crew, staff do not have on board e-mail
address), gender, reprint board card
For PBX system FCUI will send PHONECHECKIN
For TV and Dining FCUI will send EXTCHECKIN
Change Guest, Crew, Staff Pin Number Message will only trigger when guest already
check-in
For PBX, TV and Dining FCUI will send UPDATEPIN
Add New Message or Edit Message for Guest will trigger MessageLight for PBX, TV and
Dining
Press Light On/Off button in message form will trigger MessageLight for PBX, TV and Dining

Universal Interface Technical Specification 7.00.0xx

Page 205 of 211

Guest Check-In
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKIN
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKIN
Guest Check-Out
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKOUT
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKOUT
Pressing Enable Phone in Guest Screen will trigger ENABLEPHONE for PBX only.
Pressing Disable Phone in Guest Screen will trigger DISABLEPHONE for PBX only.

Universal Interface Technical Specification 7.00.0xx

Page 206 of 211

FC Quick Check In
Change Cabin - This message will trigger when guest is already check-in.
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger for old cabin and new cabin
If Aircon Message is not enable via PBX system
When PAR entry Interfaces->Use CICO for PBX CabinMove is enable
FCUI will send PHONECHECKOUT follow by PHONECHECKIN
When PAR entry Interfaces->Use CICO for PBX CabinMove is disable
FCUI will send a PHONECABINMOVE
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger for old cabin and new cabin
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCABINMOVE.
Edit Guest, Crew, Staff Information Message will only trigger when guest already check-in
Change of guest name, birth date, on board e-mail address (crew, staff do not have on board e-mail
address), gender, reprint board card
For PBX system FCUI will send PHONECHECKIN
For TV and Dining FCUI will send EXTCHECKIN
Guest Check-In
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKIN
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKIN

Universal Interface Technical Specification 7.00.0xx

Page 207 of 211

Guest Check-Out
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKOUT
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKOUT

FC ETix Check In, FC Self Check In and FC Security


Guest Check-In
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKIN
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKIN

Universal Interface Technical Specification 7.00.0xx

Page 208 of 211

FC Administration
Guest Check-In
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKIN
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKIN
Guest Check-Out
For PBX system
If Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX system
FCUI will send PHONECHECKOUT
For TV and Dining
If Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining system
FCUI will send EXTCHECKOUT

Universal Interface Technical Specification 7.00.0xx

Page 209 of 211

Definitions, Acronyms, and Abbreviations


Term

Description

FCUI
FCSPMS
External Systems

Fidelio Cruise Universal Interface


Fidelio Cruise Shipboard Property Management System
Third party software owned by customer that interfaces with Fidelio
Cruise Universal Interface for exchange information.
Acknowledgement
No Acknowledgement
Crew members on cruise vessel (shipboard employees)
Passengers on cruise vessel
Telephone Exchange System (External System)
Interactive Television System (External System)
"The internet protocol provides for transmitting blocks of data called
datagrams from sources to destinations, where sources and
destinations are hosts identified by fixed length addresses." (RFC
791)
Reservation account for guest, crew, visitor and resident

ACK
NAK
Crew/Crew Members
Guests
PBX
iTV
Internet Protocol (IP)

Person

Universal Interface Technical Specification 7.00.0xx

Page 210 of 211

References
Below find other documents and/or utilities referenced within, their respective purpose, and location:

n/a

Universal Interface Technical Specification 7.00.0xx

Page 211 of 211

Вам также может понравиться