Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

URL

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

Method

GET

Description

Receives information on the cabinet.

Response

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

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

IMPLEMENTED

URL

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

Method

PUT

Description

Stores information on the cabinet.

Request

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

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{
  "message": «human readable error»
}

Status

IMPLEMENTED

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

{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{
  "message": «human readable error»
}

Status

IMPLEMENTED

URL

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

Method

PUT

Description

Sets the cabinet in or out of teach mode.

Request

{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{
  "message": «human readable error»
}

Status

NOT IN PROTOTYPE

URL

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

Method

GET

Description

Get current state of teach mode

Responses

HTTP204 when not in teach mode

HTTP200 when in teach mode, with following body:

{
  "tag": [«list of tags found»]
}

Status

NOT IN PROTOTYPE

  • No labels