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 9
Next »
URL | http://<<ip address>>/rest/cabinet
|
---|
Method | GET |
---|
Description | eceives information on the cabinet. |
---|
Response |
{
"planks": «numberofplanks»,
"sections": «numberofsections»,
"name": «nameofcabinet»,
"status": [«listofhumanreadablestatusmessages»],
"demo": "barcode|off",
"mode": "section|tag",
"sides": "frontonly|frontandback"
}
Status message can be: When list of messages is empty, cabinet is “OK”. De demo mode tells in which (stateful) demo mode the cabinet is, of off when not in demo mode. Use the calls in Demo to manipulate these modes. |
---|
Status | IMPLEMENTED |
---|
URL | http://<<ip address>>/rest/cabinet
|
---|
Method | PUT |
---|
Description | Stores information on the cabinet. can be tag or section :
section mode will use planks, sections and sides to to control the lights. The websocket will return a plank-section-side combo when button pushed.
tag mode will use direct tags and controller numbers. The websocket will return a controller-tag combo when button pushed.
When the section call is done, and the cabinet is in mode tag (or the other way round), this will result in a HTTP409 Conflict. sides can be frontonly or frontandback :
frontonly is used when only the front controller is physically available. This suppresses any missing tags on the back, a missing connection of the back controller and will generate a HTTP404 when trying to write to a back tag, or to controller 2 when in tag mode.
frontandback should be used if two controllers are connected.
|
---|
Request |
{
"planks": «numberofplanks»,
"sections": «numberofsections»,
"name": «nameofcabinet»,
"mode": "section|tag",
"sides": "frontonly|frontandback"
}
|
---|
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 | |
---|
Response | HTTP204 when successful |
---|
Possible Errors | HTTP400 when request was invalid
{
"message": «human readable error»
}
|
---|
Status | IMPLEMENTED |
---|
Add Comment