Versions Compared

Key

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

...

URL

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

Method

GET

Description

Receives information of section.

plankno and sectionno are numbers

side can be front or back and is optional; when not supplied, this defaults to front.

Response

Code Block
languagejson
{
  "value": «lastdisplayedvalue»,
  "state": «state»
}

Possible Error

HTTP404 with no body when section does not exist.

Status

Status
colourGreen
titleimplemented

URL

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

Method

PUT

Description

Sets value on display.

plankno and sectionno are numbers

side can be front or back and is optional; when not supplied, this defaults to front.

Request

Code Block
languagejson
{
  "value": «valuetodisplay»
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

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

HTTP404 with no body when section does not exist

Status

Status
colourGreen
titleimplemented