1. TOP»
  2. ePOS-Device XML »
  3. CommunicationBox Messages »
  4. <type>getcommhistory</type>

Select your printer model

Parameters are refined by the selected printer.

<type>getcommhistory</type>

Requests for the transmission history of the communication box and notifies the application of the acquired request result.

Request

Child element

Data type

Description

box_id

string

Specifies the identifier of the communication box to acquire.

all_history

boolean

Specifies whether or not to acquire the entire transmission history of the communication box.

all_history

Attribute value

Description

"true" / "1”

Acquires the entire transmission history of the communication box.

“false” / “0”

Acquires the transmission history of data sent to the own member ID only.

Sample program

 
 
<commbox_data>
	<sequence>4</sequence>
	<data>
		<type>getcommhistory</type>
		<box_id>box1</box_id>
	</data>
</commbox_data>

Response

Child element

Data type

Description

box_id

string

Identifier of the acquired communication box

code

string

Result of sent data

history_list

string

Acquired transmission history

code

Attribute value

Description

"OK"

Acquisition of the transmission history of the communication box succeeded.

"NOT_OPENED"

The communication box is not open.

“SYSTEM_ERROR”

A system error occurred.

history_list

Child element

Description

senderId

The member ID of the sender

receiverId

The member ID of the receiver

message

Received message

Sample program

 
 
<commbox_data>
	<sequence>4</sequence>
	<data>
		<type>getcommhistory</type>
		<box_id>box1</box_id>
		<code>OK</code>
		<history_list>
		<senderId>member1</senderId>
		<receiverId></receiverId>
		<message>send_message3</message>
		</history_list>
		<history_list>
		<senderId>member1</senderId>
		<receiverId></receiverId>
		<message>send_message2</message>
		</history_list>
		<history_list>
		<senderId>member1</senderId>
		<receiverId></receiverId>
		<message>send_message</message>
		</history_list>
	</data>
	<data_id>10</data_id>
</commbox_data>

Supplementary explanation

  • If the “all_history” child element is omitted, “false”/“0” is specified.
  • <history_list> is notified for the number of transmission histories acquired.
  • The <history_list> child element stores data in the descending order of dates.
 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]
ePOS-Device XML includes patented or patent pending functions. The contents must not be disclosed to third parties.


ePOS-Device XML

  1. TOP»
  2. ePOS-Device XML »
  3. CommunicationBox Messages »
  4. <type>getcommhistory</type>

Jump to the top