/
Section

Section

The plank/sectioncalls are deprecated and will be removed starting version 3, they should not be used for new applications.

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»[/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

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

Possible Error

HTTP404 with no body when section does not exist.

Note when the cabinet sides setting is set to frontonly, all back tags will return an HTTP404.

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

{ "value": «valuetodisplay», ["color": "red|green|orange|blue|pink|cyan|none"], ["blinking": "on|off|blink2sec|blink1sec|blink05sec|blink025sec"] }

color is optional. When no color is chosen, it defaults to red.

value should be a string, if value is null, the tag is switched off.

blinking should be a string, it defaults to on(i.e. no blinking). off causes the LED to switch off (identical to "color": "none")

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{ "message": «human readable error» }

HTTP404 with no body when section does not exist

Note when the cabinet sides setting is set to frontonly, all back tags will return an HTTP404.

Remarks

v2.3.0:

  • Blinking support added.

 

 

Related content