Select your printer model
<open_commbox>
Requests for opening the communication box and notifies the application of the acquired request result.
ePOS-Device Service creates a communication box and add the application as a member of the communication box.
Request
Element |
Data type |
Description |
---|---|---|
sequence |
string |
Specifies the sequence number. |
data |
string |
Specifies the data of the communication box to open. |
data
Child element |
Data type |
Description |
---|---|---|
box_id |
string |
Identifier of the communication box to open |
member_id |
string |
Member ID used by the application to identify itself within the communication box |
Sample program
<open_commbox> <sequence>1</sequence> <data> <box_id>box1</box_id> <member_id>member1</member_id> </data> </open_commbox> |
Response
Element |
Data type |
Description |
---|---|---|
sequence |
string |
Sequence number specified in the request |
data |
string |
Result of opening the communication box |
data_id |
string |
ID to identify sent data |
data
Child element |
Data type |
Description |
---|---|---|
box_id |
string |
Identifier of the opened communication box |
code |
string |
Result of opening the communication box |
- code
-
Element value
Description
"OK"
Communication box opened successfully.
“ALREADY_OPENED”
Communication box is already open.
“MEMBERID_ALREADY_USED”
Specified member ID is already in use.
“BOX_COUNT_OVER”
The number of created communication boxes has exceeded the upper limit.
“BOX_CLIENT_OVER”
The number of members belong to the communication box has exceeded the upper limit.
“ERROR_NOT_SUPPORTED“
The printer does not support the requested function.
“PARAMETER_ERROR”
A parameter error occurred.
“SYSTEM_ERROR”
A system error occurred.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- Message
- CommunicationBox Messages
- Device Messages
- DeviceHubTerminal
- BarcodeScanner
- Printer
- <type>print</type>
- <type>onxmlresult</type>
- <epos-print>
- <response>
- <text>
- <feed>
- <image>
- <logo>
- <barcode>
- <symbol>
- <hline>
- <vline-begin>
- <vline-end>
- <page>
- <area>
- <direction>
- <position>
- <line>
- <rectangle>
- <cut>
- <pulse>
- <sound>
- <command>
- <layout>
- <recovery>
- <reset>
- <batch-begin>
- <batch-end>
- <rotate-begin>
- <rotate-end>
- HybridPrinter
- <type>lock</type>
- <type>unlock</type>
- <type>print</type>
- <type>onxmlresult</type>
- <type>slipwaitinsertion</type>
- <type>slipprint2</type>
- <type>slipcancel</type>
- <type>endorsewaitinsertion</type>
- <type>endorseprint2</type>
- <type>endorsecancel</type>
- <type>validationwaitinsertion</type>
- <type>validationprint2</type>
- <type>validationcancel</type>
- <type>micrread</type>
- <type>micrcleaning</type>
- <type>micrcancel</type>
- <type>eject</type>
- <type>onreceive</type>
- CustomerDisplay
- Keyboard
- POSKeyboard
- MSR
- SerialDevice
- Storage
- OtherPeripheral
- Appendix