Versions Compared

Version Old Version 1 New Version 2
Changes made by

Bart Friederichs

Bart Friederichs

Saved on

Key

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

Introduction

The REST interface is located at http://<<ip address>>/rest and uses JSON for data exchange. Table below describes the available resources:

Cabinet

URL

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

Method

GET

Description

Receives information on the cabinet.

Response

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

Section

URL

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

Method

GET

Description

Receives information of section.

Response

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

Possible Error

HTTP404 with no body when section does not exist.

URL

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

Method

PUT

Description

Sets value on display.

Request

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

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

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

HTTP404 with no body when section does not exist