NEC Property Management System Communication Interface Specification

							NDA-30115  Revision 1.0Page 71
Property Management System - Communication Interface Message Formats
Extension 
Assignment 
Report
Figure 4-46   Extension Assignment Report
Message fields are:
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Def -- Defines the extension to be either an administration extension or a guest 
extension. Codes are:
0 -- Administration
1 -- Guest
Class -- The room class designated at the time of extension assignment.
‘1’‘7’‘1’‘3’‘F’Extension Def
Class
01234 6 89 15
STX SA UA EI FTC MSC FC 6 1
02H‘1’‘!’‘L’
03H xx
ETX BCC1
16 17 18 
						

							Page 72NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Room Recovery (Model 60)
These messages are used by the PMS to update the database in the Model 60 
version of the NEAX. First a Recovery Start Report (70-3) is sent. Then, one or 
more sets of Room Image messages are sent. Finally, a Recovery End Report (70-
4) is sent.
The messages are grouped into a set of four messages. Within each set of four 
messages the format of the messages is identical, except for the Function Codes, 
which specify the message. Each set of messages contain more fields (and can 
therefore convey more information) than the preceding set.
Each set of four messages is itself a set of two pairs of messages. The first pair of 
messages is used when the PMS, in normal operation (i.e. not error recovery), 
needs to update the information on a given extension. The second pair of messages 
is used during recovery. This pair will only be used in response to the NEAX 
sending a Nop Test Recover Answer or Recovery Request message.
The first message (of either pair) is used by the PMS as an update/ request for 
information on an extension. If a field contains a valid entry, the NEAX database 
is updated; if the field is entirely filled with NULL (00H) characters, it is a request 
for the NEAX to send the value from the NEAX database. The second message is 
the response from the NEAX to the PMS.
17-1 -- Room Image Set 1 (Normal Request from PMS)
17-2 -- Room Image Set 1 (Normal Answer from NEAX)
17-3 -- Room Image Set 1 (Recovery Request from PMS)
17-4 -- Room Image Set 1 (Recovery Answer from NEAX)
17-5 -- Room Image Set 2 (Normal Request from PMS)
17-6 -- Room Image Set 2 (Normal Answer from NEAX)
17-7 -- Room Image Set 2 (Recovery Request from PMS)
17-8 -- Room Image Set 2 (Recovery Answer from NEAX)
17-9 -- Room Image Set 3 (Normal Request from PMS)
17-A -- Room Image Set 3 (Normal Answer from NEAX)
17-B -- Room Image Set 3 (Recovery Request from PMS)
17-C -- Room Image Set 3 (Recovery Answer from NEAX) 
						

							NDA-30115  Revision 1.0Page 73
Property Management System - Communication Interface Message Formats
Room Image Set 1
Figure 4-47   Room Image Set 1
The message fields are:
FC -- Function Codes that use this message format are: (FTC-FC)
17-1 -- Room Image Set 1 (Normal Request from PMS)
17-2 -- Room Image Set 1 (Normal Answer from NEAX)
17-3 -- Room Image Set 1 (Recovery Request from PMS)
17-4 -- Room Image Set 1 (Recovery Answer from NEAX)
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Vacancy -- Vacancy/Occupancy flag. The possible values are:
0 -- Vacant.
1 -- Occupied.
Status - Message Waiting status. The possible values are:
0 -- Message Waiting Lamp is off.
1 -- Message Waiting Lamp is on.
Code -- Restriction code for this extension. The possible codes are:
0 -- Do Not Disturb and Room Cut-Off are cancelled.
1 -- Room Cut-Off is set, Do Not Disturb is cancelled.
5 -- Do Not Disturb is set, Room Cut-Off is cancelled.
6 -- Do Not Disturb and Room Cut-Off are set.
Blank -- Field contains 14 space (20H) characters.
‘1’‘7’‘2’‘8’**Extension Vacancy
StatusCodeBlank
** Multiple Function Codes use this message. See below.
01234 6 89 15
STX SA UA EI FTC MSC FC 6 1
02H‘1’‘!’‘L’
03H xx
ETX BCC1114
16 17 18 32 33 
						

							Page 74NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Room Image Set 2
Figure 4-48   Room Image Set 2
The message fields are:
FC -- Function Codes that use this message format are: (FTC-FC)
17-5 -- Room Image Set 2 (Normal Request from PMS)
17-6 -- Room Image Set 2 (Normal Answer from NEAX)
17-7 -- Room Image Set 2 (Recovery Request from PMS)
17-8 -- Room Image Set 2 (Recovery Answer from NEAX)
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Vacancy -- Vacancy/Occupancy flag. The possible values are:
0 -- Vacant.
1 -- Occupied.
Status - Message Waiting status. The possible values are:
0 -- Message Waiting Lamp is off.
1 -- Message Waiting Lamp is on.
Code -- Restriction code for this extension. The possible codes are:
0 -- Do Not Disturb and Room Cut-Off are cancelled.
1 -- Room Cut-Off is set, Do Not Disturb is cancelled.
5 -- Do Not Disturb is set, Room Cut-Off is cancelled.
6 -- Do Not Disturb and Room Cut-Off are set.
Vacancy
StayReserveLanguageCleaning
Wake UpWake Up
** Multiple Function Codes use this message. See below.Status
ResultStatus
Time
‘1’‘7’‘2’‘3’**Extension
01234 6 89 15 16
STXSAUAEIFTCMSCFC611
02H‘1’‘!’‘L’
03H xx
ETX BCC
11111
17 18 19 20 21
Code
22 23 27 28
14 
						

							NDA-30115  Revision 1.0Page 75
Property Management System - Communication Interface Message Formats
Stay -- Room stay. The possible values are listed below:
Reserve -- Reserve flag. Possible values are:
0 -- Room is not reserved
1 -- Room is reserved.
Language -- Language category for the guest. The possible values are:
0 -- Not specified
1 -- Japanese
2 -- English
3 -- German
4 -- French
5 -- Spanish
6 -- Chinese
7 -- Russian.
Cleaning Status -- The possible values are:
1 -- Cleaning Started
2 -- Cleaning Ended
3 -- Cleaning Check Ended.
Wake Up Result -- This indicates the result of the wake up call. The possible 
values are:
1 -- Answer
2 -- Busy
3 -- No Answer
4 -- Block
5 -- Call Termination to Attendant Console
Wake Up Time -- The time for which the wake up call is set. Format used is 
HHMM using military time.
Stay
1
2
3
4VIP
No
Ye s
No
Ye sOut
No (Key is not in key rack.)
No (Key is not in key rack.)
Yes (Key is in key rack.)
Yes (Key is in key rack.) 
						

							Page 76NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Room Image Set 3
Figure 4-49   Room Image Set 3
The message fields are:
FC -- Function Codes that use this message format are: (FTC-FC)
17-9 -- Room Image Set 3 (Normal Request from PMS)
17-A -- Room Image Set 3 (Normal Answer from NEAX)
17-B -- Room Image Set 3 (Recovery Request from PMS)
17-C -- Room Image Set 3 (Recovery Answer from NEAX)
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Vacancy -- Vacancy/Occupancy flag. The possible values are:
0 -- Vacant.
1 -- Occupied.
Status - Message Waiting status. The possible values are:
0 -- Message Waiting Lamp is off.
1 -- Message Waiting Lamp is on.
Code -- Restriction code for this extension. The possible codes are:
0 -- Do Not Disturb and Room Cut-Off are cancelled.
1 -- Room Cut-Off is set, Do Not Disturb is cancelled.
5 -- Do Not Disturb is set, Room Cut-Off is cancelled.
6 -- Do Not Disturb and Room Cut-Off are set.
Blank 1
CleaningWake Up
Result Status
Group IDBlank 2
** Multiple Function Codes use this message. See below.
Vacancy
StayReserveLanguage
Wa k e  U pStatus
Time
‘1’‘7’‘3’‘8’**Extension
01234 6 89 15 16
STXSAUAEIFTCMSCFC611
02H‘1’‘!’‘L’
ETX BCC
111111
17 18 19 20 21 22
Code
23 27 32 38 42 43
4564
03H xx 
						

							NDA-30115  Revision 1.0Page 77
Property Management System - Communication Interface Message Formats
Stay -- Room stay. The possible values are listed below:
Reserve -- Reserve flag. Possible values are:
0 -- Room is not reserved
1 -- Room is reserved.
Language -- Language category for the guest. The possible values are:
0 -- Not specified
1 -- Japanese
2 -- English
3 -- German
4 -- French
5 -- Spanish
6 -- Chinese
7 -- Russian.
Cleaning Status -- The possible values are:
1 -- Cleaning Started
2 -- Cleaning Ended
3 -- Cleaning Check Ended.
Wake Up Result -- This indicates the result of the wake up call. The possible 
values are:
1 -- Answer
2 -- Busy
3 -- No Answer
4 -- Block
5 -- Call Termination to Attendant Console
Wake Up Time -- The time for which the wake up call is set. Format used is 
HHMM using military time.
Blank 1 -- Field contains five space (20H) characters.
Group ID -- Group number for the extension. If the group number is less than 
six digits, left justify the number and fill the remaining bytes with space (20H) 
characters.
Blank 2 -- Field contains four space (20H) characters.
Stay
1
2
3
4VIP
No
Ye s
No
Ye sOut
No (Key is not in key rack.)
No (Key is not in key rack.)
Yes (Key is in key rack.)
Yes (Key is in key rack.) 
						

							Page 78NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Room Recovery (Model 90)
These messages are only used by the Model 90. When the PMS receives a Nop Test 
Recover Answer (70-2) message, it sends one Room Data Report message for each 
room. Prior to sending any recovery messages, however, a Recovery Start Report 
(70-3) must first be sent. Recovery is concluded by sending a Recovery End Report 
(70-4).
The Room Recovery messages use the following Function Codes:
57-1 -- Room Data Report
57-3 -- Guest Room Secretary Telephone
57-4 -- Connecting Room
57-5 -- Message Status Report
57-6 -- Wake Up
Room Data Report
Figure 4-50   Room Data Report
If Room Status is set to ‘0’ and Cleaning Status is set to either ‘3’ or ‘4’, the room 
data is cleared.
The message fields are:
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Group ID -- Group number for the extension. If the group number is less than 
six digits, left justify the number and fill the remaining bytes with space (20H) 
characters.
Room Status -- Room status. This flag is used in conjunction with the cleaning 
status flag to determine the status of the room.
‘5’‘7’‘4’‘6’‘1’ExtensionGroup ID
KeyVIPLanguageDisplay
Data BData ARoom
Status
01234 6 89 15 21
STXSAUAEIFTCMSCFC661
02H‘1’‘!’‘L’
03H xx
ETX BCC
111116
22 23 24 25 26
42 45 50 51
35
Name Cleaning
Status 
						

							NDA-30115  Revision 1.0Page 79
Property Management System - Communication Interface Message Formats
Cleaning Status -- Cleaning status. The possible combinations with room status 
are listed below:
Key -- Room key status:
0 -- Key is in the key rack.
1 -- Key is not in the key rack.
VIP -- VIP category:
0 -- Guest is not a VIP.
1 -- Guest is a VIP.
Language -- Language category for the guest. The possible values are:
0 -- Not specified
1 -- Japanese
2 -- English
3 -- German
4 -- French
5 -- Spanish
6 -- Chinese
7 -- Russian.
Display Name -- The display name of the guest. The name must be left justified, 
and any remaining space must be filled with space (20H) characters.
Data A & B-- Condition Data A and B. The contents of the option data are to be 
assigned on an individual hotel basis.
2
2
0
0
0
00
1
0
1
2
4Stay, Departure Day
Stay, Departure Day, Cleaning in progress
Out (Checked Out)
Out, Cleaning in progress
Out, Cleaning ended
Out of Order (Cannot sell) Room
0
1
1Clean
3
0
1Status of the Room
Vacant (Ready to sell)
Stay (Occupied)
Stay, Cleaning in progress
1
12
3Stay, Cleaning ended
Stay, Inspected 
						

							Page 80NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Guest Room 
Secretary 
Telephone
Figure 4-51   Guest Room Secretary Telephone
The message fields are:
Boss -- Extension number of the boss. If the extension number is less than six 
digits, left justify the number and fill the remaining bytes with space (20H) 
characters.
Secty -- Extension number of the secretary. The secretary’s extension is now 
associated with the boss’s extension. If the extension number is less than six 
digits, left justify the number and fill the remaining bytes with space (20H) 
characters.
Connecting Room
Figure 4-52   Connecting Room
The message fields are:
Master -- Extension number of the master extension. If the extension number is 
less than six digits, left justify the number and fill the remaining bytes with 
space (20H) characters.
Secondary -- Extension number of the secondary extension. The secondary 
extension is now associated with the master extension. If the extension number 
is less than six digits, left justify the number and fill the remaining bytes with 
space (20H) characters.
‘5’‘7’‘1’‘7’‘3’BossSecty
01234 6 89 15 2122
STX SA UA EI FTC MSC FC 6 6
02H‘1’‘!’‘L’03H xx
ETX BCC
‘5’‘7’‘1’‘7’‘4’MasterSecondary
01234 6 89 15 2122
STX SA UA EI FTC MSC FC 6 6
02H‘1’‘!’‘L’03H xx
ETX BCC