SPECIFICATIONS OF TRANSMISSION

BETWEEN PMS AND PCs OF

AL5H PC SYSTEM

(TEXT VERSION)

Rev.A Oct 28, 2002

Rev.B March 5, 2003
Rev.C July 10, 2003
Rev.D Oct 17, 2008
Rev.E Aug 30, 2013

MIWA LOCK CO., LTD.

Copyright (C) MIWA LOCK Corp. ALL RIGHT RESERVED 2002
 Table of Contents

1. Introduction......................................................................................................................................................................... １
2. General ................................................................................................................................................................................. ２
2.1 Text Type..................................................................................................................................................................... ２
3. Text Sequence ..................................................................................................................................................................... ３
4. Text format .......................................................................................................................................................................... ４
4.1 Terminal Status Command (CES)......................................................................................................................... ４
4.2 Terminal Status Response (RES)........................................................................................................................... ４
4.3 Issue Guest Card Command (DIC)........................................................................................................................ ５
4.4 Issue Guest Card Response (PIC) .......................................................................................................................... ８
4.5 Read Guest Card Command (DRC) ...................................................................................................................... ９
4.6 Read Guest Card Response (PRC) ......................................................................................................................... ９
4.7 Room Check-out Command (DCO).................................................................................................................... １１
4.8 Room Check-out Response (PCO) ...................................................................................................................... １２
4.9 Error Notify Response (RER).............................................................................................................................. １３
4.10 Room Reserve Command (DRV)...................................................................................................................... １４
4.11 Room Reserve Response (PRV) ........................................................................................................................ １５
Note:

（１） Reproduction, copying or transcription of entire or part of this document without

prior approval of the Company will infringe the rights of the author and/or publisher of this
document unless otherwise approved by laws .

（２） The specifications described in this document may be subject to change without
notice for improvements, and may not necessarily be consistent with practical use of the
system.
1. Introduction
This document explains the specifications of interface between personal computers
(referred as “PC” hereunder) and PMS in the AL5H-PC NETWORK SYSTEM..

This document is particularly designed to clearly define the commands and responses used
in the system.
Refer to “AL5H PC SYSTEM SOFTWARE FOR DATA TRANSMISSI BETWWEN PMS
AND PCs” for protocol and transmission rules (transmission procedure).

１
2. General

2.1 Text Type

No. Text Text Name Function Sender

ID
1 CES Terminal Status Request for status of the terminal designated. PMS→PC
Command
2 RES Terminal Status Notify of the status of the terminal designated. PC→PMS
Response
3 DIC Issue Guest Card Instruct the terminal designated to issue a guest PMS→PC
Command card of particular type.
4 PIC Issue Guest Card Notify of result of issuing the guest card at the PC→PMS
Response terminal designated.
5 DRC Read Guest Card Instruct a terminal designated to read a guest card PMS→PC
Command of particular type.
6 PRC Read Guest Card Notify of result of reading the guest card at the PC→PMS
Response terminal designated.
7 DCO Room Check-out Instruct check-out to the designated room. PMS→PC
Command
8 PCO Room Check-out Notify of the check-out result of the designated PC→PMS
Response room.
9 RER Error Notify Notify of text failure or operational failure PC→PMS
Response for a text sent by the PMS.
10 DRV Room Reserve Reserve a room that will be issued by KIOSK PMS→PC
Command terminal.
11 PRV Room Reserve Notify of the processing result of room reservation. PC→PMS
Response

２
3. Text Sequence

ＰＭＳ ＰＣ Terminal

CES
Terminal Status
Command (CES)
Terminal Status
RES Response (RES)

DIC
Issue Guest Card
Instruct to issue
Command (DIC)
guest card
Issuing
card
Issue completed
Issue Guest Card
PIC Response (PIC)

DRC
Read Guest Card Instruct to read
Command (DRC) guest card
Reading
card
Read completed
Read Guest Card
PRC Response (PRC)

Room Check-out DCO

Command (DCO)

Room Check-out
PCO Response (PCO)

Invalid Text
(Cxx or Dxx)
Error Notify
RER Response (RER)

３
4. Text format

4.1 Terminal Status Command (CES)

Function: Request a PC for status of terminal designated.

Col Data Digits

1
TEXT ID
2 3
“CES”
3
4 Terminal
2
5 ID

(1) Terminal ID
“01”～“99”

4.2 Terminal Status Response (RES)

Function: Notify PMS of the status of the terminal designated.

Col Data Digits

1
TEXT ID
2 3
“RES”
3
4 Terminal
2
5 ID
Terminal
6 1
Type
Terminal
7 1
Status

(1) Terminal ID
“01”～“99”

(2) Terminal Type

1: FDS
2: Motor encoder (MCR or K-ME)

(3) Terminal Status

0: Ready
1: In used by terminal(KB)
2: In used by PC
3: In used by PMS
4: Terminal not connect (No response from terminal)

４
4.3 Issue Guest Card Command (DIC)

Function: Instruct the terminal designated to issue a guest card of particular type.

Col Data Digits Col Data Digits

1 77
TEXT ID
2 3 :
“DIC” :
3
4 Terminal :
2 :
5 ID Reserve 32
6 Issue Type 1 :
7 :
Card Type 2 :
8
9 :
: 108
: 109
Check-in :
: 10
Date Time :
:
: :
18 :
19 : Special Flag 40
: :
: :
Check-out :
: 10
Date Time :
:
: 148
28 149
Issue Number 2
29 150
: 151
: Main Room :
8 :
: No．
: :
POS
36 : 37
Information
37 :
: :
: Second Room :
8 187
: No.1
: 188
44 :
45 : Staff Code 6
: :
: 193
: 194
: 195
Second Room Reserve 4
: 32 196
No.2～5 197
:
:
:
:
76

Note: Fill the reserve area with “0” or space code.

５
(1) Terminal ID
“01”～“99”

(2) Issue Type

1 : Normal issue
2 : Re-issue
3 : Additional issue

* Assign dummy “0” if card type is “MT.”

(3) Card Type

“GA”: Guest Card A (Magnetic stripe card)
“GB”: Guest Card B (IC card)
“MT”: Maintenance Card (Magnetic stripe card)

(4) Check-in Date Time, Check-out Date Time

・Enter in “YMMDDHHMM” format.
・Assign year in last two digits, and time in 24 hours.
・Allow up to 365 days for date of check-in for advance issue.
・Allow up to 356 days for accommodation of a guest card.
・When you carry out additional issue, check in date/time or check out date/time have to be made B
in agreement, or overlap a stay period as the target issued card.

*1 The check-in and check-out of MT card is assigned valid today only.

*2 The minute of the date of check-out is not encoded on the card.

(5) Main Room No.

・Main room No. consists of six (6) digits.

(6) Second Room No.1 - 5

・Second No. consists of six (6) digits.
・If the card type is GA or MT, the second room No. 1 only can be assigned.
If it is GB, up to five (5) rooms can be assigned.
・If no second room is not required, assign it all “0” as dummy.

(7) Special Flag

・This entry is encoded as “special flag” on the card.
・One special flag is assigned to one door, and up to 40 flags can be assigned.
・Assign “Y” for enable, and “N” for disable.
・All “0” are assigned by PC.

(8) Issue Number

The number of cards to be issued
・ Assign the number of cards to be issued from “01” through “99.”
・ Assign one card fixed for the “MT” card.

６
(9) POS Information
・Assign data to be written on the first track of ISO.
・Up to 37 characters can be assigned for any type of information, C
however, characters except for numbers (0～9）cannot be assigned.
・Assign all “0” for no POS requirements.

【Example of use】
1･･･････････････8 9････････････････18 19･･･････････････28 29 30 31･･････37

Check-in Check-out
Issue
Main Room No. Date/Time Date/Time Reserve
No.
YYMMDDHHMM YYMMDDHHMM

8 10 10 2 7

(10) Staff Code

・Assign the staff code of an employee who instructed to issue a guest card.
・Because it is an optional requirement, assign “000000” as dummy if not necessary.

７
4.4 Issue Guest Card Response (PIC)

Function: Notify of the result of operation for instruction of issuing a guest card

Col Data Digits

1
TEXT ID
2 3
“PIC”
3
4 Terminal
2
5 ID
6 Action Result 1
7 Issued
2
8 Number

(1) Terminal ID
“01”～“99”

(2) Action Result

・Result of guest card issue
0 : Normally completed
1 : Card issue error
2 : Card jam
3 : Card operation(insert or swipe) time out
6 : Not found issued data (Only at additional issue)
7 : Room occupied *1
9 : Other error

*1) When double issue check for the PMS issue is specified by PC setting,
and the specified room (and check-in, check-out) is already issued, it's returned.

(3) Issued Number

・Number of cards normally issued.

８
4.5 Read Guest Card Command (DRC)

Function: Instruct the terminal designated to read the guest card of particular type
or maintenance card.

Col Data Digits

1
TEXT ID
2 3
“DRC”
3
4 Terminal
2
5 ID

(1) Terminal ID
“01”～“99”

4.6 Read Guest Card Response (PRC)

Function: Notify of the result of operation for instruction of reading a guest card
or maintenance card.

Col Data Digits

1
TEXT ID
2 3
“PRC”
3
4 Terminal
2
5 ID
6 Action Result 1
7
:
:
:
Card Key
: 144
Information
:
:
:
150
151
:
: POS
37
: Information
:
187

９
(1) Terminal ID
“01”～“99”

(2) Action Result

・Result of guest card reading
0 : Normally completed
1 : Card read error
2 : Card jam
3 : Card operation (insert or swipe) time out
4 : Other cards than guest or maintenance cards
5 : Other error

(3) Card Key Information

・Assign the same format as the card key format for instruction of issuing a guest card.
(columns 7 - 150)
However, assign an “ Issue No.” for the card sequence number. (1～Number of issued)
・No assignment should be made unless the result of operation is “0.”

(4) POS Information

・No assignment should be made unless the result of operation is “0” and the POS
information exists.

１０
4.7 Room Check-out Command (DCO)

Function: Instruct check-out to the designated room.

Col Data Digits

1
TEXT ID
2 3
“DCO”
3
4 Terminal Type 1
5 Reserve 1
6
:
Room No. 6
:
11
12
:
Check-in
: 10
Date Time
:
21
22
:
Check-out
: 10
Date Time
:
31
32
Staff
: 6
Code
37
38
: Reserve 3
40

(1) Terminal ID
"00" : Fixed (no check in PC)
(1) Terminal Type
"0": PMS terminal
"1": KIOSK terminal

(2) Room No.

・Assign the room number that wants to be checked out.

(3) Check-in Date Time(CI), Check-out Date Time(CO)

・Assign the date range that wants to be checked out in “YMMDDHHMM” format.
・The issued data that overlaps with the range of the date from CI to CO is deleted.

【Example】
A B
Issued data of PC CI CO CI CO

1) PMS specified CI-CO

⇒ delete A
2) PMS specified CI-CO
⇒ delete A and B
3) PMS specified CI-CO
⇒ delete B

１１
 (4) Staff Code
・Assign the staff code who instructed to check out, assign all "0" in case of unknown.

(5) Reserve
・Assign with ALL "0".

4.8 Room Check-out Response (PCO)

Function: Notify of the check-out result of the designated room.

Col Data Digits

1
TEXT ID
2 3
“PCO”
3
4 Terminal Type 1
5 Reserve 1
6 Action Result 1

(1) Terminal ID
・Same as Terminal ID of the DCO command.
(1) Terminal Type
・Same as Terminal Type of the DCO command.

(2) Action Result

・Result of the room check-out.
0 : Normal
1 : Not found issued data
1 : The room is during the issuing process by PMS.
2 : Not found issued data
9 : Other error

* When the DCO command text is invalid (the following), RER response is returned.
・Room does not exist.
・Check-in or check-out date time is invalid.
・Range of the date time (from check-in to check-out) is invalid.

１２
4.9 Error Notify Response (RER)

Function: Notify of failures in text and operation.

This response is a substitute of the following status for the response to the command text
issued by the PMS.

・The terminal designated fails.

・Non-existing text ID is received.
・Operational instruction to a non-existing terminal is received.

Col Data Digits

1
TEXT ID
2 3
“RER”
3
4 Terminal
2
5 ID
6 Error Code 1

(1) Terminal ID
・The terminal ID is sent as received.
“01”～“99”

(2) Error Code

・Assign failure for command text or failure in operation of the terminal.
1 : In used by terminal(KB).
2 : In used by PC.
3 : In used by PMS.
4 : Failure in terminal.
5 : No response from terminal.
6 : Failure in text (Invalid text ID and invalid terminal ID, etc.)
7 : (unused)

１３
4.10 Room Reserve Command (DRV)

Function: Reserve a room that will be issued by KIOSK terminal.

Col Data Digits Col Data Digits

1 77
TEXT ID
2 3 :
“DRV” :
3
4 :
Reserve 2 :
5 Reserve 32
6 Issue Type 1 :
7 :
Card Type 2 :
8
9 :
: 108
: 109
Check-in :
: 10
Date Time :
:
: :
18 :
19 : Special Flag 40
: :
: :
Check-out :
: 10
Date Time :
:
: 148
28 149
Issue Number 2
29 150
: 151
: Main Room :
8 :
: No．
: :
POS
36 : 37
Information
37 :
: :
: Second Room :
8 187
: No.1
: 188
44 :
45 : Staff Code 6
: :
: 193
: 194
: 195
Second Room Reserve 4
: 32 196
No.2～5 197
:
:
:
:
76

Note: The contents of each data item is the same as the "4.3 Issue Guest Card Command (DIC)".

１４
4.11 Room Reserve Response (PRV)

Function: Notify of the processing result of room reservation.

Col Data Digits

1
TEXT ID
2 3
“PRV”
3
4 Terminal
2
5 ID
6 Action Result 1

(1) Terminal ID
"00" : Fixed (no check in PC)

(2) Action Result

0 : Normal
1 : Room occupied
9 : Other error

１５