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

« Previous Version 6 Next »

Cabinet

URL

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

Method

GET

Description

Receives information on the cabinet.

Response

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

Status

IMPLEMENTED

URL

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

Method

PUT

Description

Stores information on the cabinet.

Request

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

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{
  "message": «human readable error»
}

Status

IMPLEMENTED

Section

Plank and section numbering is 1-based. So if 4 planks are available, they are numbered 1 to 4.

URL

http://<<ip address>>/rest/plank/«plankno»/section/«sectionno»

Method

GET

Description

Receives information of section.

Response

{
  "value": «lastdisplayedvalue»,
  "state": «state»
}

Possible Error

HTTP404 with no body when section does not exist.

Status

IN PROGRESS

URL

http://<<ip address>>/rest/plank/«plankno»/section/«sectionno»

Method

PUT

Description

Sets value on display.

Request

{
  "value": «valuetodisplay»
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{
  "message": «human readable error»
}

HTTP404 with no body when section does not exist

  • No labels