Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

URL

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

Method

GET

Description

Receives information on the cabinet.

Response

Code Block
languagejson
{
  "planks": «numberofplanks», 
  "sections": «numberofsections»,
  "name": «nameofcabinet»,
  "status": [«listofhumanreadablestatusmessages»],
  "demo": "barcode|off"
}

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”.

Status

Status
colourGreen
titleimplemented

Extra

Code Block
languagejson
{
    "demo": "barcode|off"
}

Show which demo mode is set.

De demo mode tells in which (stateful) demo mode the cabinet is, of off when not in demo mode.

Status

Status
colourYellowGreen
titlependingimplemented

URL

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

Method

PUT

Description

Stores information on the cabinet.

Request

Code Block
languagejson
{ 
  "planks": «numberofplanks», 
  "sections": «numberofsections»,
   "name": «nameofcabinet»
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

Code Block
languagejson
{
  "message": «human readable error»
}

Status

Status
colourGreen
titleimplemented

...