Epson KDS Expansion Box KD-IB01 KDS User Manual - KDS API - Page 17

Callback Registration

Page 17 highlights

5.8.3 Status Error Response KDS will send back a response indicating success or failure. Response errorcodes are listed in Section 4.3. 6. Callback Registration Callbacks can be registered to have the KDS send information to the server for various events: 6.1. "callback" POS Request { "seq" : 11, "type" : "callback", "callbackid" : 1, "action" : "set", "url" : "http://192.168.1.100:8080/kdsapi/callback_listener.cgi", "trigger" : "onbump" } where • url can be standard HTTP POST, like o "http://192.168.1.100:8080/kdsapi/callback_listener.cgi" • callbackid is unique identifier assigned to callback entry by POS. This identifier will be used to delete the entry later. Should start at 1 and increment by 1 for each new call back registration. • action can be o "set" - to create or overwrite a callback entry, o "clear" - to delete the entry, • trigger is the condition that causes KDS to call back. It can be o "onenter" - KDS will return both check, table and itemid(s) when an order is entered. o "onbump" - KDS will return both check, table and itemid(s) when a bump takes place. o "onpriority" - when the timer of order reaches Priority Time, KDS will return check, table. Form: F-730-028 v1.00 KDS API User Manual Page 17 of 26 111-38-URM-009 R2.50

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26

KDS API
User Manual
Page 17 of 26
111-38-URM-009
R2.50
Form: F-730-028 v1.00
5.8.3 Status Error Response
KDS will send back a response indicating success or failure.
Response errorcodes are
listed in Section 4.3.
6. Callback Registration
Callbacks can be registered to have the KDS send information to the server for various
events:
6.1.
“callback” POS Request
{
“seq” : 11,
“type” : “callback”,
“callbackid” : 1,
“action” : “set”,
“url” :
“trigger” : “onbump”
}
where
url
can be standard HTTP POST, like
o
callbackid
is unique identifier assigned to callback entry by POS.
This identifier
will be used to delete the entry later.
Should start at 1 and increment by 1 for each
new call back registration.
action
can be
o
“set”
to create or overwrite a callback entry,
o
“clear”
to delete the entry,
trigger
is the condition that causes KDS to call back.
It can be
o
“onenter”
KDS will return both
check, table
and
itemid(s)
when
an order is entered.
o
“onbump”
KDS will return both
check, table
and
itemid(s)
when a
bump takes place.
o
“onpriority”
when the timer of order reaches Priority Time, KDS will
return
check, table.