Upload
james-redd
View
218
Download
0
Embed Size (px)
Citation preview
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 1/211
Universal Interface – Technical Specification 7.00.0xx Page 1 of 211
Fidelio Cruise Software GmbHBorselstrasse 16c22765 Hamburg, GermanyTel: +49(0) 40 39807 0Fax: +49(0) 40 39807 300e-Mail: [email protected]
Universal InterfaceTechnical Specification
Version 7.00.0xx
Copyright1995-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. FidelioCruise Software GmbH retains the right to update or change the contents of this document without prior notice FidelioCruise Software GmbH assumes no responsibility for the contents of this document. Information in this document issubject to change without notice. Fidelio Cruise Software GmbH makes no warranty of any kind with regard to thismaterial, 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 inconnection with the furnishing, performance, or use of this material.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 2/211
Universal Interface – Technical Specification 7.00.0xx Page 2 of 211
Revision History
Version Date Description Author
7.00.0001 7-Jun-2013 Add New Field PGI for PhoneCheckOut andExtCheckOut
Add ACE=P for Folio Add ECD for InquireResponse Add ACT, ECD for GetPictureResponse,
PictureChange
Teng Le Woi
7.00.0002 8-Jun-2013 Add EOC for SystemDateChange Teng Le Woi7.00.0012 25-Sep-2013 Add RunReport Teng Le Woi
7.00.0016 14-Nov-2013 Add NAT, VGD for PhoneCheckIn Add VGD for PhoneCheckOut andPhoneCabinMove
Add StartPbx and EndPbx
Teng Le Woi
7.00.0017 15-Nov-2013 Add ChangeCabin andChangeCabinResponseChange PhoneCheckIn->CHG from Y andempty to Y and N
Teng Le Woi
7.00.0017 19-Nov-2013 Add PLM for FolioResponse Teng Le Woi7.00.0017 21-Nov-2013 Add QBP for InquireResponse
Add QBP and ACE for UpdateEMailTeng Le Woi
7.00.0019 3-Dec-2013 Add POI for PaymentResponse Teng Le Woi7.00.0033 19-Mar-2014 Add PGIx for PostingResponse,
PaymentResponse
Teng Le Woi
7.00.0038 17-Jun-2014 Add BID, BPI, PN2 for FolioResponse Teng Le Woi7.00.0040 13-Aug-2014 Add RRZ, RID, LUG for FolioResponse Teng Le Woi7.00.0044 2-Oct-2014 Remove SPALocation,
SPALocationResponse,SPATreatmentGroup,SPATreatmentGroupResponse,SPATreatmentItem,SPATreatmentItemResponse,SPATreatmentAvailable,SPATreatmentAvailableResponse,SPABooking, SPABookingResponse
Teng Le Woi
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 3/211
Universal Interface – Technical Specification 7.00.0xx Page 3 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 4/211
Universal Interface – Technical Specification 7.00.0xx Page 4 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 5/211
Universal Interface – Technical Specification 7.00.0xx Page 5 of 211
FC ETix Check In, FC Self Check In and FC Security ............................................................... 208
FC Administration ....................................................................................................................... 209
Definitions, Acronyms, and Abbreviations ............................................................................... 210
References .................................................................................................................................. 211
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 6/211
Universal Interface – Technical Specification 7.00.0xx Page 6 of 211
General Overview
The purpose of this document is to explain the Fidelio Cruise Universal Interface (FCUI) providesdescriptions of the connections types, standard transmission frame formats, the external systemrequest 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 7/211
Universal Interface – Technical Specification 7.00.0xx Page 7 of 211
Introduction
Fidelio Cruise Universal Interface (FCUI) provides descriptions of the connections types, standardtransmission frame formats, the external system request or response messages formats, the FidelioCruise Shipboard Property Management System (FCSPMS) request or response message formats.
Fidelio Cruise Engineers and Customer Analysts should use this manual, as a reference aid indeveloping programs required interfacing external software with the FCSPMS. As a source oftechnical information, this chapter is useful to the Customer Analysts and Fidelio Cruise SoftwareEngineers as it defines the technical requirements necessary to establish the communicationsinterface.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 8/211
Universal Interface – Technical Specification 7.00.0xx Page 8 of 211
Connections
The following is a description of communication methods FCUI can use to exchange informationwith external systems:
Serial Asynchronous Connection
The most common, serial asynchronous connection is implemented in FCUI to providecommunications with external systems. One serial cable is required to connect directly twocomputers (FCUI computer and external system computer). Any serial port on FCUI can be used forthe connection.
During FCUI and external system installation the parameters are agreed and implemented. Thefollowing is a description of serial line parameters and their values required providing reliableconnection between systems.
Baud Rate(Bits Per Second)
Specifies the speed of data stream passed between FCUI and external system. Thespeed can be set to any value supported by serial ports on both computers. Typicalrates 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 meanfaster 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 8bits per byte are used (default for FCUI, most common used).
Parity Specifies the parity option used to communicate. FCUI default value for the parameteris None.
Stop Bits Specifies number of stop bits to be used to verify communication transmission. FCUIdefault value for the parameter is 1.
Flow Control Specifies communication control link characters maintained by the computer operatingsystem. FCUI default value for the parameter is None.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 9/211
Universal Interface – Technical Specification 7.00.0xx Page 9 of 211
Modem Connection
Modem connection (dial-up) can be used to interface with systems that are out of the range of serialasynchronous 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 startcommunication and restart communication whenever the line is dropped. Both systems must alsobe 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 terminateconnection and they depend on the modem type installed. Serial port parameters set tocommunicate 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 betweendifferent systems. FCUI support TCP/IP protocol connection to an external system. This connectionis 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. Thefollowing is a description of parameters and their values required providing reliable connectionbetween systems.
FCUI and External System ComputerName
Uniquely identifies computers on the network and is set duringoperating system installation. It is recommended not to use spacecharacter (20H) when assigning computer name.
FCUI and External System ComputerIP Addresses
Uniquely identifies computer on the network (through its IPaddress) and is set typically during operating system installation. Itis highly recommended to make this address fixed and not to useany 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 usedwhen listening is set to 2001.
Microsoft Message Queue
1. We only support transactional message queue2. It only for response message, the message type supported is InquireResponse,
PostingResponse and GetPictureResponse (by option), if ITV MSMQ is enable, all messagewill 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 10/211
Universal Interface – Technical Specification 7.00.0xx Page 10 of 211
Message Data Flow
The communication is fully asynchronous i.e. FCUI will send or receive new messages withoutwaiting for reply to messages already received or send. There are no ACK or NAK communicationcharacters, reply or lack of reply message is used instead. The application level timeout should beprogrammable between 1 and 100 seconds. During FCUI and external system installation timeout isagreed and implemented. Internally FCUI expects to receive the whole message within 1 second. Ifno reply is received, message sender will retry to send the message up to 3 times after which themessage should be aborted and the necessary application-dependent error handling should beexecuted.
There is no length definition for data fields, only the maximum recommended length for characterbased fields. The recommended length can be extended without notice. When the character field isconsidered 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 thatare marked as "Required" (
) are necessary for the message to be accepted, "Optional" fields canbe skipped.
Additional fields can be added to different messages defined, without notice. External systemshould make sure it accepts all the fields defined and skips any unrecognized fields.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 11/211
Universal Interface – Technical Specification 7.00.0xx Page 11 of 211
Message Format
Message Components
This section describes structure and content of all messages send or received by the FCUI. Adddata 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 newmessage. The STX character is represented by the hexadecimal value 02H.
<TYPE> The field identifies type of message. Message types are fixed and defined inMessage Types section. The length of <TYPE> message is variable and is afunction of message type defined.
<DATA> The field contains message data block. Characters within a block can be in range20H through FFH, 1FH. Each field in the message starts with a US characterfollowed by code that identifies the information and number that identifies sequence
of repeated data fields within message. The parameters within the <DATA> canvary 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 themessage data block. The ETX character is represented by the hexadecimal value03H.
<CHECKSUM>Contains the checksum characters of the message. This field is a character (in therange 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 12/211
Universal Interface – Technical Specification 7.00.0xx Page 12 of 211
Message Data Block
<DATA> block consists of fields with values assigned. The format of all the fields is describedbelow:
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 beginningof 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 canbe repeated. Not present for messages with one appearance of the field. Thenumber 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 13/211
Universal Interface – Technical Specification 7.00.0xx Page 13 of 211
Message Data Block Type
Message data block types for both request and response messages are detailed in terms of fieldformat. 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
9 Unsigned numeric ASCII character field (without decimal point). Maximum valueaccepted 2E31.
9.9 Signed numeric ASCII character field (with decimal point). Dot (.) is always used toseparate 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).
D Date/Time character field. Time part can be skipped. Format accepted: YYYY-MM-DD HH:NN:SS where:
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.
X(x) Alphanumeric ASCII character field. All characters represented by the ASCII
characters in the range 20H through FFH. Numeric values within such fields areprocessed rather as string not value. The value "x" defines maximum recommendedlength of a field.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 14/211
Universal Interface – Technical Specification 7.00.0xx Page 14 of 211
Message Types
Message types describe information included in the <DATA> field within the message. Messagetypes 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. Ifthe identification field does not exist the response will be Failure. Otherwisethe message InquireResponse will be sent.
InquireResponse This message type is used to respond to the Inquire message. Theresponse will typically include cabin and name of passengers (or accountname).
Posting1 This message type is used to send general charges, but NOT call chargesto 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 andPostingResponse1 with a list of accounts (guests, crew members etc.) willbe sent back if more than one account matching criteria is found. If postingis not accepted the response will be Failure.
PostingResponse1 This message type is used to respond to the Posting1 message. Theresponse is logically the same as InquireResponse.
Posting2 This message type is used to send general charges AND call charges to theFCSPMS system. Posting will be made and PostingResponse2 messagewill be sent if only one account (guest, crew member etc.) matches thecriteria 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 accountmatching 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. Paymentswill be made and PaymentResponse message will be sent if only oneaccount (guest, crew member etc.) matches the criteria defined in themessage. Payment will NOT be made and PaymentResponse with a list ofaccounts (guests, crew members etc.) will be sent back if more than oneaccount matching criteria is found. If payment is not accepted the responsewill be Failure.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 15/211
Universal Interface – Technical Specification 7.00.0xx Page 15 of 211
Message Type Description
PaymentResponse Message type is used to respond to the Payment message. The responseis logically the same as PostingResponse1.
Folio Message type is used to request postings/payments list for an account fromthe FCSPMS. If the identification field does not exist the response will beFailure. Otherwise the message FolioResponse will be sent.
FolioResponse Message type is used to respond to the Folio message. The response willtypically include list of postings/payments for a selected account.
Excursions Message type is used to request list of excursions from the FCSPMS. If noexcursion is found the response will be Failure. Otherwise the messageExcursionsResponse will be sent.
ExtExcursions Message type is used to request list of excursions from the FCSPMS. If noexcursion is found the response will be Failure. Otherwise the messageExcursionsResponse will be sent.
ExcursionsResponse Message type is used to respond to the Excursions & ExtExcursions message. The response will typically include list of excursions that areavailable 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 criteriadefined in the message. Booking will NOT be made andBookingResponse with a list of accounts (guests, crew members etc.) willbe sent back if more than one account matching criteria is found. If bookingis not accepted the response will be Failure.
BookingResponse Message type is used to respond to the Booking message. The responseis logically the same as PostingResponse1.
ExcFolio Message type is used to request list of booked excursions for an accountfrom the FCSPMS. If the identification field does not exist the response willbe Failure. Otherwise the message ExcFolioResponse will be sent.
ExcFolioResponse Message type is used to respond to the ExcFolio message. The responsewill 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. Callposting will be always accepted except when parameters are improperlyset-up or double posting is detected. In those cases the response will beFailure.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 16/211
Universal Interface – Technical Specification 7.00.0xx Page 16 of 211
Message Type Description
CallResponse Message type is used to respond to the Call message. The response islogically the same as InquireResponse.
CabinStatus Message type is used to inform cabin status change. Fidelio System willrespond with the Acknowledge message type if status is successfullychanged or Failure message type if otherwise.
PhoneCheckIn Message type is used to send request to telephone exchange system toopen phone lines and (optionally) register new person with the phone line.Telephone exchange system must confirm the command was received withPhoneResponse message. If the command cannot be executed externalsystem should respond with Failure command.
PhoneCheckOut Message type is used to send request to telephone exchange system toclose phone lines and (optionally) un-register a person previously registeredwith the line. The message is send each time person is checked-out fromFCSPMS system. However, the command includes also the flag thatinforms if the last person has been checked-out from the phone line.Telephone exchange system must confirm the command was received withPhoneResponse message. If the command cannot be executed externalsystem should respond with Failure command.
PhoneCabinMove Message type is used to send request to telephone system to enable thenew cabin and disable the old cabin in order to retain the voice mail andwakeup 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 shouldrespond with Failure command.
PhoneResponse Message is received from external system as a confirmation for successfulexecution of Phone commands.
EnablePhone Message type is used to unblock the phone instead of checking in thephone. Telephone exchange system must confirm the command wasreceived with PhoneResponse message. If the command cannot beexecuted 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 withPhoneResponse Message.If the command cannot be executed external system should respond withFailure command.
ExtCheckIn Message type is used to send Check In information to the external systembased on the InquireResponse message format. External System has torespond with the Acknowledge message type.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 17/211
Universal Interface – Technical Specification 7.00.0xx Page 17 of 211
Message Type Description
ExtCheckOut Message type is used to send Check Out information to the externalsystem. External System has to respond with the Acknowledge messagetype.
ExtCabinMove Message type is used to send Cabin Change information to the externalsystem. External System has to respond with the Acknowledge messagetype.
ChangeAirConState Message type is sent by the FCUI to supply the information to theexternal 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 sentupon received of this message
ClockOut Message is received from external time attendance system when a crewmember is logged or reported out from duty. The Acknowledge will be sentto 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 systemwhen SysMsgReq is received.
MessageLight Message type is used to send information to the external system forswitching on or off the message light. External System has to respond withthe Acknowledge message type.
Messages Message type is used to send request for Guest Message to FCSPMS. Thereply will be sent with MessageList.
MessageListMessage type is used to send the list of Messages for the Account specifiedby the external system when Messages is received.
Acknowledge Message type is used for receiving Success or Failure from the externalsystem for ExtCheckIn, ExtCheckOut & ExtCabinMove messages.
Failure Message type is used to inform sender the command send was notaccepted or was not correctly transmitted. Message describing failure isprovided.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 18/211
Universal Interface – Technical Specification 7.00.0xx Page 18 of 211
Message Type Description
SetPIN Message type is used to set the PIN code of an account in FCSPMS fromexternal 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 inquiredaccount 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 PINcode 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 theFCSPMS.
There is 5 message type regard to SPA Booking, each must be call in thefollowing sequence.
1. Call the SPALocation2. Call the SPATreatmentGroup3. Call the SPATreatmentItem4. Call the SPATreatmentAvailability5. Call the SPABooking
SPATreatmentGroup SPATreatmentGroup message type is used to request the SPA TreatmentGroup from the FCSPMS.
SPATreatmentItem SPATreatmentItem message type is used to request the SPA TreatmentItem from the FCSPMS
SPATreatmentAvailability SPATreatmentAvailability message type is used to request the SPA
Treatment Availability (time slot) from the FCSPMSSPABooking SPABooking message type is used to make a SPA Booking
GetPromoMessageGetPromoMessage message type is used to request list of promotionavailable from the FCSPMS
EventsEvents message type is used to request a list of events available from theFCSPMS
ExtEventsExtEvents message type is used to request list of events available from theFCSPMS
EventBookingEventBooking message type is sent to the FCUI to insert event booking andpost event charge
EventFolioEventFolio message type is used to request list of events booked on aspecific account in FCSPMS
UDFRead UDFRead message type is sent to the FCUI to read the user define type ofa passenger
UDFUpdateUDFUpdate message type is sent to the FCUI to update the user definetype of a passenger
GetCruiseItineraryGetCruiseItinerary message type is send to the FCUI to get list of cruiseinformation
SystemDateChangeMessage type is used to send request to external exchange system toinformation Fidelio system date had changed. External system must confirmthe command was received with Acknowledge message.
SystemCruiseChangeMessage type is used to send request to external exchange system toinformation Fidelio system cruise had changed. External system mustconfirm the command was received with Acknowledge message.
GetExchangeRateGetExchangerate message type is send to the FCUI to get list of active
exchange rateGetPicture GetPicture message type is send to the FCUI to get the guest picture
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 19/211
Universal Interface – Technical Specification 7.00.0xx Page 19 of 211
Message Type Description
PictureChangeMessage type is used to send request to ITV and Dining system to informthem the guest picture had changed.
UpdateEmailUpdateEmail message type is send to the FCUI to update the guestonboard e-mail account
PhoneStart PhoneStart message type is send from FC Admin Batch Check In/Out toindicate start of batch PBX check-in process
PhoneEndPhoneEnd message type is send from FC Admin Batch Check In/Out toindicate end of batch PBX check-in process
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 20/211
Universal Interface – Technical Specification 7.00.0xx Page 20 of 211
For the period of full message transmission communication link is to be open. Whole message isdropped if any part is interrupted during transmission. The following communication message typesare 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 / FailurePosting1 PostingResponse1 / FailurePosting2 PostingResponse2 / FailurePayment PaymentResponse / FailureFolio FolioResponse / FailureExcursions ExcursionsResponse / FailureExtExcursions ExcursionsResponse / FailureBooking BookingResponse / FailureExcFolio ExcFolioResponse / Failure
Call CallResponse / FailurePhoneCheckIn PhoneResponse / FailurePhoneCheckOut PhoneResponse / FailurePhoneCabinMove PhoneResponse / FailureEnablePhone PhoneResponse / FailureDisablePhone PhoneResponse / FailureExtCheckIn AcknowledgeExtCheckOut AcknowledgeExtCabinMove AcknowledgeChangeAirConState AcknowledgeClockIn AcknowledgeClockOut Acknowledge
SysMsgReq SysMsgMessageLight AcknowledgeMessages MessageListSetPIN AcknowledgeGetPIN PINDetailsUpdatePIN AcknowledgeSPALocation SPALocationResponse / Failure
SPATreatmentGroup
SPATreatmentGroupResponse / Failure
SPATreatmentItem SPATreatmentItemResponse / Failure
SPATreatmentAvailability
SPATreatmentAvailabilityResponse / Failure
SPABooking
SPABookingResponse / Failure
GetPromoMessage
GetPromoMessageResponse / Failure
Events
EventsResponse / Failure
ExtEvents
EventsResponse / Failure
EventBooking
EventBookingResponse / Failure
EventFolio EventFolioResponse / Failure
UDFRead
UDFReadResponse / Failure
UDFUpdate
UDFUpdateResponse / Failure
GetCruiseItinerary->GetCruiseItineraryResponse/ Failure
SystemDateChange Acknowledge
SystemCruiseChange Acknowledge
GetExchangeRate->GetExchangeRateResponse / Failure
GetPicture->GetPictureResponse / Failure
PictureChange->AcknowledgeUpdateEMail Acknowledge
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 21/211
Universal Interface – Technical Specification 7.00.0xx Page 21 of 211
PhoneStart Acknowledge
PhoneEnd Acknowledge
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 22/211
Universal Interface – Technical Specification 7.00.0xx Page 22 of 211
Interface Types
FCUI is designed to provide communication between FCSPMS and different external systems. Thefollowing is a description of interface systems currently served and messages that has to beimplemented in every external system:
Point Of Sales
The system is used to charge for items sold to customers at different sales locations. Followingmessage 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.
InquireInquireResponsePosting1 PostingResponse1 Posting2 PostingResponse2 Failure
Call Accounting
The system is used to charge for phone calls. Its functionality can be combined with PublicTelephone Exchange functionalities. Following message types must be implemented in the Call Accounting system to interface properly with FCUI. Note that Failure command informs aboutcritical problems and can be only expected during installation. It should not appear during dailyFCUI usage.
CallCallResponseFailure
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 23/211
Universal Interface – Technical Specification 7.00.0xx Page 23 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 properlywith FCUI. When a person is moved from one cabin to another commands PhoneCheckOut andPhoneCheckIn are send to PBX system or PhoneCabinMove can be sent instead, with aparameter. Note that Failure command informs about critical problems and can be only expectedduring installation. It should not appear during daily FCUI usage.
CabinStatusPhoneCheckInPhoneCheckOutPhoneCabinMovePhoneResponseMessageLight
MessagesMessageListFailureEnablePhoneDisablePhoneSetPINGetPINUpdatePINChangeAirConStateSystemDateChangeSystemCruiseChange
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 24/211
Universal Interface – Technical Specification 7.00.0xx Page 24 of 211
Interactive TV
The system is used to charge for items sold and accepted payments from customers. Followingmessage types must be implemented in the iTV system to interface properly with FCUI.
InquireInquireResponsePosting1 PostingResponse1 Posting2 PostingResponse2 PaymentPaymentResponseFolioFolioResponseExcursions
ExtExcursionsExcursionsResponseBookingBookingResponseCabinStatusExcFolioExcFolioResponseExtCheckInExtCheckOutExtCabinMoveMessageLightMessages
MessageListAcknowledgeFailureSetPINGetPINUpdatePINSystemDateChangeSystemCruiseChangeGetExchangeRateGetPicturePictureChange
UpdateEMail
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 25/211
Universal Interface – Technical Specification 7.00.0xx Page 25 of 211
Dining Room
The system is used to charge for items sold and accepted payments from customers, handle specialrequests, etc. Following message types must be implemented in the Dining Room system to
interface properly with FCUI.
InquireInquireResponsePosting1 PostingResponse1 Posting2 PostingResponse2 PaymentPaymentResponseFolioFolioResponse
CabinStatusExtCheckInExtCheckOutExtCabinMoveMessagesMessageListAcknowledgeFailureSetPINGetPINUpdatePINSystemDateChange
SystemCrusieChangeGetExchangeRateGetPicturePictureChangeUpdateEMail
Time and Attendance
The system used to log down the clocked in and out of crew member that is on/off duty. It’spurposed 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 nexttime he is clocked out from duty.
ClockInClockOut
NOTE: The System Message can be requested by any of the external systems.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 26/211
Universal Interface – Technical Specification 7.00.0xx Page 26 of 211
Message Types Data Block
Inquire
Inquire message type is used to request the information from the FCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status RES_STATUS translated to
R/C/A/D/S
ACT X(1) Account Type OptionalRES_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 thewhole 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 throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe 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 doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACI Entered by the external system operator (manually or through a magnetic card reader) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 27/211
Universal Interface – Technical Specification 7.00.0xx Page 27 of 211
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)N Name of a person or company account(UXP_A_NAME_N)I Internal identification number (UXP_A_ID)G Group Id number (RES_GRP)E External identification number (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)M e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)H Internal Id number(UXP_C_INTERNALID)X Guest Category(GCT_CODE) R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)
S
Manning Number/Safety NumberP Pre generated Random Number (RES_PGID)
ACSThe field identifies the account current reservation status. The following status values were defined:
R ReservationsC Checked-InA Active (Reservations and Checked-in)D DisembarkedS Disembarked Residents (Owners – Valid only for ResidenSea)E Checked-In and all Reservation for the current cruise
ACTThe 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 Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS Staff
Z Gift Card
ExampleMessage
<STX>Inquire<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-1114: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-1114:10:23<US>ACI=0123<US>ACE=A<US>ACS=R<US>ACT=P <ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 28/211
Universal Interface – Technical Specification 7.00.0xx Page 28 of 211
InquireResponse
InquireResponse message type is sent by the FCUI to supply the information in response to aninquiry request from an external system. The message returns only accounts (people) that are
checked-in.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACIx 9 Account ID RES_ACC
ACTx X(1) Account Type RES_TAG
ENBx 9 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 D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date
RES_DIS_E for expected &checked in accounts,
RES_DIS_A for checked outaccounts
DOBx D 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 [Id –Description] optional RES_GRP + UXP_A_NAME
CATx X(500)Category Id & Description [Id –Description; Id –Description] optional
GCT_CODE +TYP_GCT.TYP_COMMENT
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 29/211
Universal Interface – Technical Specification 7.00.0xx Page 29 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
CLMx 9.9 Credit Limit optional
Credit limit as per assignedcredit department code,
unless individual credit limit isassigned in UXP_A_CRELIM
SMLx X(72) Ship’s e-Mail Id optional RES_EMAIL_SHIP
PINx X PIN Code optional RES_PIN_CODE
AKYx X(4) Authorization Key optionalRefer to PAR Value for PAR-Interfaces-“AuthKey Criteria”
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 9 Routed Account ID optional RES_QROUTE_ACC
POSx 9 Routed Account Enable optionalUXP_A_POSTING(refer to
the payer)
NATx X(6) Passport Nationality optional UXP_H_PASSPI_COUNTRY
PICx X Guest Picture (Unlimited Length) optional SEC_IMAGE
GIDx X(15) Group ID optionalRES_SHOREID(refer to
Group)
CSWx X(100) Cabin Steward Name optional RES_ACC (linked toCAB_KEEPER)
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 optionalORG_ASSEMBLY(linked to
MST_ID)
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 30/211
Universal Interface – Technical Specification 7.00.0xx Page 30 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 optionalORG_E_MST1(linked to
MST_ID)
EN1x X(50) Emergency Muster Station Description1 optional MST_NAME
EC2x X(6) Emergency Muster Station Code 2 optionalORG_E_MST2(linked to
MST_ID)
EN2x X(50)Emergency Muster Station Description2
optional MST_NAME
EC3x X(6) Emergency Muster Station Code 3 optionalORG_E_MST3(linked to
MST_ID)
EN3x X(50)Emergency Muster Station Description3
optional MST_NAME
EC4x X(6) Emergency Muster Station Code 4 optionalORG_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 optionalORG_E_MST5(linked to
MST_ID)
EN5x X(50)Emergency Muster Station Description5
optional MST_NAME
EC6x X(6) Emergency Muster Station Code 6 optionalORG_E_MST6(linked to
MST_ID)
EN6x X(50)Emergency Muster Station Description6
optional MST_NAME
NDRx X(3) Excuse From Safety Drill (Yes/No) optional UXP_C_NODRILL
PSCx 9 Picture Source SEC_SOURCE
PMDx D 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 9 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
RCLx 9.9 Routed Account Credit Limit optional
Routed Account Credit limitas per assigned credit
department code, unlessindividual credit limit is
assigned in UXP_A_CRELIM
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 31/211
Universal Interface – Technical Specification 7.00.0xx Page 31 of 211
Code Type Description Required SPMS DB Field reference
SDTx D Fidelio Cruise System Date sys_date
CSDx D Current Cruise Start Date scr_a_date of current cruise
CSNx X(10) Casino ID RES_ACC padded zero to 10digits
CS1x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS2x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS3x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS4x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS5x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS6x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS7x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS8x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
CS9x X(4000) Custom SQL Field 1 optionalThe field will depend on the
custom sql written
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 9 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 responsemessage number one is required while all the others are optional. Record number will not bepresent 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 32/211
Universal Interface – Technical Specification 7.00.0xx Page 32 of 211
whole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused 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 doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACIxThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
ACTxThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
ENBx The field identifies the information if an account is enabled (1) or disabled (0).
NAMxThe field identifies the salutation, forename and surname fields (separated with space) of anaccount (person).
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and the time the account (person) is expected or embarked.
DISxThe field identifies the date and the time the account (person) is expected to disembark.
DOBxThe field identifies the person date of birth. If the account number is returned (not a person) or dateof birth is not present the field is omitted.
EMLxThe field identifies the person e-mail address. If the account number is returned (not a person) or e-mail is not present the field is omitted.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 33/211
Universal Interface – Technical Specification 7.00.0xx Page 33 of 211
BALxThe field identifies the account (person) current balance. This field can return positive (account is tobe invoiced) or negative (account prepaid) value.
FSTxThe field identifies the forename of an account (person).
LSTxThe field identifies the surname of an account (person).
SALxThe field identifies the salutation of an account (person).
TTLxThe field identifies the title of an account (person).
GNDxThe field identifies the gender of an account (person).
MINxThe field identifies the "Y" or "N" if the account (person) is a Minor. This is matched against adatabase parameter.
LANxThe field returns the language of an account (person).
STAxThe field identifies the reservation status [E –Expected, C –Checked-In, D-Departed] of an account
(person).
GRPxThe field identifies the group Id & the name of the group if a passenger is assigned to a group.
CATxThe field identifies the category Ids & the names of the categories if a passenger is assigned anycategories.
ADDxThe field identifies the address (Line 1).
STRxThe field identifies the street (Line 2).
CTYxThe field identifies the city.
ZIPxThe field identifies the zip code.
STTxThe field identifies the state.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 34/211
Universal Interface – Technical Specification 7.00.0xx Page 34 of 211
CTRxThe field identifies the country code.
TELxThe field identifies the telephone number.
CLMxThe field identifies the credit limit set for the person(s).
SMLxThe field identifies the Ship’s e-Mail Id for the person(s).
PINxThe field identifies the telephone PIN code for the person(s). The valid character is0,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).
BIDxThe field identifies the booking id.
SIDxThe field identifies the shore id.
VGDxThe field identifies the unique guest id.
AWDx
The field identifies the guest award level.
BCCxIt 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 send9910000657580701
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).
NATxThe field identifies the guest passport nationality
PICxThe 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 orbinary string.
'Convert the hex string to byte arrayPublic Function HexToByte(ByVal sString As String) As Byte()
Dim nX As LongDim nLen As Long
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 35/211
Universal Interface – Technical Specification 7.00.0xx Page 35 of 211
Dim byLen() As Byte
nLen = Len(sString)If nLen / 2 <> Int(nLen / 2) Then ' Odd Lenght
sString = "0" & sStringEnd IfReDim byStr(Len(sString) / 2 - 1) As ByteFor nX = 1 To Len(sString) Step 2byStr(nX \ 2) = Val("&H" & Mid(sString, nX, 2))
Next nXHexToByte = byStr
End Function
'Convert the hex string to stringPublic Function HexToStr(ByVal sString As String) As String
Dim nX As LongDim nLen As Long
Dim sStr As String
nLen = Len(sString)If nLen / 2 <> Int(nLen / 2) Then ' Odd Lenght
sString = "0" & sStringEnd IfReDim byStr(Len(sString) / 2 - 1) As ByteFor nX = 1 To Len(sString) Step 2sStr = sStr & Chr("&H" & Mid(sString, nX, 2))
Next nXHexToStr = 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 blanke.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)
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 36/211
Universal Interface – Technical Specification 7.00.0xx Page 36 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)
PSCxPicture Source-1 = No Picture0 = Unknow1 = Web Cam2 = RFID Passport3 = Scan Passport Image4 = Guest History
PMDx
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 37/211
Universal Interface – Technical Specification 7.00.0xx Page 37 of 211
Picture Last Modified Date, due to the size of the picture, it is not efficient to return the picture inINQ message, so what you need to do is compare the last modified date of the picture store in yourDB and if the picture had been updated, send GetPicture message to get the picture in a separatecall.
FRQxFrequent Traveller Card Number
PCTxBooking Price Category (res_pcategory)
CBTxCabin Type
NCLxNon Refundable Credit
SCRxCurrent Cruise ID
OCCxThis field only exists when they reprint a new board card, this is the old board card valueIt 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 send9910000657580701
PASxPassport Number
PAYxDefault payment department ID
BWFxBeverage Waiver Flag, current not supported, always return N
CLRxThis field identified the reservation classification/VIP Flag.
RCLxThe field identifies the credit limit set for the routed person(s) (payer account).
SDTxCurrent Fidelio cruise system date.
CSDxCurrent cruise start date.
CSNxCasino ID, it a ACIx padded zero to 10 digits
CS1x to CS9xThe return value and data type will depend on the custom SQL written. It will be different from shipto ship. Please refer to Fidelio Cruise support for more details.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 38/211
Universal Interface – Technical Specification 7.00.0xx Page 38 of 211
PGIxPregenerated Random Number
SCIxCruise external system identifier
REZxExternal reservation ID
DEKxCabin Deck code
ECDxExternal Crew ID
QBPxQuick Billing Printing Flag, 1 – Print Invoice, 0 – Do no print invoice in the Quick Billing Screen
RRZxPayer External reservation ID
RIDxList of RFID separate by “,”
LUGxList of luggage tag id separate by “,”
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>InquireResponse<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>ACI1=9001201<US>ACT1=P<US>ENB1=1<US>NAM1=JohnMalkovitch<US>CAB1=0123<US>EMB1=1997-09-10<US>DIS1=1997-09-12<US>DOB1=1970-04-08<US>[email protected] <US>BAL1=123.45<US>FST1=John<US>LST1=Malkovitch<US>SAL1=<US>TTL1=<US>GND1=M<US>MIN1=N<US>LAN1=EN<US>STA1=C<US>GRP1=Group1<US>CAT1=Category1<US>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>[email protected]
<US>PIN1=15223<US>AKY1=1234<US>BID1=80797755<US>SID1=Shore123<US>VGD1=00000000000050060272<US>AWD1=Silver<US>BCC1=9841000020957311<US>ROI1=9001202<US>POS1=1<US>NAT1=SG<US>HAD1=Wheel Chain Require<FS>Deaf <US>HAR1=Needspecial 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=JaneMalkovitch<US>CAB2=0123<US>EMB2=1997-09-11<US>DIS2=1997-09-13<US>DOB2=1973-04-08<US>[email protected]<US>BAL2=24.12<US>FST2=Jane<US>LST2=Malkovitch<US>SAL2=<US>TTL2=<US>GND2=F<US>MIN2=N<US>LAN2=EN<US>STA2=C<US>GRP2=9002402-Holiday Group<US>CAT2=FQT-Frequent Cruisers;SNR-SeniorCitizen<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) 3990-0163<US>CLM2=2000.00<US>[email protected]<US>PIN2=15233<US>AKY
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 39/211
Universal Interface – Technical Specification 7.00.0xx Page 39 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=FireStation #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>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 40/211
Universal Interface – Technical Specification 7.00.0xx Page 40 of 211
Posting1
Posting1 message type is sent to the FCUI to insert posting charges, except for call postings.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status RES_STATUS translated toR/C
POI X(48) Unique Posting ID n/a – to be provided from
external system
POOx 9 Outlet ID DEP_POS_CODE +
DEP_POS_TYPE
POVx 9.9 Posting Value n/a – to be provided from
external system
POPx 9 Serving Period optionaln/a – to be provided from
external system
PODx 9.9 Discount Value optionaln/a – to be provided from
external system
POCx 9.9 Service Charge Value optional
n/a – to be provided from
external system
POTx 9.9 Tip Value optionaln/a – to be provided from
external system
IMG X(1024) Receipt image optionaln/a – to be provided from
external system
INF X(50) Notes optionaln/a – to be provided from
external system
PIN X PIN Code optionalRES_PIN_CODE
DTL XUnlimited Length, refer below formore detail
optionaln/a – to be provided from
external system
FLG XY-Allow posting even the guest hasreached his credit limit or posting isdisable, N-Normal posting
optionaln/a – to be provided from
external system
WINx 9 Invoice Windows (0 – 3) optionaln/a – to be provided from
external system
POXx 9.9 Tax Value optionaln/a – to be provided from
external system
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 41/211
Universal Interface – Technical Specification 7.00.0xx Page 41 of 211
The message can accept one or more subgroup levels within one posting transaction. This way theexternal system can pass more detailed posting information to the FCSPMS. Record number cannotbe used if only one record is send.
REF The field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused 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 alsoused 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) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)N Name of a person or company account(UXP_A_NAME_N)I Internal identification number (UXP_A_ID)G Group Id number (RES_GRP)E External identification number (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)M e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)H Internal Id number(UXP_C_INTERNALID)X Guest Category(GCT_CODE) R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
ACSThe field identifies the account current reservation status. The following status values are accepted:
R ReservationsC Checked-in
POIThe field identifies the bill (check) uniquely within the whole external system. The field is used as across-reference to obtain detailed information about all the transactions recorded on a check.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 42/211
Universal Interface – Technical Specification 7.00.0xx Page 42 of 211
POOxThe field identifies the revenue center of the outlet from which the charge originated. The FCSPMSdescription 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) ornegative (void) value.
POPxThe field identifies the serving period number that is active when the charge is posted.
PODxThe field identifies the total amount of discounts taken against the transaction total amount. Thisfield 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 transactiontotal. This field can have positive (account is debited) or negative (void) value.
POTxThe 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 fieldcan 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 is0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 43/211
Universal Interface – Technical Specification 7.00.0xx Page 43 of 211
DTLThis field identified the items order on the external system. The field contain many sub field, eachfield is separated with <FS> ASCII 28. If the external systems do not have the particular field justpass in the default value indicate in bracket.
Field Type Description
1 9 Employee Number (Default 0)
2 X(30) Employee Name (Default Blank)
3 9 Guest Count (Default 0)
4 9 Table Number (Default 0)
5 X(60) Outlet Name
6…999 X
Variable Length field. Field 6 till 999 represent item details. Each record willhave 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|T-Shift|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 tocheck-in guest only), N-Normal posting.
WINxThe 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 44/211
Universal Interface – Technical Specification 7.00.0xx Page 44 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>Posting<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-1114: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 LAGOON1 CASHIER 1--------------------------------1/1 4578 GST 1
JUN12'07 6:44PM--------------------------------
1 LIBRA FRIED RICE 12.34DISCOUNT 2.10-SERVICE CHARGE 0.12
TIP 1.00TOTAL PAID 11.3605000XXXN070612184500MANUAL ENTRYCabin/Acc:05000Ms TONG JEN LEECABIN 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>GiftShop<FS>205789412|T-Shift|1|12.34<ETX><CHECKSUM>
<STX>Posting<US>REF=POS#2<US>RQN=122<US>DTE=1997-09-1114:10:35<US>ACI=9001201<US>ACE=I<US>ACS=R<US>POI=10982<US>POO1=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<US>WIN=1<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 45/211
Universal Interface – Technical Specification 7.00.0xx Page 45 of 211
PostingResponse1
PostingResponse1 message type is sent by the FCUI to confirm posting made.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
CABx X(6) Cabin Number optionalRES_CAB
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date RES_DIS_E
BALx 9.9 Balance (UXP_A_POS_DEBIT –UXP_A_POS_CREDIT)
CRUx 9.9 Posted Cruise ID optionalPOS_CRUISE
POIx X(48) Original Unique Posting ID from thePosting message optional n/a – to be provided fromexternal system
OCIx X(52)Original Account ID from the Postingmessage
optionaln/a – to be provided from
external system
PGIx X(8) Pregenerated Random ID 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. Theresponse message number 1 is required while all the others are optional. Record number will not bepresent if only one record is returned. If one record is returned it serves as a confirmation that thepostings have been made. Final balance after the posting is applied will be send. No posting isinserted if more than one record is returned. In this case current balance is returned. Externalsystem 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 thewhole 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 46/211
Universal Interface – Technical Specification 7.00.0xx Page 46 of 211
FCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 47/211
Universal Interface – Technical Specification 7.00.0xx Page 47 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 doesnot change even when the message is repeated due to communication errors. Full date and timeformat 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).
ACTxThe field identifies the account type. The following account types are defined:
P Passenger (Guest)
R
Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
NAMx The field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBx The field identifies the date and the time the account (person) is expected or embarked.
DISxThe 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. Otherwisereturns current balance. This field can return positive (account is to be invoiced) or negative(account prepaid) value.
CRUxThe field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
POIxOriginal POI from the posting message
OCIx Original ACI from the posting message
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 48/211
Universal Interface – Technical Specification 7.00.0xx Page 48 of 211
PGIxPregenerated Random Number
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-1114:10:24<US>ACI1=9001201<US>ACT1=P<US>NAM1=JohnMalkovitch<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-09-13<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-1114:10:28<US>ACI=9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=135.79<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 49/211
Universal Interface – Technical Specification 7.00.0xx Page 49 of 211
Posting2
Posting2 message type is sent to the FCUI to insert posting charges and call charges.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN X Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status. RES_STATUS translated to
R/C
PTY X(1)Posting Type ('C' –Call Accounting,'P' –Generic Posting). Default wouldbe generic posting.
n/a – to be provided from
external system
POI XUnique Posting ID or Unique CallPosting ID
n/a – to be provided from
external system
POOx 9 Outlet ID (For generic posting) DEP_POS_CODE +
DEP_POS_TYPE
POVx 9.9 Posting Value (For generic posting) n/a – to be provided from
external system
POPx 9 Serving Period optionaln/a – to be provided from
external system
PODx 9.9 Discount Value optional
n/a – to be provided from
external system
POCx 9.9 Service Charge Value optionaln/a – to be provided from
external system
POTx 9.9 Tip Value optionaln/a – to be provided from
external system
IMG X(1024)Receipt image (This field is notapplicable for posting type PTY = “C”(Call Posting))
optionaln/a – to be provided from
external system
NUM X(30)Dialled Number (For Call AccountingPosting)
optionaln/a – to be provided from
external system
BEG DCall Start Date or Time (For Call
Accounting Posting)optional
n/a – to be provided fromexternal system
DUR 9 Call Duration (For Call AccountingPosting) optional n/a – to be provided fromexternal system
TYP X(2)Call Type (For Call AccountingPosting)
optionaln/a – to be provided from
external system
INF X(50)Notes (This field is not applicable forposting type PTY = “C” (Call Posting))
optionaln/a – to be provided from
external system
PIN X PIN Code optionalRES_PIN_CODE
FLG XY-Allow posting even the guest hasreached his credit limit or posting isdisable, N-Normal posting
optionaln/a – to be provided from
external system
WINx 9 Invoice Windows (0 – 3) optionaln/a – to be provided from
external system
POXx 9.9 Tax Value optional n/a – to be provided fromexternal system
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 50/211
Universal Interface – Technical Specification 7.00.0xx Page 50 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 theexternal system can pass more detailed posting information to the FCSPMS. Record number cannotbe used if only one record is send.
REF The field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused 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 doesnot change even when the message is repeated due to communication errors. This field is alsoused 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) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account. (RES_CAB/UXP_A_SYS_ACC)I Internal identification number (FCSPMS account ID) (UXP_A_ID)E External identification number (e.g. reservation number) (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)H Internal Id number (UXP_C_INTERNALID)R RFID UID (RFID_ID)
F
Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
ACSThe field identifies the account current reservation status. The following status values are accepted:
R ReservationsC Checked-in
PTYThe field identifies the posting type. The following values are accepted:
P Genenic PostingC Call Accounting
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 51/211
Universal Interface – Technical Specification 7.00.0xx Page 51 of 211
POIThe field identifies the bill (check) uniquely within the whole external system. The field is used as across-reference to obtain detailed information about all the transactions recorded on a check.
POOxThe field identifies the revenue center of the outlet from which the charge originated. The FCSPMSdescription equivalent of the Outlet ID will be displayed or printed on a customer invoice.
POVxThe field identifies the actual amount (gross) is posted. This value represents value in full (includingdiscount, service charge and tip). This field can have positive (account is debited) or negative (void)value.
POPxThe field identifies the serving period number that is active when the charge is posted.
PODxThe field identifies the total amount of discounts taken against the transaction total amount. Thisfield can have positive (account is debited) or negative (void) value.
POCxThe field identifies the total amount of any automatic percentage add-on amounts to the transactiontotal. This field can have positive (account is debited) or negative (void) value.
POTxThe 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 fieldcan have positive (account is debited) or negative (void) value.
IMGThe 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 beformatted to be displayed using non-proportional fonts.
NUMThe field identifies the phone number called.
BEGThe field identifies the date and the time when the phone call started. Full date and time format isrequired.
DURThe field identifies the phone call duration in seconds.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 52/211
Universal Interface – Technical Specification 7.00.0xx Page 52 of 211
TYPThe field identifies the phone call type. The following types are defined:
VL Line Voice CallVC Cellular Voice CallVS Satellite Voice CallVN Non chargeable Voice CallFL Line FaxFC Cellular FaxFS Satellite FaxFN Non chargeable FaxDL Line Data CallDC Cellular Data CallDS Satellite Data CallDN Non chargeable Data Call
INFThe field identifies the additional information send by FCUI.
PINThe field identifies the telephone PIN Code of the reservation account. The valid character is0,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 tocheck-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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 53/211
Universal Interface – Technical Specification 7.00.0xx Page 53 of 211
ExampleMessage
Posting2 (Generic):
<STX>Posting<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-1114: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-1114:10:35<US>ACI=9001201<US>ACE=I<US>ACS=R<US>PTY=P<US>POI=10982<US>POO1=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><CHECKSUM>
Posting2 (Call Accounting):
<STX>Posting<US>REF=PBX#1<US>RQN=123<US>DTE=2004-09-1114: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-1114: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-1114:10:35<US>ACI=9001201<US>ACE=I<US>ACS=R<US>PTY=C<US>COI=100103<US>POO1=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>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 54/211
Universal Interface – Technical Specification 7.00.0xx Page 54 of 211
PostingResponse2
PostingResponse2 message type is sent by the FCUI to confirm general posting or call postingmade.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN X Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 UXP_A_SALUT,UXP_A_FSTN,UXP_A_NAME
CABx X(6) Cabin Number optionalRES_CAB
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date RES_DIS_E
BALx 9.9 Balance (UXP_A_POS_DEBIT –UXP_A_POS_CREDIT)
CRUx 9.9 Posted Cruise ID optionalPOS_CRUISE
POIx X(48)Original Unique Posting ID from thePosting message
optionaln/a – to be provided from
external system
OCIx X(52)Original Account ID from the Postingmessage
optionaln/a – to be provided from
external system
PGIx X(8) Pregenerated Random ID 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. Theresponse message number one is required while all the others are optional. Record number will notbe present if only one record is returned. If one record is returned it serves as a confirmation thatthe postings have been made. Final balance after the posting is applied will be send. No posting isinserted if more than one record is returned. In this case, the current balance is returned. TheExternal system should send the Posting message to identifying one account that the postingshould apply to.
The following is a description of the fields in the message data block.
REFThe 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 themessage computer name will be used as identifier. If message is passed from FCSPMS through
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 55/211
Universal Interface – Technical Specification 7.00.0xx Page 55 of 211
FCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field identifies the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat 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).
ACTxThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
NAMxThe field identifies the salutation, forename and surname fields (separated with space) of an
account (person) to satisfy inquiry criteria.
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBxThe 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. Otherwisereturns current balance. This field can return positive (account is to be invoiced) or negative(account prepaid) value.
CRUxThe field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
POIxOriginal POI from the posting message
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 56/211
Universal Interface – Technical Specification 7.00.0xx Page 56 of 211
OCIx Original ACI from the posting message
PGIxPregenerated Random Number
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
PostingResponse2 (Generic):
<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-1114:10:24<US>ACI1=9001201<US>ACT1=P<US>NAM1=JohnMalkovitch<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=JaneMalkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-09-13<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>PostingResponse<US>REF=POS#1<US>RQN=121<US>DTE=1997-09-1114:10:28<US>ACI=9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=135.79<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 57/211
Universal Interface – Technical Specification 7.00.0xx Page 57 of 211
Payment
Payment message type is sent to the FCUI to insert payments to existing FCSPMS accounts.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status RES_STATUS translated to
R/CPOI X(20) Unique Payment ID
n/a – to be provided fromexternal system
POO 9 Payment Type ID optionalDEP_POS_CODE+DEP_POS_TYPE
POV 9.9 Payment Value n/a – to be provided from
external system
INF X(50) Notes optionaln/a – to be provided from
external system
WIN 9 Invoice Window (0,1,2 or 3) optionaln/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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field identifies the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 58/211
Universal Interface – Technical Specification 7.00.0xx Page 58 of 211
ACIEntered by the external system operator (manually or through a magnetic card reader) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)N Name of a person or company account(UXP_A_NAME_N)I Internal identification number (UXP_A_ID)G Group Id number (RES_GRP)E External identification number (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)
M
e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)H Internal Id number(UXP_C_INTERNALID)X Guest Category(GCT_CODE) R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
ACSThe field identifies the account current reservation status. The following status values are accepted:
R ReservationsC Checked-in
POIThe field identifies the unique payment identifier within the whole external system. It used forchecking if payment was not repeated.
POO The field identifies the payment type identifier as per external system. FCSPMS descriptionequivalent to the Payment Type ID will be displayed or printed on a customer invoice. If not presentdefault payment department as assigned to the account or default system payment department willbe used. Foreign currency departments can be used. Credit card departments cannot be used withthe exception when the Payment Type ID is not specified and person default payment is credit card.
POVThe field identifies the actual payment amount. Foreign currency, if used, will be converted to basecurrency as per current exchange rate defined in FCSPMS system. This field can have positive(account is credited) or negative (void) value.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 59/211
Universal Interface – Technical Specification 7.00.0xx Page 59 of 211
INFThe field identifies the additional information send by FCUI.
WINThis field identifies the invoice window to pay, this only applied when POO is not sent and multiplecredit 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-1114: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-1114:10:35<US>ACI=9001201<US>ACE=I<US>ACS=C<US>POI=100105<US>POO=101<US>POV=20.02 <US>INF=External Payment<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 60/211
Universal Interface – Technical Specification 7.00.0xx Page 60 of 211
PaymentResponse
PaymentResponse message type is sent by the FCUI to confirm payment made.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
CABx X(6) Cabin Number optionalRES_CAB
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date RES_DIS_E
BALx 9.9 Balance SYSTEM CALCULATED
CRUx 9.9 Posted Cruise ID optionalPOS_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. Theresponse 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 thatthe payment has been made. Final balance after the payment is applied will be send. No payment isinserted if more than one record is returned. In this case, current balance is returned. Externalsystem 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 61/211
Universal Interface – Technical Specification 7.00.0xx Page 61 of 211
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat 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).
ACTxThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System account
S StaffZ Gift Card
NAMx The field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBx
The field identifies the date and time the account (person) is expected or embarked.
DISxThe 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. Otherwisereturns current balance. This field can return positive (account is to be invoiced) or negative(account prepaid) value.
CRUxThe field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 62/211
Universal Interface – Technical Specification 7.00.0xx Page 62 of 211
POIThe field identifies the unique payment identifier within the whole external system. It used forchecking if payment was not repeated. This message is send from payment message.
PGIxPregenerated Random Number
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>PaymentResponse<US>REF=PAY#1<US>RQN=121<US>DTE= 1997-09-1114:10:24<US>ACI1=9001201<US>ACT1=P<US>NAM1=JohnMalkovitch<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-09-13<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>PaymentResponse<US>REF=PAY#1<US>RQN=121<US>DTE=1997-09-1114:10:28<US>ACI=9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=102.43<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 63/211
Universal Interface – Technical Specification 7.00.0xx Page 63 of 211
Folio
Folio message type is used to request list of postings or payment for a specific account from theFCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 Account ID RES_ACC
PIN X Pin Code optionalRES_PIN_CODE
ACE X(1) Account ID Entry Type optional Refer to ACE type definitionbelow
The message is usually used to display registered postings or payment. The following is adescription of the fields in the message data block.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 is0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined: If this field is not supply it will default to Internal identification number (UXP_A_ID)
P Pre generated Random Number (RES_PGID)
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 64/211
Universal Interface – Technical Specification 7.00.0xx Page 64 of 211
ExampleMessage
<STX>Folio<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:23<US>ACI=9001201<ETX><CHECKSUM>
<STX>Folio<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:23<US>ACI=9001201<US>PIN=1234<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 65/211
Universal Interface – Technical Specification 7.00.0xx Page 65 of 211
FolioResponse
FolioResponse message type is sent by the FCUI to supply the list of postings or paymentscurrently 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 returnedwithout details that are stored on subdepartment level.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 DPosting or Payment Fidelio SystemDate
POS_PDAT ORPOS_MDATE
VDTx 9.9 Debit Amount 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 9 Posting Window POS_WIN
POIx X(20) POS Bill Number POS_MIB_BILL_NO
BIDx 9 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 responsemessage number one is required while all the others are optional. Record number will not be
present if only one record is returned.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 66/211
Universal Interface – Technical Specification 7.00.0xx Page 66 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
DPIxThe field identifies the department number (revenue centre) where the posting was registered.
DPTxThe field identifies the department type. The following department types are defined:
D Debit PostingC Credit PostingP Package Posting
DPNxThe field identifies the full description of the department (revenue centre) where the posting or
payment was registered.
PDTxThe field identifies the posting Fidelio system date.
VDTxThe field identifies the posting value. This field can return positive (charge) or negative (void)values. For payment departments 0 will be returned.
VCTxThe field identifies the payment value. This field can return positive (payment) or negative (void)values. For posting departments 0 will be returned.
CLSxThe field identifies the closed posting Flag. This field can return Yes or No values showing if theposting is closed or not.
NPRx The field identifies the no print Flag. This field can return Yes or No values showing if the posting isto be displayed thru the external system or not.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 67/211
Universal Interface – Technical Specification 7.00.0xx Page 67 of 211
WINx The field identifies the Window (Invoice No.). This field can return 0 to 9 values showing whichWindow (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.
BALFolio Balance
NRBNon Refundable Credit Balance
POIxUnique Posting ID send during Posting Message, for other posting, the value will be undefined
PLMPosting 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.
ExampleMessage
<STX>FolioResponse<US>REF=POS#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>DPI1=100<US>DPT1=D<US>DPN1=Sky Light Bar <US>PDT1=1997-09-1012:34:00<US>VDT1=23.12<US>VCT1=0<US>CLS1=No<US>NPR1=No<US>WIN1=0<US>DPI2=900<US>DPT2=CB<US>DPN2=Cash<US>PDT2=1997-09-1013: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>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 68/211
Universal Interface – Technical Specification 7.00.0xx Page 68 of 211
Excursions
Excursions message type is used to request a list of excursions available from the FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
SDT D Excursions starting date ESE_DATE
EDT D Excursions ending date ESE_DATE
ACI 9 Account ID optionalRES_ACC
The message is usually used to display list of excursions that fall within date starting and endingcriteria. 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
SDTThe 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 obtainedthrough 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
ExampleMessage
<STX>Excursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>SDT=1997-09-12 00:00:00<US>EDT=1997-09-1223:59:59<US>ACI=250046<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 69/211
Universal Interface – Technical Specification 7.00.0xx Page 69 of 211
ExtExcursions
ExtExcursions message type is used to request list of excursions available from the FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
BDT D Excursions Starting Date ESE_DATE
TYP X(1) Code Type optionalRefer to TYP type definition
below
COD X(50) Code optionalRefer to COD field definition
below ACI 9 Account ID optional
RES_ACC
The message is usually used to display list of excursions that fall within date starting or endingcriteria. 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
BDTThe field identifies the date for the excursions can start from.
TYPThe field identifies the type of the code being passed for querying excursions.
P Excursion Port NameN Excursion No (ENO)I Excursion Unique ID (EID)C Excursion Category Code
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 70/211
Universal Interface – Technical Specification 7.00.0xx Page 70 of 211
CODThe code for the excursions to run the query on. It can be either the Port name (ESE_PORT), TheExcursion 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 obtainedthrough 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
ExampleMessage
<STX>ExtExcursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>BDT=1997-09-1200:00:00<US>TYP=P<US>COD=Hamburg<US>ACI=250046<ETX><CHECKSUM>
<STX>ExtExcursions<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>BDT=1997-09-1200: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-1114:10:29<US>BDT=1997-09-1200: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-1114:10:29<US>BDT=1997-09-1200:00:00<US>TYP=C<US>COD=STR<US>ACI=250046<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 71/211
Universal Interface – Technical Specification 7.00.0xx Page 71 of 211
ExcursionsResponse
ExcursionsResponse message type is sent by the FCUI to supply list of excursions that fall withinstarting and ending date or time specified by external system.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
EIDx 9 Excursion ID ESE_ID
ENOx X(10) Excursion Number ESE_NO
NAMx X(50) Excursion Name ESE_NAME
SDTx D Starting Date and Time ESE_DATE +
ESE_FROMTIME
EDTx D Ending Date and Time 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 D Meeting Date and Time optionalESE_DATE +
ESE_MEETTIME
MPLx X(100) Meeting Point optionalESE_MEETPOINT
CTHx X(100) Recommended Clothes optionalESE_CLOTHES
INFx X(200) Notes optionalESE_COMMENT
SIKx X(3)Show in Kiosk [External BookingSystem]
ESE_SHOW_KIOSK
BIKx X(3)Book in Kiosk [External BookingSystem]
ESE_SELL_KIOSK
MAXx 9Maximum Seats or Maximum AdultSeats
ESE_MAXPER /
ESE_MAXPER_ADULT
CURx 9Seats or Adult Seats CurrentlyBooked
SYSTEM CALCULATED
PRTx X(50) Port Name ESE_PORT
CATx X(500)Category Id & Description [Id –Description; Id –Description]
OptionalESE_CATEGORIES +
TYP_EXC.TYP_COMMENT
LANx X(500)Language Id + “-“ + LanguageDescriptionWith “,” as field separator
OptionalESE_LANGUAGES +
TYP_LAN.TYP_COMMENT
SITx X(3)Show in ITV [External BookingSystem]
ESE_SHOW_ITV
BITx X(3)Book in ITV [External BookingSystem]
ESE_SELL_ITV
BCTx X(3) Book Child Ticket in ITV [ExternalBooking System] ESE_SELLCHILD_ITV
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 72/211
Universal Interface – Technical Specification 7.00.0xx Page 72 of 211
Code Type Description RequiredSPMS DB Field reference
CHSx 9 Maximum Childs Seats OptionalEXE_MAXPER_CHILD
CHBx 9 Child Seats Booked OptionalSYSTEM CALCULATED
STCx X(1) Child Booking Status Optional SYSTEM CALCULATED
PAPx 9 Promotion Adult Price OptionalSYSTEM CALCULATED
PAAx 9 Promotion Adult Availability OptionalSYSTEM CALCULATED
PAIx 9 Adult Promotion ID OptionalPRO_ID
PCPx 9 Promotion Child Price OptionalSYSTEM CALCULATED
PCAx 9 Promotion Child Availability OptionalSYSTEM CALCULATED
PCIx 9 Child Promotion ID OptionalPRD_ID
DSCx X(1000) Tour Long Description 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 messagenumber 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
EIDxThe field identifies the unique excursion identifier. This ID can be used for excursion booking. Thefield is an internal, unique excursion number.
ENOx
The field identifies the custom, users entered, number that identifies excursion.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 73/211
Universal Interface – Technical Specification 7.00.0xx Page 73 of 211
NAMxThe field identifies the excursion name (description).
SDTxThe field identifies the excursion starting date and time.
EDTxThe field identifies the excursion ending date and time.
STAxThe field identifies the excursion booking status. If PAR Use Adult/Child Max Counts is enabled, thisis the adult booking status, if the PAR is disabled this is the general booking status.The following status identifiers values are defined:
A AvailableF Fully booked
O
Overbooked
PADxThe field identifies the excursion adult price.
PCHxThe field identifies the excursion child price.
MDTxThe field identifies the excursion participants meeting date and time.
MPLxThe field identifies the excursion participants meeting place.
CTHxThe field identifies the recommended clothes for excursions participants.
INFxThe field identifies the additional information about excursion.
SIKxThe flag to denote if the excursion can be shown on the external system, the field returns ‘Yes’ or‘No’ only.
BIKxThe flag to denote if the excursion can be booked on the external system, the field returns ‘Yes’ or‘No’ only.
MAXxIf PAR Use Adult/Child Max Counts is enabled, this is the maximum adult seats available on theexcursion, if the PAR is disabled this is the total seats available on the excursion.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 74/211
Universal Interface – Technical Specification 7.00.0xx Page 74 of 211
CURxIf PAR Use Adult/Child Max Counts is enabled, this is the adult seats currently booked on theexcursion, if the PAR is disabled this is the total seats booked on the excursion.
PRTxThe field identifies the port for the excursion.
CATxThe field identifies the categories for the excursion.
LANxThe field identifies the Language ID (2 digits) + “-“ + Language Description, + “,” as field separator.In one tour there could be more then 1 language availablee.g. EN – English
DE – GermanThe field will be “EN-English,DE-German”
SIKxThe flag to denote if the excursion can be shown on ITV the external system, the field returns ‘Yes’or ‘No’ only.
BITxThe flag to denote if the excursion can be booked on the ITV external system, the field returns ‘Yes’or ‘No’ only.
BCTxThe flag to denote if the excursion child ticket can be booked on the ITV external system, the fieldreturns ‘Yes’ or ‘No’ only.
PAPxThis is the adult promotion price, this field will be exists when the availability more then zero.
PAAxThis is the number of seats available for adult promotion price.
PAIxThis is the adult promotion id, it can be use during Booking. Please refer to PROx in Bookingmessage type for more details. In the even the adult promotion id is different from child promotionid. You must sent two separate booking message (1 for adult, 1 for child) in order to get thepromotion price.
PCPxThis is the child promotion price, this field will be exists when the availability more then zero.
PCAxThis is the number of seats available for child promotion price.
PCIxThis is the child promotion id, it can be use during Booking. Please refer to PROx in Bookingmessage type for more details. In the even the adult promotion id is different from child promotionid. You must sent two separate booking message (1 for adult, 1 for child) in order to get thepromotion price.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 75/211
Universal Interface – Technical Specification 7.00.0xx Page 75 of 211
CHSxThe field identifies the maximum child seats available on the excursion. This field only exists whenPAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
CHBxThe field identifies the child seats currently booked on the excursion. This field only exists whenPAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
STCxThe field identifies the excursion booking status. If PAR Use Adult/Child Max Counts is enabled, thisis the child booking status, if the PAR is disabled this field will not exists.The following status identifiers values are defined:
A AvailableF Fully bookedO Overbooked
DSCxTour long Description intended for ITV usage.
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>ExcursionsResponse<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:31<US>EID1=12<US>ENO1=2<US>NAM1=Dining with crocodiles<US>SDT1=1997-09-
12 17:30:00<US>EDT1=1997-09-1220:30:00<US>STA1=A<US>PAD1=12.10<US>PCH1=10<US>MDT1=1997-09-1216:30:00<US>MPL1=Deck A<US>CTH1=Casual<US>INF1=Keepwarm<US>SIK1=Yes<US>BIK1=Yes<US>MAX1=200<US>CUR1=75<US>PRT1=Nice<US>CAT1=STR-Strenous<US>LAN1=EN-English<US>SIT1=Yes<US>BIT1=Yes<US>CHS1=100<US>CHB1=50<US>STC1=A<US>DSC1=Testing1<US>EID2=13<US>ENO2=4<US>NAM2=Dining on Sundeck<US>SDT2=1997-09-12 17:45:00<US>EDT2=1997-09-1220:30:00<US>STA2=F<US>PAD2=12.00<US>PCH2=9.10<US>MDT2=1997-09-1216:30:00<US>MPL2=Deck A<US>CTH2=Casual<US>INF2=Keepwarm<US>SIK2=Yes<US>BIK2=No<US>MAX2=150<US>CUR2=125<US>PRT2=Nice<US>CAT2=AD-All Day;LI-Lunch Included<US>LAN2=EN-English<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>DSC2=Testing2<ETX><CHECKSUM>
<STX>ExcursionsResponse<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:31<US>EID=12<US>ENO=2<US>NAM=Dining with crocodiles<US>SDT=1997-09-1217:30:00<US>EDT=1997-09-1220:30:00<US>STA=A<US>PAD=12.10<US>PCH=10<US>MDT=1997-09-1216: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-LunchIncluded<US>LAN=EN-English<US>SIT=Yes<US>CHS1=100<US>CHB1=50<US>STC1=A<US>DSC=Testing<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 76/211
Universal Interface – Technical Specification 7.00.0xx Page 76 of 211
Booking
Booking message type is sent to the FCUI to insert excursion booking and post excursion charge.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status RES_STATUS translated to
R/CBOI X(30) Unique Excursion Booking ID
n/a – to be provided fromexternal system
EIDx 9 Excursion ID ESE_ID
QADx 9 Number of Adult Tickets n/a – to be provided from
external system
QCHx 9 Number of Child Tickets n/a – to be provided from
external system
PROx 9 Promotion ID optionalPRO_ID
LANx X(2) Language ID optionalESE_LANGUAGES
INF X(50) Notes optional n/a – to be provided fromexternal system
PIN X PIN Code optionalRES_PIN_CODE
SRC X(100) Booking Source optionaln/a – to be provided from
external system
FLG XY-Allow posting even the guest hasreached his credit limit or posting isdisable, N-Normal posting
optionaln/a – to be provided from
external system
PATx 9 Participant Account ID optionalRES_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 wayFCSPMS 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 77/211
Universal Interface – Technical Specification 7.00.0xx Page 77 of 211
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)N Name of a person or company account (UXP_A_NAME_N)I Internal identification number (UXP_A_ID)
G Group Id number (RES_GRP)E External identification number (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)M e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)H Internal Id number (UXP_C_INTERNALID)X Guest Category (GCT_CODE) R RFID UID (RFID_ID)
F Loyalty Number (UXP_A_FRQ_CARDNO)
P Pre generated Random Number (RES_PGID)
ACSThe field identifies the account current reservation status. The following status values are accepted:
R ReservationsC Checked-in
BOIThe field identifies the booking (check) unique within the whole external system. The field is used asa cross-reference to obtain detailed information about all the transactions recorded on a booking.
EIDxThe 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, uniqueexcursion number.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 78/211
Universal Interface – Technical Specification 7.00.0xx Page 78 of 211
QADxThe field identifies the number of adult priced tickets to book.
QCHxThe field identifies the number of child priced tickets to book.
PROxThe field identified the promotion id, if this field is ignore, the guest will still entitle for promotion priceif available else normal price will be apply. If promotion id is sent and promotion price no longeravailable, 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 sendBooking done with 1 seat at promotion price and 1 seat at normal price.
LANxThe field identifies the language id of the tour.
INFThe field identifies the additional information send by FCUI.
PINThe field identifies the telephone PIN code of the reservation account. The valid character is0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
SRCThe field identifies the source of the booking. Eg: Workstation Id, Kiosk Id, etc. or any other detailsdescribing 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 tocheck-in guest only), N-Normal posting
PATxThis is the account id for the participant, if other than the buyer. All posting will be posted to thebuyer account regard of the participant, all ticket printed will show the name of the participant.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 79/211
Universal Interface – Technical Specification 7.00.0xx Page 79 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>Booking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-1114: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=VIPTickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<US>PAT=2411872<ETX><CHECKSUM>
<STX>Booking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-1114: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>QAD1=1<US>QCH1=0<US>PRO1=1<US>LAN1=EN <US>INF=VIPTickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 80/211
Universal Interface – Technical Specification 7.00.0xx Page 80 of 211
BookingResponse
BookingResponse message type is sent by the FCUI to confirm posting made.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
CABx X(6) Cabin Number optionalRES_CAB
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date RES_DIS_E
BALx 9.9 Balance SYSTEM CALCULATED
CRUx 9.9 Posted Cruise ID optionalPOS_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. Theresponse message number one is required while all the others are optional. Record number will notbe present if only one record is returned. If one record is returned it serves as a confirmation thatthe booking has been made. Final balance after the excursion posting is applied will be send. Nobooking 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 81/211
Universal Interface – Technical Specification 7.00.0xx Page 81 of 211
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIxThe 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).
ACTxThe field describes the account type. The following account types are defined:
P Passenger (Guest)
R
Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
NAMx The field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBxThe field identifies the date and time the account (person) is expected or embarked.
DISxThe 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.
CRUxThe field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 82/211
Universal Interface – Technical Specification 7.00.0xx Page 82 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>BookingResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-1114: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=JaneMalkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-09-13<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>BookingResponse<US>REF=TV#1<US>RQN= 1218<US>DTE=1997-09-1114:10:59<US>ACI=9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=145.79<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 83/211
Universal Interface – Technical Specification 7.00.0xx Page 83 of 211
ExcPackage
Excursions message type is used to request a list of excursions available from the FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
SDT D Package starting date optionaln/a – to be provided from
external system
EDT D Package ending date optional n/a – to be provided from
external system
The message is usually used to display list of excursions package that fall within date starting andending criteria. The following is a description of the fields in the message data block. One packageusually contain more than 1 excursion, all tours within the package must fall within the start dateand 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
SDTThe field identifies the minimum date the excursions can start from. If ignore it will return thepackage belong to current cruise.
EDT The field identifies the maximum date the excursions must be completed. If ignore it will return thepackage belong to current cruise.
ExampleMessage
<STX>ExcPackage<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>SDT=2007-08-12 00:00:00<US>EDT=2007-08-22 23:59:59<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 84/211
Universal Interface – Technical Specification 7.00.0xx Page 84 of 211
ExcPackageResponse
ExcursionsResponse message type is sent by the FCUI to supply list of excursions that fall withinstarting and ending date or time specified by external system.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
PIDx 9 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)Show in Kiosk [External BookingSystem]
ESE_SHOW_KIOSK
BIKx X(3)Book in Kiosk [External BookingSystem]
ESE_SELL_KIOSK
MAXx 9Maximum Package or Maximum AdultPackage
ESE_MAXPER /
ESE_MAXPER_ADULT
CURx 9Package or Adult package Currently
Booked
SYSTEM CALCULATED
STAx X(1) Booking or Adult Booking Status SYSTEM CALCULATED
AVAx 9 Package or Adult package available SYSTEM CALCULATED
CHSx 9 Maximum Childs Seats OptionalESE_MAXPER_CHILD
CHBx 9 Child Seats Booked OptionalSYSTEM CALCULATED
STCx X(1) Child Booking Status OptionalSYSTEM CALCULATED
AVCx 9 Child Package Available OptionalSYSTEM CALCULATED
PAPx 9 Promotion Adult Price OptionalSYSTEM CALCULATED
PAAx 9 Promotion Adult Availability OptionalSYSTEM CALCULATED
PAIx 9 Adult Promotion ID OptionalPRO_ID
PCPx 9 Promotion Child Price OptionalSYSTEM CALCULATED
PCAx 9 Promotion Child Availability OptionalSYSTEM CALCULATED
PCIx 9 Child Promotion ID OptionalPRO_ID
EIDx 9 Excursion ID ESE_ID
ENOx X(10) Excursion Number ESE_NO
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 85/211
Universal Interface – Technical Specification 7.00.0xx Page 85 of 211
Code Type Description RequiredSPMS DB Field reference
NAMx X(50) Excursion Name ESE_NAME
SDTx D Starting Date and Time ESE_DATE +
ESE_FROMTIME
EDTx D Ending Date and Time ESE_DATE + ESE_TOTIME
MDTx D Meeting Date and Time optionalESE_DATE +
ESE_MEETTIME
MPLx X(100) Meeting Point optionalESE_MEETPOINT
CTHx X(100) Recommended Clothes optionalESE_CLOTHES
INFx X(200) Notes optionalESE_COMMENT
PRTx X(50) Port Name ESE_PORT
CATx X(500)Category Id & Description [Id –Description; Id –Description]
OptionalESE_CATEGORIES +
TYP_EXC.TYP_COMMENT
LANx X(500)Language Id + “-“ + LanguageDescriptionWith “,” as field separator
OptionalESE_LANGUAGES +
TYP_LAN.TYP_COMMENT
DSCx X(1000) Tour Long Description 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 messagenumber one is required while all the others are optional. Record number will not be present if onlyone record is returned. In general each package should have more than 1 tour associate withit. E.g. If one package have 3 tours, there will be 3 records return, all 3 records will have thesame 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 messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 86/211
Universal Interface – Technical Specification 7.00.0xx Page 86 of 211
PIDxThe field identifies the unique package identifier. This ID can be used for package booking. The fieldis an internal, unique excursion number.
PNOxThe field identifies the custom, users entered, number that identifies package.
PNAxThe field identifies the package name (description).
PADxThe field identifies the package adult price.
PCHxThe field identifies the package child price.
SIKxThe flag to denote if the excursion can be shown on the external system, the field returns ‘Yes’ or‘No’ only.
BIKxThe flag to denote if the excursion can be booked on the external system, the field returns ‘Yes’ or‘No’ only.
MAXxIf PAR Use Adult/Child Max Counts is enabled, this is the maximum adult package available, if thePAR is disabled this is the total package available.
CURxIf PAR Use Adult/Child Max Counts is enabled, this is the adult package currently booked, if thePAR is disabled this is the total package booked.
STAxThe field identifies the package booking status. If PAR Use Adult/Child Max Counts is enabled, thisis the adult booking status, if the PAR is disabled this is the general booking status.The following status identifiers values are defined:
A AvailableF Fully bookedO Overbooked
AVAxThe field identifies the package available count. Because the each tour can be sell independentlyfrom the package, we cannot use the Total Package – Total Book to get the total available. If PARUse Adult/Child Max Counts is enabled, this is the adult available count, if the PAR is disabled thisis the general available count.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 87/211
Universal Interface – Technical Specification 7.00.0xx Page 87 of 211
CHSxThe field identifies the maximum child package available. This field only exists when PAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
CHBxThe field identifies the child package currently booked on the excursion. This field only exists whenPAR Use Adult/Child Max Counts is enabled in Fidelio Cruise.
STCxThe field identifies the package booking status. If PAR Use Adult/Child Max Counts is enabled, thisis the child booking status, if the PAR is disabled this field will not exists.The following status identifiers values are defined:
A AvailableF Fully bookedO Overbooked
AVAxThe field identifies the package available count. Because the each tour can be sell independentlyfrom the package, we cannot use the Total Package – Total Book to get the total available. If PARUse Adult/Child Max Counts is enabled, this is the child available count, if the PAR is disabled thisfield will not exists.
PAPxThis 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.
PAIxThis is the adult promotion id, it can be use during Booking. Please refer to PROx in Bookingmessage type for more details. In the even the adult promotion id is different from child promotionid. You must sent two separate booking message (1 for adult, 1 for child) in order to get thepromotion price.
PCPxThis 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.
PCIxThis is the child promotion id, it can be use during Booking. Please refer to PROx in Bookingmessage type for more details. In the even the adult promotion id is different from child promotionid. You must sent two separate booking message (1 for adult, 1 for child) in order to get thepromotion price.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 88/211
Universal Interface – Technical Specification 7.00.0xx Page 88 of 211
EIDxThe field identifies the unique excursion identifier. The field is an internal, unique excursion number.
ENOxThe field identifies the custom, users entered, number that identifies excursion.
NAMxThe field identifies the excursion name (description).
SDTxThe field identifies the excursion starting date and time.
EDTxThe field identifies the excursion ending date and time.
MDTx
The field identifies the excursion participants meeting date and time.
MPLxThe field identifies the excursion participants meeting place.
CTHxThe field identifies the recommended clothes for excursions participants.
INFxThe field identifies the additional information about excursion.
PRTx
The field identifies the port for the excursion.
CATxThe field identifies the categories for the excursion.
LANxThe field identifies the Language ID (2 digits) + “-“ + Language Description, + “,” as field separator.In one tour there could be more than 1 language availablee.g. EN – English
DE – GermanThe field will be “EN-English,DE-German”
DSCxTour long Description intended for ITV usage.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 89/211
Universal Interface – Technical Specification 7.00.0xx Page 89 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>ExcPackageResponse<US>REF=TV#1<US>RQN=121<US>DTE=2007-08-1514:10:31<US>PID1=1<US>PNO1=001<US>PNM1=City TourPackage<US>PAD1=12.10<US>PCH1=10<US>SIK1=Yes<US>BIK1=Yes<US>MAX1=200<US>CUR1=75<US>STA1=A<US>AVA1=A<US>CHS1=100<US>CHB1=50<US>STC1=A<US>AVC1=A<US>PAP1=10.00<US>PAA1=1<US>PAI1=123<US>PCP1=8.00<US>PCA1=1<US>PCI1=12<US>EID1=12<US>ENO1=2<US>NAM1=Dining with crocodiles<US>SDT1=1997-09-1217: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=STR-Strenous<US>LAN1=EN-English<US>DSC1=Testing1<US> PID2=1<US>PNO2=001<US>PNM2=City TourPackage<US>PAD2=12.10<US>PCH2=10<US>SIK2=Yes<US>BIK2=Yes<US>MAX2=200<US>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>PCI2=12<US>EID2=13<US>ENO2=4<US>NAM2=Dining on Sundeck<US>SDT2=1997-09-1217:45:00<US>EDT2=1997-09-1220:30:00<US>STA2=F<US>PAD2=12.00<US>PCH2=9.10<US>MDT2=1997-09-1216:30:00<US>MPL2=Deck A<US>CTH2=Casual<US>INF2=Keepwarm<US>SIK2=Yes<US>BIK2=No<US>MAX2=150<US>CUR2=125<US>PRT2=Nice<US>CAT2=AD-All Day;LI-Lunch Included<US>LAN2=EN-English<US>DSC2=Testing2<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 90/211
Universal Interface – Technical Specification 7.00.0xx Page 90 of 211
BookingPackage
Booking message type is sent to the FCUI to insert excursion booking and post excursion charge.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status RES_STATUS translated to
R/CBOI X(30) Unique Package Booking ID
n/a – to be provided fromexternal system
PIDx 9 Package ID ESP_ID
QADx 9 Number of Adult Tickets n/a – to be provided from
external system
QCHx 9 Number of Child Tickets n/a – to be provided from
external system
PROx 9 Promotion ID optionalPRO_ID
LANx X(2) Language ID optionalESE_LANGUAGES
INF X(50) Notes optional n/a – to be provided fromexternal system
PIN X PIN Code optionalRES_PIN_CODE
SRC X(100) Booking Source optionaln/a – to be provided from
external system
FLG XY-Allow posting even the guest hasreached his credit limit or posting isdisable, N-Normal posting
optionaln/a – to be provided from
external system
PATx 9 Participant Account ID optionalRES_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 wayFCSPMS 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 91/211
Universal Interface – Technical Specification 7.00.0xx Page 91 of 211
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)N Name of a person or company account(UXP_A_NAME_N)I Internal identification number (UXP_A_ID)
G Group Id number (RES_GRP)E External identification number (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)M e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)H Internal Id number(UXP_C_INTERNALID)X Guest Category(GCT_CODE) R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
ACS
The field identifies the account current reservation status. The following status values are accepted:
R ReservationsC Checked-in
BOIThe field identifies the booking (check) unique within the whole external system. The field is used asa cross-reference to obtain detailed information about all the transactions recorded on a booking.
PIDx
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 92/211
Universal Interface – Technical Specification 7.00.0xx Page 92 of 211
The field identifies the unique package identification number. The ID cannot repeat within onemessage. This ID can be obtained through e.g. Excursions message. The field is an internal, uniquepackage number.
QADxThe field identifies the number of adult priced tickets to book.
QCHxThe field identifies the number of child priced tickets to book.
PROxThe field identified the promotion id, if this field is ignore, the guest will still entitle for promotion priceif available else normal price will be apply. If promotion id is sent and promotion price no longeravailable, 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 sendBooking done with 1 seat at promotion price and 1 seat at normal price.
LANxThe field identifies the language id of the tour.
INFThe field identifies the additional information send by FCUI.
PINThe field identifies the telephone PIN code of the reservation account. The valid character is0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
SRCThe field identifies the source of the booking. Eg: Workstation Id, Kiosk Id, etc. or any other detailsdescribing 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 tocheck-in guest only), N-Normal posting
PATxThis is the account id for the participant, if other than the buyer. All posting will be posted to thebuyer account regard of the participant, all ticket printed will show the name of the participant.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 93/211
Universal Interface – Technical Specification 7.00.0xx Page 93 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>BookingPackage<US>REF=TV#1<US>RQN=1214<US>DTE=2007-08-154: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=VIPTickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<US>PAT=2411872<ETX><CHECKSUM>
<STX>BookingPackage<US>REF=TV#1<US>RQN=1214<US>DTE=2007-08-1514: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>QAD1=1<US>QCH1=0<US>PRO1=1<US>LAN1=EN <US>INF=VIPTickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 94/211
Universal Interface – Technical Specification 7.00.0xx Page 94 of 211
BookingPackageResponse
BookingResponse message type is sent by the FCUI to confirm posting made.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
CABx X(6) Cabin Number optionalRES_CAB
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date RES_DIS_E
BALx 9.9 Balance SYSTEM CALCULATED
CRUx 9.9 Posted Cruise ID optionalPOS_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. Theresponse message number one is required while all the others are optional. Record number will notbe present if only one record is returned. If one record is returned it serves as a confirmation thatthe booking has been made. Final balance after the excursion posting is applied will be send. Nobooking 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 95/211
Universal Interface – Technical Specification 7.00.0xx Page 95 of 211
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIxThe 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).
ACTxThe field describes the account type. The following account types are defined:
P Passenger (Guest)
R
Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
NAMx The field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBxThe field identifies the date and time the account (person) is expected or embarked.
DISxThe 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.
CRUxThe field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 96/211
Universal Interface – Technical Specification 7.00.0xx Page 96 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>BookingResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-1114: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=JaneMalkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-09-13<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>BookingResponse<US>REF=TV#1<US>RQN= 1218<US>DTE=1997-09-1114:10:59<US>ACI=9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=145.79<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 97/211
Universal Interface – Technical Specification 7.00.0xx Page 97 of 211
ExcFolio
ExcFolio message type is used to request list of excursions booked on a specific account inFCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe 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 doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 obtainedthrough e.g. Inquire message. The field is an internal, unique account (person) number (I type).
ExampleMessage
<STX>ExcFolio<US>REF=TV#1<US>RQN=1209<US>DTE=1997-09-1114:10:23<US>ACI=9001201<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 98/211
Universal Interface – Technical Specification 7.00.0xx Page 98 of 211
ExcFolioResponse
ExcFolioResponse message type is sent by the FCUI to supply the list of excursions currentlybooked for the account specified by an external system. The message returns the same list of
excursions that are visible through FCSPMS system.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
EIDx 9 Excursion ID ESE_ID
ENOx X(10) Excursion Number ESE_NO
NAMx X(50) Excursion Name ESE_NAME
SDTx D Starting Date and Time ESE_DATE +
ESE_FROMTIME
EDTx D Ending Date and Time ESE_DATE + ESE_TOTIME
STAx X(1) Excursion Status SYSTEM CALCULATED
BDTx D Booking Date and Time EPO_PDAT
BOQx 9 Number of Tickets Booked EPO_QUANT
BOVx 9.9 Booking Value SYSTEM CALCULATED
MDTx D Meeting Date and Time optionalESE_DATE +
ESE_MEETTIME
MPLx X(100) Meeting Point optionalESE_MEETPOINT
CTHx X(100) Recommended Clothes optionalESE_CLOTHES
INFx X(200) Notes optionalESE_COMMENT
TAGx X(1) TAG optionalEPO_PRICE_TAG
PCNx 9 Ticket Printed Count EPO_TICKET_PRINTED
PPEx X(3) Prepaid Status flag EPO_PREPAID
The message can return one or more records of the data to satisfy inquiry criteria. The responsemessage number one is required while all the others are optional. Record number will not bepresent if only one record is returned. The following is a description of the fields in the messagedata block.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 99/211
Universal Interface – Technical Specification 7.00.0xx Page 99 of 211
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 withitems retrieved through Excursions message. The field is an internal, unique excursion number.
ENOxThe field identifies the custom, users entered, number that identifies excursion.
NAMxThe field identifies the excursion name (description).
SDTxThe field identifies the excursion starting date and time.
EDTxThe field identifies the excursion ending date and time.
STAxThe field identifies the excursion booking status. The following status identifiers values are defined:
A AvailableF Fully BookedO Overbooked
BDTx
The field identifies the excursion booking date and time (real date and time).
BOQxThe field identifies the number of tickets booked.
BOVxThe field identifies the total value of the bookings for the returned excursions.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 100/211
Universal Interface – Technical Specification 7.00.0xx Page 100 of 211
MDTxThe field identifies the excursion participants meeting date and time.
MPLxThe field identifies the excursion participants meeting place.
CTHxThe field identifies the recommended clothes for excursions participants.
INFxThe field identifies the additional information about excursion.
TAGxThe field identifies the adult or children indicator.
A Adult
C
Children
PCNxThe field identifies how many times the tickets had been printed.
PPExThe 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.
ExampleMessage
<STX>ExcFolioResponse<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:11:12<US>EID=12<US>ENO=2<US>NAM=Dining with crocodiles<US>SDT=1997-09-1217:30:00<US>EDT=1997-09-12 20:30:00<US>STA=A<US>BDT=1997-09-1312: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><CHECKSUM>
<STX>ExcFolioResponse<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114: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-1312: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=Keepwarm<US>TAG1=A<US>PCN1=1<US>EID2=12<US>ENO2=2<US>NAM2=Dining withcrocodiles<US>SDT2=1997-09-12 17:30:00<US>EDT2=1997-09-1220:30:00<US>STA2=A<US>BDT2=1997-09-1312: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>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 101/211
Universal Interface – Technical Specification 7.00.0xx Page 101 of 211
Call
Call message type is sent to the FCUI to insert phone call charges.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
COI X(30) Unique Call ID n/a – to be provided from
external systemPOV 9.9 Call Posting Value
n/a – to be provided fromexternal system
NUM X(30) Dialed Number optionaln/a – to be provided from
external system
BEG D Call Start Date and Time optionaln/a – to be provided from
external system
DUR 9 Call Duration optionaln/a – to be provided from
external system
TYP X(2) Call Type optionaln/a – to be provided from
external system
INF X(50) Notes optionaln/a – to be provided from
external system
FLG XY-Allow posting even the guest hasreached his credit limit or posting isdisable, N-Normal posting
optionaln/a – to be provided from
external system
The message is usually accepted due to phone call nature. There are only few error commands thatcan be returned to PBX system. All those errors would indicate major set-up problem and must beresolved during installation. When more than one account is found (when using cabin number, trunknumber 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 102/211
Universal Interface – Technical Specification 7.00.0xx Page 102 of 211
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIIdentifier received from external system. Generally contains any information necessary to identify anaccount the postings should be inserted into. The field can be account number, card number, cabinnumber, trunk number, personal pin code number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account. (RES_CAB/UXP_A_SYS_ACC)
I
Internal identification number (FCSPMS account ID) (UXP_A_ID)E External identification number (e.g. reservation number) (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)
H Internal Id number (UXP_C_INTERNALID)
R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
COIThe field identifies the unique bill (check) within the whole external system. It used to link phonecalls recorded in FCSPMS system with entries stored in the PBX.
POV The field identifies the actual call value total being posted.
NUMThe field identifies the phone number called.
BEGThe field identifies the date and time when the phone call started. Full date and time format isrequired.
DURThe field identifies the phone call duration in seconds.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 103/211
Universal Interface – Technical Specification 7.00.0xx Page 103 of 211
TYPThe field identifies the phone call type. The following types are defined:
VL Line Voice CallVC Cellular Voice CallVS Satellite Voice CallVN Non chargeable Voice CallFL Line FaxFC Cellular FaxFS Satellite FaxFN Non chargeable FaxDL Line Data CallDC Cellular Data CallDS Satellite Data CallDN Non chargeable Data Call
INFThe 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 tocheck-in guest only), N-Normal posting
ExampleMessage
<STX>Call<US>REF=PBX#1<US>RQN=121<US>DTE=1997-09-1114: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-1114:03:32<US>DUR=234<US>TYP=VC<US>INF=Long Distance Call<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 104/211
Universal Interface – Technical Specification 7.00.0xx Page 104 of 211
CallResponse
CallResponse message type is sent by the FCUI to confirm call posting made.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
CAB X(6) Cabin Number optionalRES_CAB
EMB D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DIS D Disembarkation Date
RES_DIS_E for expected &checked in accounts,
RES_DIS_A for checked outaccounts
BAL 9.9 Balance (UXP_A_POS_DEBIT –UXP_A_POS_CREDIT)
CRU 9.9 Posted Cruise ID optional POS_CRUISE
CallResponse message serves as a confirmation that the call posting has been made. Final balanceafter the payment is applied will be send. Most PBX systems will simply ignore the message. Thefollowing 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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).
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 105/211
Universal Interface – Technical Specification 7.00.0xx Page 105 of 211
ACTThis field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
NAMThis field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
CABThis field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBThis field identifies the date and time the account (person) embarked.
DISThis field identifies the date and time the account (person) is expected to disembark.
BALThis 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.
CRUThis field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
ExampleMessage
<STX>CallResponse<US>REF=PBX#1<US>RQN=121<US>DTE=1997-09-1114:10:24<US>ACI= 9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=145.56<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 106/211
Universal Interface – Technical Specification 7.00.0xx Page 106 of 211
CabinStatus
CabinStatus message type is used to request cabin status change in FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
CAB D 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 thecabin’s 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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.
STAThe field identifies the type of the status code being passed for change.
VC Vacant CleanVD Vacant DirtyOC Occupied CleanOD Occupied DirtyPU Pickup RequireFA Verified FailedVF Verified
Example
Message <STX>CabinStatus<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>CAB=2001<US>STA=OC<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 107/211
Universal Interface – Technical Specification 7.00.0xx Page 107 of 211
PhoneCheckIn
PhoneCheckIn message type is sent from FCUI to PBX system to open (unblock) phone lines.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided by
system
RQN 9 Sender Request Number n/a – to be provided by
system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
LANx X(2) Person Language UXP_H_LANG
TYPx X(1) Call Types Allowed Refer to PAR value for PAR-
Interfaces – “Call Types Allowed”
NUMx 9 Phone Line Number CAB_TEL/CAB_TEL2
PINx X PIN Code optionalRES_PIN_CODE
AKYx X(4) Authorization Key optionalRefer to PAR Value for PAR-Interfaces-“AuthKey Criteria”
FSTx X(40) First Name 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 RES_SHOREID(refer to
Group)
CSWx X(100) Cabin Steward Name RES_ACC (linked to
CAB_KEEPER)
CHGx X(1)
Y – Indicate this message is sentduring data change eventN-Indicate this is the message sendduring check-in/cabin move
optional
No db field link, only existsduring data change event
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date
RES_DIS_E for expected &checked in accounts,
RES_DIS_A for checked outaccounts
VGDx X(50) Unique Guest ID RES_V_GUESTID
NATx X(6) Passport Nationality UXP_H_PASSPI_COUNTRY
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 108/211
Universal Interface – Technical Specification 7.00.0xx Page 108 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 wayFCSPMS can open multiple phone lines for a person being checked-in. Record number will not bepresent if only one record is send. The message will be send each time a new person is checked-into the cabin with the phone line number specified. PBX system must be able to either supportmultiple number of people assigned to one or more phone numbers or ignore any new assignment ifphone 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 messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 aperson that is checking-in.
ACTxThis field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew member
G
GroupV VisitorA System accountS StaffZ Gift Card
NAMxThe field identifies the salutation, forename and surname fields (separated with space) of a personthat is being checked-in.
LANxThe field identifies the language of a person that is being checked-in. ISO 2 letter language
identifiers are used.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 109/211
Universal Interface – Technical Specification 7.00.0xx Page 109 of 211
TYPxThe field identifies the call types that can be made from the number. Some types require that aperson swipes credit or onboard card first before the phone call can be made - this applies to sometypes of phone calls only.
B Block (No phone calls allowed)I Internal (Local) OnlyL Long Distance and Internal OnlyA International, Long Distance and InternalD Long Distance (requiring card swipe) and Internal OnlyW International and Long Distance (require card swipe) and Internal
PINxThe field identifies the PIN number that a person must key-in before phone call is started. Pin codeis generated by FCSPMS application but validation of the pin code when a person wants to make aphone call is handles by PBX system. The valid character is 0,1,2,3,4,5,6,7,8,9. Leading zerosupport depend on Fidelio Parameter setting.
NUMxThe field identifies the phone line to be opened. Small x denotes fact that the field can be repeatedwithin <DATA> block which means that multiple phone lines can be open for the person beingchecked-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
VGDxThe field identifies the unique guest id.
NATxThe field identifies the guest passport nationality
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>PhoneCheckIn<US>REF=FCUI#1<US>RQN=121<US>DTE= 2001-09-1114:10:32<US>ACI=1234<US>ACT=P<US>NAM=JohnMalkovitch<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-1114:10:38<US>ACI=4534<US>ACT=P <US>NAM=WolfgangSchmidt<US>LAN=DE<US>TYP=L<US>PIN=21334<US>NUM1=0125<US>NUM2=0126<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 110/211
Universal Interface – Technical Specification 7.00.0xx Page 110 of 211
PhoneCheckOut
PhoneCheckOut message type is sent from FCUI to PBX system to close (block) phone lines.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID RES_ACC
LST X(1)Last Person Assigned to PhoneNumber
SYSTEM CALCULATED
NUMx 9 Phone Line Number CAB_TEL/CAB_TEL2
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 sendeach time a person is checked-out from a cabin with the phone line number specified. PBX systemmust be able to either support multiple phone number check-outs or ignore all check-outs until thelast person is checked-out from the cabin. Parameter LST is used to determine if the last person ischecking-out from the cabin. PBX should also remove all pending wake-up calls, messages etc. thatare linked to the specified person or phone number. The following is a description of the fields in themessage data block.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage 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 beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 111/211
Universal Interface – Technical Specification 7.00.0xx Page 111 of 211
ACI The field identifies the unique account (person) identifier. It can be used to uniquely identify aperson that is checking-out.
LSTBoolean value identifying if the last person assigned to the phone number or cabin is checking-out.
Y The last person assigned to the phone number/cabin is checking-outN There are still people assigned to the phone number/cabin
NUMxThe field identifies the phone lines to be closed. Small x denotes fact that the field can be repeatedwithin <DATA> block which means that multiple phone lines can be closed for the person beingchecked-out.
PGIPregenerated Random Number
VGDxThe field identifies the unique guest id.
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>PhoneCheckOut<US>REF=FCUI#1<US>RQN= 1218<US>DTE=2001-09-
1114:18:32<US>ACI=1234<US>LST=N<US>NUM=0123 <ETX><CHECKSUM>
<STX>PhoneCheckOut<US>REF=FCUI#1<US>RQN=1229<US>DTE=2001-09-1114:19:38<US>ACI=4534<US>LST=Y<US>NUM1=0125<US>NUM2=0126<US>PGI=12345678 <ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 112/211
Universal Interface – Technical Specification 7.00.0xx Page 112 of 211
PhoneCabinMove
PhoneCabinMove message type is sent by the FCUI to supply the information to the externalsystem about a Change of Cabin. The Phone System has to respond with an Acknowledge
message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 UXP_A_SALUT,UXP_A_FSTN,UXP_A_NAME
LAN X(2) Person Language UXP_H_LAN
TYP X(1) Call Types Allowed Refer to PAR value for PAR-
Interfaces – “Call Types Allowed”
NUMx 9 Phone Line Number CAB_TEL/CAB_TEL2
PIN X PIN Code optionalRES_PIN_CODE
AKY X(4) Authorization Key optionalRefer to PAR Value for PAR-Interfaces-“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 RES_SHOREID(refer to
Group)
CSW X(100) Cabin Steward Name RES_ACC (linked to
CAB_KEEPER)
VGDx X(50) Unique Guest ID 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 thewhole 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 113/211
Universal Interface – Technical Specification 7.00.0xx Page 113 of 211
FCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
ACTThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
OCNThe field identifies the Old Cabin No.
NCNThe field identifies the New Cabin No.
NAMThe field identifies the salutation, forename and surname fields (separated with space) of a personthat is being checked-in.
LANThe field identifies the language of a person that is being checked-in. ISO 2 letter languageidentifiers are used.
TYPThe field identifies the call types that can be made from the number. Some types require that aperson swipes credit or onboard card first before the phone call can be made - this applies to sometypes of phone calls only.
B Block (No phone calls allowed)I Internal (Local) OnlyL Long Distance and Internal OnlyA International, Long Distance and InternalD Long Distance (requiring card swipe) and Internal OnlyW International and Long Distance (require card swipe) and Internal
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 114/211
Universal Interface – Technical Specification 7.00.0xx Page 114 of 211
PINThe field identifies the PIN number that a person must key-in before phone call is started. Pin codeis generated by FCSPMS application but validation of the pin code when a person wants to make aphone call is handles by PBX system. The valid character is 0,1,2,3,4,5,6,7,8,9. Leading zerosupport depend on Fidelio Parameter setting.
NUMxThe field identifies the phone line to be opened. Small x denotes fact that the field can be repeatedwithin <DATA> block which means that multiple phone lines can be open for the person beingchecked-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
VGDxThe field identifies the unique guest id.
ExampleMessage
<STX>PhoneCabinMove<US>REF=FCUI#1<US>RQN= 121<US>DTE=1997-09-1114:10:24<US>ACI=9001201<US>ACT=P<US>OCN=0123<US>NCN=10000<US>NAM=MRTESTPAX0005<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>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 115/211
Universal Interface – Technical Specification 7.00.0xx Page 115 of 211
PhoneResponse
PhoneResponse message type is sent by PBX to confirm any Phone command received fromFCUI was successfully executed.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 Phonecommand.
ExampleMessage
<STX>PhoneResponse<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-1114:10:32<US>ACI=1234<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 116/211
Universal Interface – Technical Specification 7.00.0xx Page 116 of 211
EnablePhone
EnablePhone message type is sent from FCUI to PBX system to open (unblock) phone lines.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided by
system
RQN 9 Sender Request Number n/a – to be provided by
system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
LAN X(2) Person Language UXP_H_LAN
TYP X(1) Call Types Allowed Refer to PAR value for PAR-
Interfaces – “Call Types Allowed”
NUMx 9 Phone Line Number CAB_TEL/CAB_TEL2
PIN X PIN Code optionalRES_PIN_CODE
AKY X(4) Authorization Key optionalRefer to PAR Value for PAR-Interfaces-“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. Recordnumber 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 thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 117/211
Universal Interface – Technical Specification 7.00.0xx Page 117 of 211
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identifier. It can be used to uniquely identify aperson that is checking-in.
ACTThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG Group
V
VisitorA System accountS StaffZ Gift Card
NAMThe field identifies the salutation, forename and surname fields (separated with space) of a personthat is being checked-in.
LANThe field identifies the language of a person that is being checked-in. ISO 2 letter languageidentifiers are used.
TYPThe field identifies the call types that can be made from the number. Some types require that aperson swipes credit or onboard card first before the phone call can be made - this applies to sometypes of phone calls only.
B Block (No phone calls allowed)I Internal (Local) OnlyL Long Distance and Internal OnlyA International, Long Distance and InternalD Long Distance (requiring card swipe) and Internal OnlyW International and Long Distance (require card swipe) and Internal
PINThe field identifies the PIN number that a person must key-in before phone call is started. Pin codeis generated by FCSPMS application but validation of the pin code when a person wants to make aphone call is handles by PBX system. The valid character is 0,1,2,3,4,5,6,7,8,9. Leading zerosupport depend on Fidelio Parameter setting.
NUMxThe field identifies the phone line to be opened. Small x denotes fact that the field can be repeatedwithin <DATA> block which means that multiple phone lines can be open for the person beingchecked-in.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 118/211
Universal Interface – Technical Specification 7.00.0xx Page 118 of 211
AKYThe field identifies the authorization key for the person(s).
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>EnablePhone<US>REF=FCUI#1<US>RQN=121<US>DTE= 2001-09-1114:10:32<US>ACI=1234<US>ACT=P<US>NAM=JohnMalkovitch<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-1114:10:38<US>ACI=4534<US>ACT=P<US>NAM=WolfgangSchmidt<US>LAN=DE<US>TYP=L<US>PIN=21334<US>NUM1=0125<US>NUM2=0126
<US>PIN=12345<US>AKY=5542<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 119/211
Universal Interface – Technical Specification 7.00.0xx Page 119 of 211
DisablePhone
DisablePhone message type is sent from FCUI to PBX system to close (block) phone lines.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID RES_ACC
LST X(1)Last Person Assigned to PhoneNumber
SYSTEM CALCULATED
NUMx 9 Phone Line Number CAB_TEL/CAB_TEL2
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. Thefollowing is a description of the fields in the message data block.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot 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.
ACIThe field identifies the unique account (person) identifier. It can be used to uniquely identify aperson that is checking-out.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 120/211
Universal Interface – Technical Specification 7.00.0xx Page 120 of 211
LSTBoolean value identifying if the last person assigned to the phone number or cabin is checking-out.
Y The last person assigned to the phone number or cabin is checking-outN There are still people assigned to the phone number or cabin
NUMxThe field identifies the phone lines to be closed. Small x denotes fact that the field can be repeatedwithin <DATA> block which means that multiple phone lines can be closed for the person beingchecked-out.
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>DisablePhone<US>REF=FCUI#1<US>RQN=1218<US>DTE=2001-09-1114:18:32<US>ACI=1234<US>LST=N<US>NUM=0123 <ETX><CHECKSUM>
<STX>DisablePhone<US>REF=FCUI#1<US>RQN=1229<US>DTE=2001-09-1114:19:38<US>ACI=4534<US>LST=Y<US>NUM1=0125<US>NUM2=0126 <ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 121/211
Universal Interface – Technical Specification 7.00.0xx Page 121 of 211
ExtCheckIn
ExtCheckIn message type is sent by the FCUI to supply the information to the external systemabout a Check-In. The External System has to respond with an Acknowledge message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID RES_ACC
ACT X(1) Account Type RES_TAG
ENB 9 Account Enabled UXP_A_POSTING
NAM X(52) Salutation, Forename and Surname UXP_A_SALUT,UXP_A_FSTN,UXP_A_NAME
CAB X(6) Cabin Number optionalRES_CAB
EMB D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DIS D Disembarkation Date
RES_DIS_E for expected &checked in accounts,
RES_DIS_A for checked out
accountsDOB D 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)Reservation Status [E –Expected, C –Checked-In, D –Departed]
RES_STATUS translated to
E/C/D
GRP 9,X(30)Group Id & Description [Id –Description]
optional RES_GRP
CAT X(500)Category Id & Description [Id –Description; Id –Description]
optional RES_PPD_TAG
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 122/211
Universal Interface – Technical Specification 7.00.0xx Page 122 of 211
Code Type Description RequiredSPMS DB Field reference
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
CLM 9.9 Credit Limit optional
Credit limit as per assignedcredit department code,
unless individual credit limitis assigned in
UXP_A_CRELIM
SML X(72) Ship’s e-Mail Id optional RES_EMAIL_SHIP
PIN X PIN Code optional RES_PIN_CODE
AKY X(4) Authorization Key optionalRefer to PAR Value for
PAR- Interfaces-“AuthKeyCriteria”
BCC X(20) On board Cabin Card RES_BOARDCC
AWD X(6) Award Level optionalRES_AWARD_LEVEL
NAT X(6) Passport Nationality optional
UXP_H_PASSPI_COUNTR
Y
BID X(100) Booking ID optionalRES_BOOKNR
GID X(15) Group ID optionalRES_SHOREID(refer to
Group)
CSW X(100) Cabin Steward Name optionalRES_ACC (linked to
CAB_KEEPER)
The following is a description of the fields in the message data block.
REFThe 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 themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field identifies the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 123/211
Universal Interface – Technical Specification 7.00.0xx Page 123 of 211
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
ACTThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
ENB
The field identifies the information if an account is enabled (1) or disabled (0).
NAMThe field identifies the salutation, forename and surname fields (separated with space) of anaccount (person).
CABThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBThe field identifies the date and time the account (person) is expected or embarked.
DISThe field identifies the date and time the account (person) is expected to disembark.
DOBThe field identifies the person date of birth. If the account number is returned (not a person) or dateof birth is not present the field is omitted.
EMLThe field identifies the person e-mail address. If the account number is returned (not a person) or e-mail is not present the field is omitted.
BALThe field identifies the the account (person) current balance. This field can return positive (accountis to be invoiced) or negative (account prepaid) value.
FSTThe field identifies the forename of an account (person).
LSTThe field identifies surname of an account (person).
SALThe field identifies the salutation of an account (person).
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 124/211
Universal Interface – Technical Specification 7.00.0xx Page 124 of 211
TTLThe field identifies the title of an account (person).
GNDThe field identifies the gender of an account (person).
MINThe field identifies the "Y" or "N" if the account (person) is a Minor.
LANThe field identifies the language of an account (person).
GRPThe field identifies the Group Id and the name of the Group if a passenger is assigned to a Group.
CATThe field identifies the Category Ids and the names of the Categories if a passenger is assigned any
Categories.
ADDThe field identifies the address (Line 1).
STRThe field identifies the street (Line 2).
CTYThe field identifies the city.
ZIP
The field identifies the zip code.
STTThe field identifies the state.
CTRThe field identifies the country code.
TELThe field identifies the telephone number.
CLM
The field identifies the credit limit.
SMLThe field identifies the Ship’s e-Mail Address.
PINThe field identifies the telephone PIN code for the person(s). The valid character is0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKYThe field identifies the authorization key for the person(s) that satisfy the inquiry criteria.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 125/211
Universal Interface – Technical Specification 7.00.0xx Page 125 of 211
BCCIt 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 send9910000657580701
AWDThe field identifies the guest award level.
NATThe field identifies the guest passport nationality
BIDThe 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
ExampleMessage
<STX>ExtCheckIn<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-1114:10:24<US>ACI=9001201<US>ACT=P<US>ENB=1<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US> DIS=1997-09-12<US>DOB=1970-04-08<US>[email protected]<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=9002402-Holiday 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) 3990-0163<US>CLM=2000.00<US>[email protected]<US>PIN=123452<US>AKY=5543<US>BCC=9841000020957311<US>AWD=GOLD<US> NAT=SG<US> BID=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 126/211
Universal Interface – Technical Specification 7.00.0xx Page 126 of 211
ExtCheckOut
ExtCheckOut message type is sent by the FCUI to supply the information to the external systemabout a CheckOut. The External System has to respond with an Acknowledge message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 Optional RES_BOARDCC
PGI X(8) Pregenerated Random ID RES_PGID
The following is a description of the fields in the message data block.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQNThe field identifies the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
ACTThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS Staff
Z Gift Card
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 127/211
Universal Interface – Technical Specification 7.00.0xx Page 127 of 211
BCCIt 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 send9910000657580701
PGIPregenerated Random Number
ExampleMessage
<STX>ExtCheckOut<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-1114:10:24<US>ACI=9001201<US>ACT=P<US>BCC=9841000020957311<US>PGI=12345678 <ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 128/211
Universal Interface – Technical Specification 7.00.0xx Page 128 of 211
ExtCabinMove
ExtCabinMove message type is sent by the FCUI to supply the information to the external systemabout a Change of Cabin. The External System has to respond with an Acknowledge message
type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 OptionalRES_BOARDCC
The following is a description of the fields in the message data block.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole 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 throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 129/211
Universal Interface – Technical Specification 7.00.0xx Page 129 of 211
ACTThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
OCNThe field identifies the Old Cabin No.
NCN
The field identifies the New Cabin No.
BCCIt 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 send9910000657580701
ExampleMessage
<STX>ExtCabinMove<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-1114:10:24<US>ACI=9001201<US>ACT=P<US>OCN=0123<US>NCN=0128<US>BCC=9841000020957311<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 130/211
Universal Interface – Technical Specification 7.00.0xx Page 130 of 211
ChangeAirConState
ChangeAirConState message type is sent by the FCUI to supply the information to the externalsystem to change the Air conditional status. The External System has to respond with an
Acknowledge message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
CABThe field identifies the cabin number which the air conditional status is affected.
STANew Air Conditional Status request to be set, status could only be either 0 or 1. ( "0" = Off, "1" = On)
ExampleMessage
<STX>ChangeAirConState<US>REF=FCUI#1<US>RQN=1218<US>DTE=1997-09-1114:10:24<US>CAB=07809<US> STA=1<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 131/211
Universal Interface – Technical Specification 7.00.0xx Page 131 of 211
ClockIn
ClockIn message type is received by the FCUI from external system about a clock in of a crewmember. FCUI has to respond with an Acknowledge message type.
Code Type Description RequiredSPMS DB Field reference
REF X(20) Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE for field
definition below
CLK D Date and Time Clock In n/a – to be provided from
external system
TML X(6) Terminal ID n/a – to be provided fromexternal system
DES X(50) Terminal Description optionaln/a – to be provided from
external system
REM X(50) Remarks optionaln/a – to be provided from
external system
ACE X(1) Account ID Entry Type optionalRefer 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 thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and time
format is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
CLKThe field identifies the date and time when the clock in is done by the crew at the terminal.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 132/211
Universal Interface – Technical Specification 7.00.0xx Page 132 of 211
TMLThe field identifies the terminal ID for the terminal where the clock in is done by the crew.
DESThe field identifies the terminal description for the terminal where the clock in is done by the crew.
REMThe field identifies the additional remarks send by external system.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined: The default value is H if this field is omitted or invalid.
C Card identification number (RES_BOARDCC)I Internal identification number (FCSPMS account ID) (UXP_A_ID)E External identification number (e.g. reservation number) (RES_BOOKNR)
H
Internal Id number (UXP_C_INTERNALID)R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
ExampleMessage
<STX>ClockIn<US>REF=TIMEATTENDANCE<US>RQN=199<US>DTE=1997-09-1114: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 ONDUTY<US>ACE=H<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 133/211
Universal Interface – Technical Specification 7.00.0xx Page 133 of 211
ClockOut
ClockOut message type is received by the FCUI from the external system about a clock out of acrew member. FCUI has to respond with an Acknowledge message type.
Code Type Description RequiredSPMS DB Field reference
REF X(20) Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE for field
definition
CLK D Date and Time Clock Out n/a – to be provided from
external system
TML X(6) Terminal ID n/a – to be provided fromexternal system
DES X(50) Terminal Description optionaln/a – to be provided from
external system
REM X(50) Remarks optionaln/a – to be provided from
external system
ACE X(1) Account ID Entry Type optionalRefer 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 thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and time
format is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
CLKThe field identifies the date and time when the clock out is done by the crew at the terminal.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 134/211
Universal Interface – Technical Specification 7.00.0xx Page 134 of 211
TMLThe field identifies the terminal ID for the terminal where the clock out is done by the crew.
DESThe field identifies the terminal description for the terminal where the clock out is done by the crew.
REMThe field identifies the additional remarks send by external system.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined: The default value is H if this field is omitted or invalid.
C Card identification number (RES_BOARDCC)I Internal identification number (FCSPMS account ID) (UXP_A_ID)E External identification number (e.g. reservation number) (RES_BOOKNR)
H
Internal Id number (UXP_C_INTERNALID)R RFID UID (RFID_ID)F Loyalty Number (UXP_A_FRQ_CARDNO)P Pre generated Random Number (RES_PGID)
ExampleMessage
<STX>ClockOut<US>REF=TIMEATTENDANCE<US>RQN=199<US>DTE=1997-09-1114: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 OFFDUTY<US>ACE=H<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 135/211
Universal Interface – Technical Specification 7.00.0xx Page 135 of 211
SysMsgReq
SysMsgReq message type is used to request the details of the System from the FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
The message is usually used to display the details of the System. The following is a description ofthe fields in the message data block.
REF
The field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe 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 timeformat is required.
ExampleMessage
<STX>SysMsgReq<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:11:12<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 136/211
Universal Interface – Technical Specification 7.00.0xx Page 136 of 211
SysMsg
SysMsg message type is sent by the FCUI to supply the details of the Fidelio system to the externalsystem.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
SHP X(50) Ship’s Name SYS_SHIPSNAME
SDT D System Date SYS_DATE
SCR X(75) Cruise Id & Name [Id –Description] SYS_CRUISE +SCR_COMMENT
ITN X(10) Itinerary Id SCR_ITN_ID
CUR X(75)Currency Id & Description [Id –Description]
SCR_CUR +
DEP_COMMENT
VER X(8) Version No. of the FCUI SYSTEM CALCULATED
CSD D Cruise Start Date SCR_A_DATE
CED D Cruise End Date SCR_A_DATE
The message returns the details of the System as described below. There is always ONLY oneresponse.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
SHPThe field identifies the name of the Ship.
SDTThe field identifies the current Fidelio Cruise system date.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 137/211
Universal Interface – Technical Specification 7.00.0xx Page 137 of 211
SCRThe field identifies the current cruise id and the description.
ITNThe field identifies the current itinerary id.
CURThe field identifies the currency id and the name of the current cruise.
VERThe field identifies the version number of the current FCUI. The format is x.yy.zzz.
CSDCurrent Cruise Start Date
CED
Current Cruise End Date
X Major Version YY Minor VersionZZZ ZZZ-Revision
ExampleMessage
<STX>SysMsg<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11 14:10:31<US>SHP=TheVoyager <US>SDT=1997-09-11<US>SCR=3959-Caribbean Cruise14<US>ITN=VY0014<US>CUR=9005-US Dollars<US>VER=7.00.044<US>CSD=1997-09-11<US>CED=1997-09-15<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 138/211
Universal Interface – Technical Specification 7.00.0xx Page 138 of 211
MessageLight
MessageLight message type is sent by the FCUI to inform the external system about turning on oroff the message light for a given cabin. The External System has to respond with an Acknowledge
message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 UXP_A_SALUT,UXP_A_FSTN,UXP_A_NAME
NUMx 9 Phone Line Number CAB_TEL/CAB_TEL2
LIT X(3) Light State – [On / Off] SYSTEM_CALCULATED
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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACI The field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 139/211
Universal Interface – Technical Specification 7.00.0xx Page 139 of 211
CABThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
NAMThe field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
NUMxThe field identifies the phone number for the light to be enabled or disabled. Small x denotes factthat the field can be repeated within <DATA> block which means that multiple phone can bemanaged for the person receiving the message.
LITThe 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.
ExampleMessage
<STX>MessageLight<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>ACI=9001201<US>CAB=4002<US>NAM=JohnMalkovitch<US>NUM=4002<US>LIT=On<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 140/211
Universal Interface – Technical Specification 7.00.0xx Page 140 of 211
Messages
Messages message type is sent to the FCUI by the external system to request all messages for anaccount. The FCUI responds with a MessageList message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID RES_ACC
The following is a description of the fields in the message data block.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe 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 doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
ACI The field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
ExampleMessage
<STX>Message<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>ACI=9001201<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 141/211
Universal Interface – Technical Specification 7.00.0xx Page 141 of 211
MessageList
MessageList message type is sent by the FCUI to the external system with a list of all messagesfor an account for a Messages message type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
TXTx X(52) Message Text MSG_TEXT
TKNx D 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
DELx D Delivery Date and Time optionalMSG_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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQN
The field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
TXTxThe field identifies the message Text.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 142/211
Universal Interface – Technical Specification 7.00.0xx Page 142 of 211
TKNxThe field identifies the date and the time when message was received.
TBYxThe field identifies the taken by user.
SNDxThe field identifies the message sent by.
LITxThe field identifies the status of the message light (On/Off).
DELxThe 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.
ExampleMessage
<STX>MessageList<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>TXT1=Please call the office<US>TKN1=2002-12-06<US>TBY1=David<US>SND1=Irish<US>LIT1=Off <US>DEL1=2002-12-14<US>TXT2=Please call your daughter.<US>TKN2=2002-12-12<US>TBY2=Jose<US>SND2=Kelly Arison<US>LIT2=Off <US>DEL2=2002-12-14<US>TXT3=PLEASE CALL THE OFFICE.<US>TKN3=2002-12-12<US>TBY3=Jose<US>SND3=Irish<US>LIT3=Off <US>DEL3=2002-12-
14<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 143/211
Universal Interface – Technical Specification 7.00.0xx Page 143 of 211
SetPIN
SetPIN message type is sent by the external system to set the PIN code of an account in FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID RES_ACC
CAB X(6) Cabin Number RES_CAB
AKY X(4) Authorization Key Refer to PAR Value for PAR-
Interfaces-“AuthKey Criteria” PIN X PIN code
RES_PIN_CODE
SetPIN message is used to set the telephone PIN code of an account in FCSPMS. The following isa description of the fields in the message data block.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will be
used as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, unique
account (person) number (I type).
CABThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 144/211
Universal Interface – Technical Specification 7.00.0xx Page 144 of 211
PINThe field identifies the telephone PIN code for the person(s) that satisfy the inquiry criteria. The validcharacter 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.
ExampleMessage
<STX>SetPIN<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-1114:10:32<US>ACI=98010<US>CAB=2001<US>PIN=882771<US>AKY=4883<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 145/211
Universal Interface – Technical Specification 7.00.0xx Page 145 of 211
GetPIN
GetPIN message type is sent by the external system to confirm the PIN code of an account from theFCUI.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
ExampleMessage
<STX>GetPIN<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-1114:10:32<US>ACI=20331<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 146/211
Universal Interface – Technical Specification 7.00.0xx Page 146 of 211
PINDetails
PINDetails message type is sent to the external system as response to GetPIN command.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 Refer to PAR Value for PAR-Interfaces-“AuthKey Criteria”
PIN X PIN code RES_PIN_CODE
PINDetails will display the pin details regarding an account inquired. The following is a description ofthe fields in the message data block.
REFThe 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 themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
FSTThe field identifies the forename of an account (person) to satisfy inquiry criteria.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 147/211
Universal Interface – Technical Specification 7.00.0xx Page 147 of 211
LSTThe field identifies the surname of an account (person) to satisfy inquiry criteria.
CABThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
PINThe field identifies the telephone PIN code for the person(s) that satisfy the inquiry criteria. The validcharacter is 0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKYThe field identifies the authorization key for the person(s) that satisfy the inquiry criteria.
ExampleMessage
<STX>PINDetails<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-1114:10:32<US>ACI=20031<US>LST=Jane<US>FST=Mary<US>CAB=2001<US>AKY=2443<US>PIN=0878111<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 148/211
Universal Interface – Technical Specification 7.00.0xx Page 148 of 211
UpdatePIN
UpdatePIN message type is sent to the external system to update any changes on the PIN code ofan account in FCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 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 Refer to PAR Value for PAR-Interfaces-“AuthKey Criteria”
PIN X PIN code RES_PIN_CODE
UpdatePIN message serves as a command to update external system that PIN code changes hasbeen 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 thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identification. The field is an internal, uniqueaccount (person) number (I type).
FSTThe field identifies the forename of an account (person) to satisfy inquiry criteria.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 149/211
Universal Interface – Technical Specification 7.00.0xx Page 149 of 211
LSTThe field identifies the surname of an account (person) to satisfy inquiry criteria.
CABThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
PINThe field identifies the telephone PIN code for the person(s) that satisfy the inquiry criteria. The validcharacter is 0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
AKYThe field identifies the the authorization key for the person(s) that satisfy the inquiry criteria.
ExampleMessage
<STX>UpdatePIN<US>REF=FCUI#1<US>RQN=121<US>DTE=2001-09-1114:10:32<US>ACI=20031<US>LST=Jane<US>FST=Mary<US>CAB=2001<US>AKY=2443<US>PIN=0878111<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 150/211
Universal Interface – Technical Specification 7.00.0xx Page 150 of 211
GetPromoMessage
GetPromoMessage message type is used to request list of promotion available from the FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 Account ID RES_ACC
The message is usually used to display list of promotion that belong to the current guest. Thefollowing 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe 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 doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 obtainedthrough e.g. Inquire message. The field is an internal, unique account (person) number (I type).
ExampleMessage
<STX>GetPromoMessage<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>ACI=250046<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 151/211
Universal Interface – Technical Specification 7.00.0xx Page 151 of 211
GetPromoMessageResponse
GetPromoMessageResponse message type is sent by the FCUI to supply list of promotion for thespecified guest.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
PROx 9 Promotion ID PRD_ID
PTYx 9 Promotion Type PRO_TYPE
PNMx X(100) Promotion Title PRD_NAME
PDSx X(500) Promotion Description PRD_DESC
EIDx 9 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 messagenumber one is required while all the others are optional. Record number will not be present if onlyone 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 152/211
Universal Interface – Technical Specification 7.00.0xx Page 152 of 211
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
PROxThe field identifies the unique promotion id
PTYxThe field identifies the promotion type.
1 Excursion2 Excursion Package3 Micros POS
PNMxThe promotion title.
PDSxThe promotion detail description.
EIDxThe value depend on promotion type
For 1. ExcursionThe field identifies the unique excursion identifier. This ID can be used for excursion booking. Thefield is an internal, unique excursion number.
For 2. Excursion PackageThe field identifies the unique package identifier. This ID can be used for package booking. The fieldis an internal, unique excursion number.
For 3. Micros POSThis field is not used.
ENOxThe value depend on promotion type
For 1. Excursion
The field identifies the custom, users entered, number that identifies excursion.
For 2. Excursion PackageThe field identifies the custom, users entered, number that identifies package.
For 3. Micros POSThis field is not used.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 153/211
Universal Interface – Technical Specification 7.00.0xx Page 153 of 211
NAMxThe value depend on promotion type
For 1. ExcursionThe field identifies the excursion name (description).
For 2. Excursion PackageThe field identifies the package name (description).
For 3. Micros POSThis field is not used.
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>GetPromoMessageResponse<US>REF=Comp1<US>RQN=125<US>DTE=1997-09-1114:11:34<US>PID1=304<US>PTY1=1<US>PNM1=2 Days before Excursion tillExcursion<US>PDS1=112345<US>EID1=48642<US>ENO1=VADL-1<US>NAM1= AdelaideCity / Glenelg<US>PID2=304<US>PTY2=1<US>PNM2=2 Days before Excursion tillExcursion<US>PDS2=112345<US>EID2=48644<US>ENO2=VBUN-1<US>NAM2=TheUltimate Dolphin Experience<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 154/211
Universal Interface – Technical Specification 7.00.0xx Page 154 of 211
Events
Events message type is used to request a list of events available from the FCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
SDT D Event starting date n/a – to be provided from
external system
EDT D Event ending date 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
SDTThe field identifies the minimum date the event can start from.
EDT The field identifies the maximum date the event must be completed.
ExampleMessage
<STX>Events<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>SDT=1997-09-12 00:00:00<US>EDT=1997-09-12 23:59:59<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 155/211
Universal Interface – Technical Specification 7.00.0xx Page 155 of 211
ExtEvents
ExtEvents message type is used to request list of events available from the FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
BDT D Event Starting Date n/a – to be provided from
external system
TYP X(1) Code Type optionalRefer to TYP type definition
below
COD X(50) Code optionalRefer 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
BDTThe field identifies the date for the event can start from.
TYPThe field identifies the type of the code being passed for querying events.
L Event Location NameN Event No (ENO)I Event Unique ID (EID)
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 156/211
Universal Interface – Technical Specification 7.00.0xx Page 156 of 211
CODThe code for the Events to run the query on. It can be either the location code (LOC_TITLE), TheEvent No (ENO) – (TKBE_CODE), the Unique Id (EID) – (TKBE_ID).
ExampleMessage
<STX>ExtEvents<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>BDT=1997-09-12 00:00:00<US>TYP=L<US>COD=Cinema<ETX><CHECKSUM>
<STX>ExtEvents<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>BDT=1997-09-1200:00:00<US>TYP=N<US>COD=HAM0012<ETX><CHECKSUM>
<STX>ExtEvents<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>BDT=1997-09-1200:00:00<US>TYP=I<US>COD=73928740<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 157/211
Universal Interface – Technical Specification 7.00.0xx Page 157 of 211
EventsResponse
EventsResponse message type is sent by the FCUI to supply list of events that fall within startingand ending date or time specified by external system.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
EIDx 9 Event ID TKBE_ID
ENOx X(20) Event Number TKBE_CODE
NAMx X(50) Event Name TKBE_NAME
SDTx D Starting Date and Time TKBE_DATE +
TKBE_FROMTIME
EDTx D Ending Date and Time TKBE_DATE +TKBE_TOTIME
LDTx D Last Call Time optionalTKBE_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)Show in Kiosk [External BookingSystem]
TKBE_SHOW_KIOSK
BIKx X(3)Book in Kiosk [External BookingSystem]
TKBE_SELL_KIOSK
MAXx 9 Maximum Seats TKBE_MAXPER
CURx 9 Seats Currently Booked SYSTEM CALCULATED
LOCx X(50) Location Name LOC_TITLE
SITx X(3)Show in ITV [External BookingSystem]
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 ornot
TKBE_ONE_TICKET_LIMIT
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 158/211
Universal Interface – Technical Specification 7.00.0xx Page 158 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 messagenumber one is required while all the others are optional. Record number will not be present if onlyone 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
EIDxThe field identifies the unique event identifier. This ID can be used for event booking. The field is aninternal, unique event number.
ENOxThe field identifies the custom, users entered, number that identifies event.
NAMxThe field identifies the event name (description).
SDTxThe field identifies the event starting date and time.
EDTxThe field identifies the event ending date and time.
LDTxThe field identifies the last call time, please ignore the date part.
STAxThe field identifies the event booking status. The following status identifiers values are defined:
A AvailableF Fully bookedO Overbooked
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 159/211
Universal Interface – Technical Specification 7.00.0xx Page 159 of 211
PCTxThe field identifies the event price category code, this field is required during booking.
E.g. Gold (Gold Class)Silver (Silver Class)
PCNxThe field identifies the event price category description.
PGTxThe field identifies the person group code, this field is required during booking.
e.g. AdultChildSenior
PGNxThe field identifies the person group description.
PCAxThe field identifies the event selling price.
INFxThe field identifies the additional information about event.
SIKxThe flag to denote if the event can be shown on the external system, the field returns ‘Yes’ or ‘No’
only.
BIKxThe flag to denote if the event can be booked on the external system, the field returns ‘Yes’ or ‘No’only.
MAXxTotal seats available on the event.
Note: For the same event id the same seat could be sold at different price depend on the pricecategory and person group. So the total seats appear on different price category and person groupwill be representing the same seats.
e.g. The below mean the event 1 only have 50 seats available, for the same EID will always havethe same MAX value.
EID PCT PGT MAX1 Gold Adult 501 Silver Adult 501 Gold Child 501 Silver Child 50
CURxThis is the total seats booked on the evens.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 160/211
Universal Interface – Technical Specification 7.00.0xx Page 160 of 211
LOCxThe field identifies the location name of the event.
SITxThe flag to denote if the event can be shown on ITV the external system, the field returns ‘Yes’ or‘No’ only.
BITxThe flag to denote if the event can be booked on the ITV external system, the field returns ‘Yes’ or‘No’ only.
DSCxEvent long Description intended for ITV usage.
OTLxThe 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.
ExampleMessage
<STX> EventsResponse <US>REF=Comp1<US>RQN=125<US>DTE=1997-09-1114:11:34<US>EID1=1<US>ENO1=TEST<US>NAM1=Test<US>SDT1=2009-04-0600:00:01<US>EDT1=2009-04-0700: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-2900: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<US>LOC2=Test<US>SIT2=Yes<US>BIT2=Yes<US>DSC2=Test<US>OTL2=Yes<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 161/211
Universal Interface – Technical Specification 7.00.0xx Page 161 of 211
EventBooking
EventBooking message type is sent to the FCUI to insert event booking and post event charge.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI X(52) Account ID Refer to ACE field definition
below
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
ACS X(1) Account Status RES_STATUS translated to
R/CBOI X(30) Unique Event Booking ID
n/a – to be provided fromexternal system
EIDx 9 Event ID TKBE_ID
PCTx X(6) Price Category Code TKPB_PRICE_CATEGORY
PGTx X(6) Person Group Code TKPB_PERSON_GROUP
QTYx 9 Quantity n/a – to be provided from
external system
INF X(50) Notes optionaln/a – to be provided from
external system
PIN X PIN Code optional RES_PIN_CODE
SRC X(100) Booking Source optionaln/a – to be provided from
external system
FLG XY-Allow posting even the guest hasreached his credit limit or posting isdisable, N-Normal posting
optionaln/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 FCSPMScan assign the whole booking as one transaction that can be traced and voided later on. Recordnumber cannot be used if only one record is send.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 162/211
Universal Interface – Technical Specification 7.00.0xx Page 162 of 211
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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) andgenerally contains any information necessary to identify account. The field can be account number,card number, cabin number or person name.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined:
C Card identification number (RES_BOARDCC)A Cabin number or System account (RES_CAB/UXP_A_SYS_ACC)N Name of a person or company account (UXP_A_NAME_N)I Internal identification number (UXP_A_ID)
G Group Id number (RES_GRP)E External identification number (RES_BOOKNR)T Phone trunk number (CAB_TEL or CAB_TEL2)M e-mail Id (UXP_H_EMAIL or RES_EMAIL_SHIP)H Internal Id number (UXP_C_INTERNALID)X Guest Category (GCT_CODE) R RFID UID (RFID_ID)
F Loyalty Number (UXP_A_FRQ_CARDNO)
P Pre generated Random Number (RES_PGID)
ACSThe field identifies the account current reservation status. The following status values are accepted:
R ReservationsC Checked-in
BOIThe field identifies the booking (check) unique within the whole external system. The field is used asa cross-reference to obtain detailed information about all the transactions recorded on a booking.
EIDxThe 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 fieldis an internal, unique event number.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 163/211
Universal Interface – Technical Specification 7.00.0xx Page 163 of 211
PCTxThe field identifies the Price Category. The ID + Price Category + Person Group cannot repeatwithin one message. This Price Category can be obtained through e.g. Events message. The field isan internal, unique event number.
PGTxThe field identifies the Person Group. The ID + Price Category + Person Group cannot repeat withinone message. This Person Group can be obtained through e.g. Events message. The field is aninternal, unique event number.
QTYxThe field identifies the number of tickets to book.
INFThe field identifies the additional information send by FCUI.
PINThe field identifies the telephone PIN code of the reservation account. The valid character is0,1,2,3,4,5,6,7,8,9. Leading zero support depend on Fidelio Parameter setting.
SRCThe field identifies the source of the booking. Eg: Workstation Id, Kiosk Id, etc. or any other detailsdescribing 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 tocheck-in guest only), N-Normal posting
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>EventBooking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-1114: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=VIPTickets<US>PIN=12345<US>SRC=Shorex Kiosk 12<ETX><CHECKSUM>
<STX>EventBooking<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-1114: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
r US>PGT2=Adult<US>QTY2=1<US>INF=VIP Tickets<US>PIN=12345<US>SRC=Shorex Kiosk12<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 164/211
Universal Interface – Technical Specification 7.00.0xx Page 164 of 211
EventBookingResponse
EventBookingResponse message type is sent by the FCUI to confirm posting made.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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
UXP_A_SALUT,
UXP_A_FSTN,UXP_A_NAME
CABx X(6) Cabin Number optionalRES_CAB
EMBx D Embarkation Date RES_EMB_E for expectedaccounts, RES_EMB_A for
checked in accounts
DISx D Disembarkation Date RES_DIS_E
BALx 9.9 Balance SYSTEM CALCULATED
CRUx 9.9 Posted Cruise ID optionalPOS_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. Theresponse message number one is required while all the others are optional. Record number will notbe present if only one record is returned. If one record is returned it serves as a confirmation thatthe booking has been made. Final balance after the event posting is applied will be send. Nobooking 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 165/211
Universal Interface – Technical Specification 7.00.0xx Page 165 of 211
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIxThe 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).
ACTxThe field describes the account type. The following account types are defined:
P Passenger (Guest)
R
Resident (Guest)C Crew memberG GroupV VisitorA System accountS StaffZ Gift Card
NAMx The field identifies the salutation, forename and surname fields (separated with space) of anaccount (person) to satisfy inquiry criteria.
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
EMBxThe field identifies the date and time the account (person) is expected or embarked.
DISxThe 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.
CRUxThe field identifies the posted cruise id if posting is applied when one account was found. Otherwisereturns zero.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 166/211
Universal Interface – Technical Specification 7.00.0xx Page 166 of 211
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>EventBookingResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-1114: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=JaneMalkovitch<US>CAB2=0123 <US>EMB2=1997-09-11<US>DIS2=1997-09-13<US>BAL2=24.12<US>CRU2=0<ETX><CHECKSUM>
<STX>EventBookingResponse<US>REF=TV#1<US>RQN= 1218<US>DTE=1997-09-1114:10:59<US>ACI=9001201<US>ACT=P<US>NAM=JohnMalkovitch<US>CAB=0123<US>EMB=1997-09-10<US>DIS=1997-09-12<US>BAL=145.79<US>CRU=12345<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 167/211
Universal Interface – Technical Specification 7.00.0xx Page 167 of 211
EventFolio
EventFolio message type is used to request list of events booked on a specific account inFCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe 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 doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 obtainedthrough e.g. Inquire message. The field is an internal, unique account (person) number (I type).
ExampleMessage
<STX>EventFolio<US>REF=TV#1<US>RQN=1209<US>DTE=1997-09-1114:10:23<US>ACI=9001201<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 168/211
Universal Interface – Technical Specification 7.00.0xx Page 168 of 211
EventFolioResponse
EventFolioResponse message type is sent by the FCUI to supply the list of events currentlybooked for the account specified by an external system. The message returns the same list of
events that are visible through FCSPMS system.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
EIDx 9 Event ID TKBE_ID
ENOx X(10) Event Number TKBE_CODE
NAMx X(50) Event Name TKBE_NAME
SDTx D Starting Date and Time TKBE_DATE +
TKBE_FROMTIME
EDTx D Ending Date and Time TKBE_DATE +TKBE_TOTIME
STAx X(1) Event Status SYSTEM CALCULATED
BDTx D 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 9 Number of Tickets Booked SYSTEM CALCULATED
BOVx 9.9 Booking Value SYSTEM CALCULATED
INFx X(200) Notes optionalTKPO_COMMENT
PRNx 9 Ticket Printed Count TKPO_TICKET_PRINTED
PPEx X(3) Prepaid Status flag TKPO_PREPAID
The message can return one or more records of the data to satisfy inquiry criteria. The responsemessage number one is required while all the others are optional. Record number will not bepresent if only one record is returned. The following is a description of the fields in the messagedata block.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 169/211
Universal Interface – Technical Specification 7.00.0xx Page 169 of 211
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused 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 itemsretrieved through events message. The field is an internal, unique event number.
ENOxThe field identifies the custom, users entered, number that identifies event.
NAMxThe field identifies the event name (description).
SDTxThe field identifies the event starting date and time.
EDTxThe field identifies the event ending date and time.
STAxThe field identifies the event booking status. The following status identifiers values are defined:
A AvailableF Fully BookedO Overbooked
BDTx
The field identifies the event booking date and time (real date and time).
PCTxThe field identifies the event price category code, this field is required during booking.
E.g. Gold (Gold Class)Silver (Silver Class)
PCNxThe field identifies the event price category description.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 170/211
Universal Interface – Technical Specification 7.00.0xx Page 170 of 211
PGTxThe field identifies the person group code, this field is required during booking.
e.g. AdultChildSenior
PGNxThe field identifies the person group description.
LOCxThe field identifies the location name of the event.
QTYxThe field identifies the number of tickets booked.
BOVxThe field identifies the total value of the bookings for the returned events.
INFxThe field identifies the additional information about event.
PRNxThe field identifies how many times the tickets had been printed.
PPExThe 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.
ExampleMessage
<STX>EventFolioResponse<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114: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-1312: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-1220: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=Keepwarm<USPCN2=1<US>PPE2=Yes <ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 171/211
Universal Interface – Technical Specification 7.00.0xx Page 171 of 211
UDFRead
UDFRead message type is sent to the FCUI to read the user define type of a passenger.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 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 onerecord is send.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIUnique Account ID (Internal identification number (FCSPMS account ID)).
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>UDFRead<US>REF=TV#1<US>RQN=1214<US>DTE=1997-09-1114:10:45<US>ACI=2089734<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 172/211
Universal Interface – Technical Specification 7.00.0xx Page 172 of 211
UDFReadResponse
UDFReadResponse message type is sent by the FCUI to retrieve the user define field
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 Account ID RES_ACC
UIDx 9 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. Theresponse message number one is required while all the others are optional. Record number will notbe present if only one record is returned. The following is a description of the fields in the messagedata block.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 173/211
Universal Interface – Technical Specification 7.00.0xx Page 173 of 211
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identification..
UIXxThe field describes the unique ID for the user defined type. This field is require when callUDFUpdate.
UVLx
The field identifies the value user enter for this user defined type.
UMNxThe field name identifies the user defined type.
ULBxThe field identifies caption display on SPMS Application for this user defined type.
URMxThe 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.
ExampleMessage
<STX>UDFReadResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-1114:10:49<US>ACI= 2089734<US>UID1=1<US>UVL1=Test <US>UMN1=Field1<US>ULB1=Field 1<US>URM1=Testing User Defined Field 1<US>UID2=2<US>UVL2=Test2<US>UMN2=Field 2<US>ULB2=Field 2<US>URM2=Testing User Defined Field2<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 174/211
Universal Interface – Technical Specification 7.00.0xx Page 174 of 211
UDFUpdate
UDFUpdate message type is sent to the FCUI to update the user define type of a passenger.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 Unique Account ID RES_ACC
UIDx 9 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 onerecord is send.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIUnique Account ID (Internal identification number (FCSPMS account ID)).
UIXxThe field describes the unique ID for the user defined type. This field is return from the UDFRead.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 175/211
Universal Interface – Technical Specification 7.00.0xx Page 175 of 211
UVLx The field identifies the value user enter for this user defined type.
ExampleMessage
<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-1114:10:45<US>ACI=2089734<US>UID1=1<US>UVL1=Test 1<US>UID2=1<US>UVL2=Testing1<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 176/211
Universal Interface – Technical Specification 7.00.0xx Page 176 of 211
UDFUpdateResponse
UDFUpdateResponse message type is sent by the FCUI to acknowledge the successfully ofupdating user define fields.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9 Account ID RES_ACC
UDFUpdateResponse message can return one or more records that satisfy inquiry criteria. Theresponse message number one is required while all the others are optional. Record number will notbe present if only one record is returned. The following is a description of the fields in the messagedata block.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIThe field identifies the unique account (person) identification.
ExampleMessage
<STX>UDFUpdateResponse<US>REF=TV#1<US>RQN=1217<US>DTE=1997-09-1114:10:49<US>ACI= 2089734<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 177/211
Universal Interface – Technical Specification 7.00.0xx Page 177 of 211
GetCruiseItinerary
GetCruiseItinerary message type is used to request list of cruise port information from theFCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
SDT D Cruise starting date n/a – to be provided from
external system
EDT D Cruise ending date 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
SDTThe 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.
ExampleMessage
<STX>GetCruiseItinerary<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>SDT=2011-01-01<US>EDT=2011-01-02<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 178/211
Universal Interface – Technical Specification 7.00.0xx Page 178 of 211
GetCruiseItineraryResponse
GetCruiseItineraryResponse message type is sent by the FCUI to supply list of cruise informationfor the specified date.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
CIDx 9 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 9 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 messagenumber one is required while all the others are optional. Record number will not be present if onlyone 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 179/211
Universal Interface – Technical Specification 7.00.0xx Page 179 of 211
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
CIDxThe field identifies the unique cruise itinerary ID
DCTxThe field identifies departure country ISO Code as setup in FC Administrator.
DPTxThe field identifies departure port as setup in FC Administrator.
DDTxThe field identifies departure date.
DTMxThe field identifies departure time.
ACTxThe field identifies arrival country ISO Code as setup in FC Administrator.
ADPxThe field identifies arrival port as setup in FC Administrator.
ADTxThe field identifies arrival date.
ATMxThe field identifies arrival time.
ADNxThe field identifies arrival port name as setup in FC Administrator.
DPNxThe field identifies departure port name as setup in FC Administrator.
SCRxThe field identifies the cruise ID (scr_id)
NOTE: Small x denotes fact that the field can be repeated within <DATA> block.
ExampleMessage
<STX>GetCruiseItineraryResponse<US>REF=Comp1<US>RQN=125<US>DTE=1997-09-1114:11:34<US>CID1=304<US>DCT1= MY<US>DPT1=PKL<US>DDT1=2011-01-01<US>DTM1=2300<US>ACT1=MY<US>APT1=PKL<US>ADT1=2011-01-01<US>ATM1=0900<US>CID2=305<US>DCT2= TH <US>DPT2= HKT <US>DDT1=2011-01-04<US>DTM2=0900<US>ACT2= TH<US>APT2=HKT<US>ADT2=2011-01-
03<US>ATM2=1300<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 180/211
Universal Interface – Technical Specification 7.00.0xx Page 180 of 211
SystemDateChange
SystemDateChange message type is sent by the FCUI to inform the external system that Fideliohave change the system date. The External System has to respond with an Acknowledge messagetype.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
SDT D Current Fidelio System Date ASYS.SYS_DATE
EOC X Y=Today is End Of Cruise Compare the current systemdate 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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
SDT The field identifies the new Fidelio system date.
EOCCompare the current system date with scr_a_date of next cruise, if same return Y else return N
ExampleMessage
<STX>SystemDateChange<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>SDT=2011-02-02 <US>EOC=N<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 181/211
Universal Interface – Technical Specification 7.00.0xx Page 181 of 211
SystemCruiseChange
SystemCruiseChange message type is sent by the FCUI to inform the external system that Fideliohave change the system cruise. The External System has to respond with an Acknowledgemessage type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
CID D Cruise Itinerary ID SCR_ID
ITN X Cruise Itinerary Id SCR_ITN_ID
SCR X Cruise Comment SCR_COMMENT
SDT D Cruise Start Date SCR_A_DATE
EDT D 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.
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe 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 doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
CID The field identifies the unique cruise itinerary ID
ITNThe field identifies the current itinerary id.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 182/211
Universal Interface – Technical Specification 7.00.0xx Page 182 of 211
SCRThe field identifies the current cruise description.
SDTCurrent cruise start date
EDTCurrent cruise end date = next cruise start date
ExampleMessage
<STX>SystemCruiseChange<US>REF=TV#1<US>RQN=120<US>DTE=1997-09-1114:10:24<US>CID=1234 <US> ITN=3334 <US> SCR=09/02/2012 CRUISE<ETX> <CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 183/211
Universal Interface – Technical Specification 7.00.0xx Page 183 of 211
GetExchangeRate
GetExchangeRate message type is used to request the current active exchange from theFCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe 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 timeformat is required.
ExampleMessage
<STX>GetExchangeRate<US>REF=FCUI#1<US>RQN=121<US>DTE=2007-10-0314:10:32<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 184/211
Universal Interface – Technical Specification 7.00.0xx Page 184 of 211
GetExchangeRateResponse
GetExchangeRateResponse message type is sent by the FCUI to supply the information inresponse to an inquiry request from an external system. The message returns current active
exchange rate configure in FC SPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 responsemessage number one is required while all the others are optional. Record number will not bepresent 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 thewhole 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 throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused 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 doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
CURxThe field identifies the currency code.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 185/211
Universal Interface – Technical Specification 7.00.0xx Page 185 of 211
CUNxThe field identifies the currency description.
CUBxThis field identified buy rate for guest.
CUSxThis field identified sell rate for guest.
CCBxThis field identified buy rate for crew.
CCSxThis 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 USDthen 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-0314:10:32<US>CUR1=USD<US>CUN1=USDollar <US>CUB1=1.235<US>CUS1=1.23<US>CCB1=1.23<US>CUS1=1.23<US>
CUR2=AUD<US>CUN2=AustraliaDollar <US>CUB2=1.135<US>CUS2=1.13<US>CCB2=1.13<US>CUS2=1.13<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 186/211
Universal Interface – Technical Specification 7.00.0xx Page 186 of 211
GetPicture
GetPicture message type is used to request guest picture from the FCSPMS.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9Unique Account ID return fromInquireResponse
optional RES_ACC
MOD D 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIUnique Account ID return from InquireResponse
MODLast 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
ExampleMessage
<STX>GetPicture<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>ACI=13273495<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 187/211
Universal Interface – Technical Specification 7.00.0xx Page 187 of 211
GetPictureResponse
GetPictureResponse message type is sent by the FCUI to supply the picture for the specifiedguest.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACIx 9 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 D Current Cruise Start Date scr_a_date of current cruise
BCCx X(20) On board Cabin Card RES_BOARDCC
SEQx 9 Sequence Number RES_CAB_SEQ
PICx XPicture in Base64 string, unlimitedlength
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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 188/211
Universal Interface – Technical Specification 7.00.0xx Page 188 of 211
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIx The field identifies the unique account ID
CABxThe field identifies the cabin number that the account (person) occupies. If the account number isreturned (not a person) cabin number field is omitted.
FSTxThe field identifies the forename of an account (person).
LSTx
The field identifies the surname of an account (person).
BIDxThe field identifies the booking id.
CSDxCurrent cruise start date.
BCCxIt 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 send9910000657580701
SEQxThis sequence number is populate via DGS from the reservation system
PICxThe picture string in Base64 encoding.
PGIxPregenerated Random Number
SCIxCruise external system identifier
REZxExternal reservation ID
SIDxThe field identifies the shore id.
ACTxThe field identifies the account type. The following account types are defined:
P Passenger (Guest)R Resident (Guest)C Crew member
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 189/211
Universal Interface – Technical Specification 7.00.0xx Page 189 of 211
G GroupV VisitorS Staff
ECDxExternal Crew ID
VB.NET sample codeConvert.FromBase64String(sString as String)
Below is a sample code in VB6 to decode the messagePublic 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 LongDim lPowers18(63) As Long, lQuad As Long, iPad As Integer, lChar As Long, lPos As Long, sOut As StringDim lTemp As Long
sString = Replace(sString, vbCr, vbNullString) 'Get rid of the vbCrLfs. These could be in...
sString = Replace(sString, vbLf, vbNullString) '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 'InStrRev is faster when you know it's at the end.iPad = 2 'Note: These translate to 0, so you can leave them...
ElseIf InStrRev(sString, "=") Then 'in the string and just resize the output.iPad = 1
End If
For lTemp = 0 To 255 'Fill the translation table.Select Case lTemp
Case 65 To 90bTrans(lTemp) = lTemp - 65 'A - Z
Case 97 To 122bTrans(lTemp) = lTemp - 71 'a - z
Case 48 To 57bTrans(lTemp) = lTemp + 4 '1 - 0
Case 43bTrans(lTemp) = 62 'Chr(43) = "+"
Case 47bTrans(lTemp) = 63 'Chr(47) = "/"
End Select
Next lTemp
For lTemp = 0 To 63 'Fill the 2^6, 2^12, and 2^18 lookup tables.lPowers6(lTemp) = lTemp * cl2Exp6lPowers12(lTemp) = lTemp * cl2Exp12lPowers18(lTemp) = lTemp * cl2Exp18
Next lTemp
bIn = StrConv(sString, vbFromUnicode) 'Load the input byte array.ReDim bOut((((UBound(bIn) + 1) \ 4) * 3) - 1) 'Prepare the output buffer.
For lChar = 0 To UBound(bIn) Step 4lQuad = 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
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 190/211
Universal Interface – Technical Specification 7.00.0xx Page 190 of 211
bOut(lPos) = lTemp \ cl2Exp16 'Shift it downlTemp = lQuad And clMidMask 'Mask for the second bytebOut(lPos + 1) = lTemp \ cl2Exp8 'Shift it downbOut(lPos + 2) = lQuad And clLowMask 'Mask for the third bytelPos = lPos + 3
Next lChar
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.
ExampleMessage
<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>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 191/211
Universal Interface – Technical Specification 7.00.0xx Page 191 of 211
PictureChange
PictureChange message type is sent by the FCUI to inform the external system about the updateof the guest picture. The External System has to respond with an Acknowledge message type.
The message detail is identical to GetPictureResponse
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 192/211
Universal Interface – Technical Specification 7.00.0xx Page 192 of 211
UpdateEMail
UpdateEMail message type is sent by the external system to set/update the onboard email of anaccount in FCSPMS.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9Unique Account ID return fromInquireResponse
RES_ACC
EML X(72) E-Mail Address RES_EMAIL_SHIP
QBP 9 Quick Billing Printing Flag Optional RES_NOBATCH_INVOICE
ACE X(1) Account ID Entry Type Refer to ACE type definition
below
The message is used to update the email address belong to the current guest. The following is adescription of the fields in the message data block.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used as
identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIUnique Account ID return from InquireResponse
EMLeMail address, accept blank and it will remove the e-mail address.
QBPxQuick Billing Printing Flag, 1 – Print Invoice, 0 – Do no print invoice in the Quick Billing Screen,blank will skip update this field.
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined: Default = “I” is no value pass int
C Card identification number (RES_BOARDCC)
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 193/211
Universal Interface – Technical Specification 7.00.0xx Page 193 of 211
I Internal identification number (UXP_A_ID)P Pre generated Random Number (RES_PGID)
Example
Message
<STX>UpdateEMail<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-11
14:10:29<US>ACI=13273495<US>[email protected]<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 194/211
Universal Interface – Technical Specification 7.00.0xx Page 194 of 211
RunReport
RunReport is to run a crystal report and export it to PDF file.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
ACI 9Unique Account ID return fromInquireResponse
RES_ACC
REP X Report ID REP_ID
SE1 X Selecting String 1 optionalCrystal Report SelectionFormula variable
SE2 X Selecting String 2 optional Crystal Report SelectionFormula variable
SE3 X Selecting String 3 optionalCrystal Report SelectionFormula variable
SE4 X Selecting String 4 optionalCrystal Report SelectionFormula variable
ACE X(1) Account ID Entry Type optionalRefer to ACE type definition
below
The message is used to return the Exported PDF file, it is the customer responsibility to not run alengthy report.
REF The field identifies the message source or the destination. Identifier must be unique within the wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe 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 alsoused to eliminate possibility of double postings. Full date and time format is required.
ACIUnique Account ID return from InquireResponse, the crystal report formulation field =SACCOUNTID
REPCrystal Report report id, the report must be create and exists in SPMS first
SE1Crystal report selection formula variable field = SSELSTRING, it can be any value depend on the
configure in the report setup
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 195/211
Universal Interface – Technical Specification 7.00.0xx Page 195 of 211
SE2Crystal report selection formula variable field = SSELSTRING2, it can be any value depend on theconfigure in the report setup
SE3Crystal report selection formula variable field = SSELSTRING3, it can be any value depend on theconfigure in the report setup
SE4Crystal report selection formula variable field = SSELSTRING4, it can be any value depend on theconfigure in the report setup
ACEThe field identifies the type of entry in the Account ID field. The following Account ID Entry Typesare defined: Default = “I” is no value pass int
C Card identification number (RES_BOARDCC)I Internal identification number (UXP_A_ID)P Pre generated Random Number (RES_PGID)
ExampleMessage
<STX>RunReport<US>REF=TV#1<US>RQN=121<US>DTE=1997-09-1114:10:29<US>ACI=13273495<US>REP= PaxAutoBill1<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 196/211
Universal Interface – Technical Specification 7.00.0xx Page 196 of 211
RunReportResponse
RunReportResponse message type is sent by the FCUI to supply the exported PDF file for thespecific report.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
PDF XPDF File content in Base64 string,unlimited length
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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
PDFThis is the PDF file content in base64 encoded string. Please refer to GetPictureResponse how todecode the string.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 197/211
Universal Interface – Technical Specification 7.00.0xx Page 197 of 211
PhoneStart
PhoneStart message type is sent by the FCUI to inform the external system that Fidelio had startthe batch phone check-in process. The External System has to respond with an Acknowledgemessage type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 198/211
Universal Interface – Technical Specification 7.00.0xx Page 198 of 211
PhoneEnd
PhoneEnd message type is sent by the FCUI to inform the external system that Fidelio had startthe batch phone check-in process. The External System has to respond with an Acknowledgemessage type.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 199/211
Universal Interface – Technical Specification 7.00.0xx Page 199 of 211
ChangeCabin
ChangeCabin message type is sent to FCUI to request cabin change.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
CAB X(20) Cabin Number res_cab
ACI 9 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 wholesystem. It can be e.g. a computer name or an IP address. If FCUI computer initiates the messagecomputer name will be used as identifier. If message is passed from FCSPMS through FCUI to anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
CABThis is cabin number you want to assign the guest/crew to.
ACIUnique Account ID
Note:For crew we will not check for cabin availability, for guest we will make sure the cabin is notoverbook.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 200/211
Universal Interface – Technical Specification 7.00.0xx Page 200 of 211
ChangeCabinResponse
ChangeCabinResponse message type is sent by FCUI to indicate cabin change is successful.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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 wholesystem. 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 anexternal system - initiating computer name followed by FCUI computer name will be used asidentifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 201/211
Universal Interface – Technical Specification 7.00.0xx Page 201 of 211
Acknowledge
Acknowledge message type is sent by the external system to confirm any triggered messagecommands successfully received & executed from the FCUI.
Code Type Description Required SPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time Current date and time
COD 9 Acknowledgement Status n/a – to be provided from
external system
The following is a description of the fields in the message data block:
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. This field is alsoused to eliminate possibility of double postings. Full date and time format is required.
CODThe field identifies the status of the acknowledgement (0 –Success, 1-Failure).
ExampleMessage
<STX>Acknowledge<US>REF=FCUI#1<US>RQN=121<US>DTE=2006-10-1114:11:12<US>COD=0<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 202/211
Universal Interface – Technical Specification 7.00.0xx Page 202 of 211
Failure
Failure message type is used to inform sender the requested command was not accepted or datareceived was in the wrong format.
Code Type Description RequiredSPMS DB Field reference
REF X Sender Reference n/a – to be provided from
external system
RQN 9 Sender Request Number n/a – to be provided from
external system
DTE D Date and Time 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:
REFThe field identifies the source or the destination of a message. Identifier must be unique within thewhole system. It can be e.g. a computer name or an IP address. If FCUI computer initiates themessage computer name will be used as identifier. If message is passed from FCSPMS throughFCUI to an external system - initiating computer name followed by FCUI computer name will beused as identifier.
RQNThe field returns the request number that is received from the sender to identify the message.
DTEThe field identifies the date and the time when the message was created. This date and time doesnot change even when the message is repeated due to communication errors. Full date and timeformat is required.
FIDThe field identifies the error number. The following codes were defined:
00 Internal error01 Communication error02 No data found03 Request not accepted
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 203/211
Universal Interface – Technical Specification 7.00.0xx Page 203 of 211
INFThe field identifies the text message describing the failure. The following error messages may bereturned:
100 Unknown error101 Account not found102 Undefined revenue centre104 Credit limit exceeded105 Posting already exists106 Undefined payment type107 Payments to credit card departments not allowed108 Exchange rate not defined109 Payment already exists110 Cannot make posting to a credit department111 Cannot make payment to a debit department112 Payment failed
113
Error account has not been found114 Undefined call type115 Undefined phone number116 No postings or payments found117 Undefined excursion118 No excursions found119 Nothing to book120 Booking or posting failed121 Phone number not correct122 Buyer postings disabled123 Payer postings disabled124 Booking failed. Excursion is already fully booked
125 Booking failed. Only x Adult or Child booking(s) available126 Booking failed. Excursion is not available for Adults or Children127 Clock In Already exist128 Already Clocked Out129 No Messages for this Account130 Invalid Authorization Key131 Invalid PIN Code132 Undefined Cabin133 Invalid Cabin Status134 Booking failed. Only x Adult promotion booking(s) available135 Booking failed. Only x Child promotion booking(s) available136 Booking failed. Only x Adult and Child promotion booking(s) available
137 Invalid Promotion ID or Promotion End150 Invalid Language ID151 Only one tour per pax is allow for Overnight Tour152 Casino Credit Limit Exceeded153 Excursion not allow to book via ITV154 Child Ticket not allow to book via ITV155 Excursions Package not found.156 Undefined package.157 Booking failed. Package is not available for Adults.158 Booking failed. Package is already fully booked.159 Booking failed. Package is not available for Children.160 Please select an invoice for multiple credit card161 Account must have credit card registered as the payment type
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 204/211
Universal Interface – Technical Specification 7.00.0xx Page 204 of 211
162 Invalid email address163 The passenger is underage, casino charges are not allowed164 Invalid Report ID165 Invalid Account ID166 Error message variable depend on the crystal report engine167 Cabin Change only valid for Crew and Guest only168 Reason change cabin fail201 Treatment Group not defines.202 Treatment Item not found.203 No Treatment Available.204 The reason why the SPA booking fail.205 No Promotion Available206 Fidelio DB is Down207 No Active Exchange Rate208 Participant Not Found209 Picture not found300 Event Not Found.
301
Invalid Price Category.302 Undefined event.303 Event not allow to book via ITV304 Booking failed. Event is already fully booked.
305 Booking failed. Account has already reached the 1 Ticket per Person Limit forthis Event.
306 Booking failed. Event has only 1 Ticket per Person Limit.400 No User Define Field Define401 User Define Field Value exceed 100 characters402 Invalid User Define ID403 Invalid cabin number
404 Invalid call type405 Invalid phone number406 Error getting System Details.999 Incorrect parameter values.
ExampleMessage
<STX>Failure<US>REF=POS#2<US>RQN=125<US>DTE=1997-09-1114:11:36<US>FID=101<US>INF=Account not found.<ETX><CHECKSUM>
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 205/211
Universal Interface – Technical Specification 7.00.0xx Page 205 of 211
SPMS Events
FC Management
Change Cabin - This message will trigger when guest is already check-in.
For PBX systemIf 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 systemWhen 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 disableFCUI will send a PHONECABINMOVE
For TV and DiningIf 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 systemFCUI will send EXTCABINMOVE.
Edit Guest, Crew, Staff Information – Message will only trigger when guest already check-inChange of guest name, birth date, on board e-mail address (crew, staff do not have on board e-mailaddress), 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 alreadycheck-in
For PBX, TV and Dining FCUI will send UPDATEPIN
Add New Message or Edit Message for Guest will trigger MessageLight for PBX, TV andDining
Press Light On/Off button in message form will trigger MessageLight for PBX, TV and Dining
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 206/211
Universal Interface – Technical Specification 7.00.0xx Page 206 of 211
Guest Check-In
For PBX systemIf Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX systemFCUI will send PHONECHECKIN
For TV and DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI will send EXTCHECKIN
Guest Check-Out
For PBX systemIf Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX systemFCUI will send PHONECHECKOUT
For TV and DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI 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.
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 207/211
Universal Interface – Technical Specification 7.00.0xx Page 207 of 211
FC Quick Check In
Change Cabin - This message will trigger when guest is already check-in.
For PBX systemIf 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 systemWhen 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 disableFCUI will send a PHONECABINMOVE
For TV and DiningIf 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 systemFCUI will send EXTCABINMOVE.
Edit Guest, Crew, Staff Information – Message will only trigger when guest already check-inChange of guest name, birth date, on board e-mail address (crew, staff do not have on board e-mailaddress), gender, reprint board card
For PBX system FCUI will send PHONECHECKIN
For TV and Dining FCUI will send EXTCHECKIN
Guest Check-In
For PBX systemIf Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX systemFCUI will send PHONECHECKIN
For TV and DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI will send EXTCHECKIN
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 208/211
Universal Interface – Technical Specification 7.00.0xx Page 208 of 211
Guest Check-Out
For PBX systemIf Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX systemFCUI will send PHONECHECKOUT
For TV and DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI will send EXTCHECKOUT
FC ETix Check In, FC Self Check In and FC Security
Guest Check-In
For PBX systemIf 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 DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI will send EXTCHECKIN
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 209/211
Universal Interface – Technical Specification 7.00.0xx Page 209 of 211
FC Administration
Guest Check-In
For PBX systemIf Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX systemFCUI will send PHONECHECKIN
For TV and DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI will send EXTCHECKIN
Guest Check-Out
For PBX systemIf Aircon Message is enable via PBX system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via PBX systemFCUI will send PHONECHECKOUT
For TV and DiningIf Aircon Message is enable via TV or Dining system
CHANGEAIRCONSTATE will be trigger
If Aircon Message is not enable via TV or Dining systemFCUI will send EXTCHECKOUT
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 210/211
Universal Interface – Technical Specification 7.00.0xx Page 210 of 211
Definitions, Acronyms, and Abbreviations
Term Descript ion
FCUI Fidelio Cruise Universal InterfaceFCSPMS Fidelio Cruise Shipboard Property Management SystemExternal Systems Third party software owned by customer that interfaces with Fidelio
Cruise Universal Interface for exchange information. ACK AcknowledgementNAK No AcknowledgementCrew/Crew Members Crew members on cruise vessel (shipboard employees)Guests Passengers on cruise vesselPBX Telephone Exchange System (External System)
iTV Interactive Television System (External System)Internet Protocol (IP) "The internet protocol provides for transmitting blocks of data called
datagrams from sources to destinations, where sources anddestinations are hosts identified by fixed length addresses." (RFC791)
Person Reservation account for guest, crew, visitor and resident
7/25/2019 Universal Interface - Technical Specification 7.00.0xx (1)
http://slidepdf.com/reader/full/universal-interface-technical-specification-7000xx-1 211/211
References
Below find other documents and/or utilities referenced within, their respective purpose, and location:
n/a