Versions Compared

Version Old Version 8 New Version 9
Changes made by

Bart Friederichs

Bart Friederichs

Saved on

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»
}

Status

Status
colourGreen
titleimplemented

Change

Status
colourYellow
titlepending

Add name and status:

Code Block
{
  "planks": «numberofplanks», 
  "sections": «numberofsections»,
  "name": «nameofcabinet»,
  "status": [«listofhumanreadablestatusmessages»]
}

Status message can be:

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

  • No connection to controller

When list of messages is empty, cabinet is “OK”.

Status

Status
colourGreen
titleimplemented

Change

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

Status
colourYellow
titlepending

Add name:

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

URL

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

Method

PUT

Description

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

Request

Code Block
languagejson
{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

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

Status

Status
colourYellowGreen
titlependingimplemented

URL

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

Method

PUT

Description

Sets the cabinet in or out of teach mode.

Request

Code Block
languagejson
{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

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

Status

Status
colourYellow
titlepending

...