Star webPRNT User's Manual

StarWebPRNTExtManager Response Element


NameDescriptionStar webPRNT
Browser		Star printer
with
Star webPRNT *1
<root>Root Element✓*2✓
<success>Success code Element✓*2✓
<code>Result code Element✓*2✓
<claim>StarWebPRNTExtManager claim status Element✓*2✓
<claimid>ID element of StarWebPrintExtManager Claim management✓*2✓
<eventcount>Number of event occurrence element of StarWebPrintExtManager✓*2✓
<event>Event element of StarWebPRNTExtManager✓*2✓
<action>Name of event element of StarWebPrintExtManager✓*2✓
<data>Data information of event element of StarWebPrintExtManager✓*2✓
<number>Order of event occurrence element of StarWebPrintExtManager✓*2✓

*1 Star printer with IFBD-HI01X/02X.
mC-Print2/mC-Print3 with printer firmware version 2.1 or later (SSL is not supported).

*2 SM-L200 and SM-L300 are not supported with Star webPRNT Browser for iOS.

 to Top

<root>

Root Element

Attribute

NameDescriptionOmission
---

Value

Description
List of StarWebPRNTExtManager Response Element
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 to Top

<success>

Success code Element

Attribute

NameDescriptionOmission
---

Value

Description
Success code of the communication with printer
  • true … Communication succeeded
  • false … Communication failed
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 to Top

<code>

Result code Element

Attribute

NameDescriptionOmission
---

Value

Description
Result code
  • 0 … Success
  • 1010 … Printer unconnected state
  • 2001 … Printer busy(In use with another device: Need to resend data)
  • 3000 … Claim non-acquired state
  • 3001 … Not supported
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 to Top

<claim>

Claim status Element of StarWebPrintExtManager

Attribute

NameDescriptionOmission
---

Value

Description
claim status
  • true … claim acquired state
  • false … claim non-acquired state
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 to Top

<claimid>

ID element of StarWebPrintExtManager Claim management

Attribute

NameDescriptionOmission
---

Value

Description
ID of Claim management
An ID shall be given using the extmanager element from the next time.
*An ID is automatically given by StarWebPrintExtManager.js.
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 to Top

<eventcount>

Number of event occurrence element of StarWebPrintExtManager

Attribute

NameDescriptionOmission
---

Value

Description
Number of StarWebPrintExtManager event occurrence
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 to Top

<event>

Event element of StarWebPRNTExtManager

Attribute

NameDescriptionOmission
---

Value

Description
Received string of 1 event that occurred
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 to Top

<action>

Name of event element of StarWebPrintExtManager

Attribute

NameDescriptionOmission
---

Value

Description
Name of event that occurred
  • onReceive … Communication success event
  • onError … Communication error event
  • onPrinterImpossible … Notified that the printer cannot be used
  • onPrinterOnline … Notified that the printer is online
  • onPrinterOffline … Notified that the printer is offline
  • onPrinterPaperReady … Notified that the printer paper is ready
  • onPrinterPaperNearEmpty … Notified that the printer paper is near empty
  • onPrinterPaperEmpty … Notified that the printer paper is empty
  • onPrinterCoverOpen … Notified that the printer cover is open
  • onPrinterCoverClose … Notified that the printer cover is closed
  • onCashDrawerOpen … Notified that the cash drawer is open
  • onCashDrawerClose … Notified that the cash drawer is closed
  • onBarcodeReaderImpossible … Notified that the barcode reader cannot be used
  • onBarcodeReaderConnect … Notified that the barcode reader is connected
  • onBarcodeReaderDisconnect … Notified that the barcode reader is disconnected
  • onBarcodeDataReceive … Notified that the barcode reader data received
  • onAccessoryConnectSuccess … Notified that the accessory(Bluetooth) connect is success
  • onAccessoryConnectFailure … Notified that the accessory(Bluetooth) connect is failure
  • onAccessoryDisconnect … Notified that the accessory(Bluetooth) is disconnected
  • onStatusUpdate … Notified that the printer status is updated
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 to Top

<data>

Data information of event element of StarWebPrintExtManager

Attribute

NameDescriptionOmission
---

Value

Description
For onBarcodeDataReceive event
  • Bar code data information(Base64 encoding)

For onStatusUpdate event
  • Status information
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onBarcodeDataReceive</action>
        <number>MjQ4NzQxNDA0MDYwMjMyOA0K</number>
    </event>
<root>
 to Top

<number>

Order of event occurrence element of StarWebPrintExtManager

Attribute

NameDescriptionOmission
---

Value

Description
Order of events that occurred
  • 0 … Event that occurred first
  • eventcout value - 1 … Event that occurred last
Example
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 to Top