Cabinet

http://<<ip address>>/rest/cabinet

GET

Receives information on the cabinet.

{
  "planks": «numberofplanks», 
  "sections": «numberofsections»,
  "name": «nameofcabinet»,
  "status": [«listofhumanreadablestatusmessages»],
  "demo": "barcode|off",
  "sides": "frontonly|frontandback",
  "orders": «number of open orders»,
  "tagmode": «tag mode»
}

Status message can be:

• Missing tag at plank P, section S (Tag ID N)

• No connection to controller

When list of messages is empty ([]), cabinet is “OK”.

De demo mode tells in which (stateful) demo mode the cabinet is, of off when not in demo mode. Use the calls in Demo to manipulate these modes.

mode was removed in v2.0

orders and tagmode were added in v2.1

http://<<ip address>>/rest/cabinet

PUT

Stores information on the cabinet.

sides can be frontonly or frontandback:

• frontonly is used when only the front controller is physically available. This suppresses any missing tags on the back, a missing connection of the back controller and will generate a HTTP404 when trying to write to a back tag, or to controller 2 when in tag mode.

• frontandback should be used if two controllers are connected, which is only valid for the PTLCabinet.

name is the name of the cabinet, this will be shown on the screen, scaled to fit, when the PTLControl is idle.

When name is an HTML snippet surrounded by <div>the HTML will be rendered where the name is, centered on screen. The client is responsible for styling, scaling and layout.

{ 
  "planks": «numberofplanks», 
  "sections": «numberofsections»,
  "name": «nameofcabinet»,
  "sides": "frontonly|frontandback",
  "demo": "barcode|off",
  "tagmode": "pick|zeropick|confirm|info|locked"
}

tagmodes:

• pick: (default) Tag can be used for picking, confirm button will send a WebSocket confirm message and amount can be adjusted down.

• zeropick: Tag can be used for picking, confirm button will send a WebSocket confirm message. Button down will send a confirm message with amount 0.

• confirm: Tag can be used for picking, confirm button will send aWebSocket confirm message. No adjustments can be made.

• info: Tag is used for info. Buttons will send WebSocket messages, but tag will not turn off when confirm is pushed.

• locked: Tag is read-only. Buttons have no effect, no messages are sent.

HTTP204 when successful

HTTP400 when request was invalid

{
  "message": «human readable error»
}

modewas removed in v2.0

HTML support for name was added in v2.1

tagmode was added in v2.1

http://<<ip address>>/rest/cabinet/lighttest

PUT

Sets the cabinet is lighttest mode: turning light on or off. The light test shows the tag’s address.

HTTP204 when successful

HTTP400 when request was invalid

{
  "message": «human readable error»
}