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/controller/«controllerno»/tag/«tagno»

Method

GET

Description

Receives information of a tag.

WIll only work if cabinet is in mode tag. Refer to Cabinet to set cabinet in the correct mode.

controllerno is a number, tagno is an PTL ident (in the case of ATOP, this is also a number).

For the standardised PTL cabinet, controller 1 is the front, controller 2 is the back. Tag IDs are numbered from 11 upwards (left-to-right, bottom-to-top).

Response

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

Possible Error

HTTP404 with no body when controller does not exist

Note when the cabinet sides setting is set to frontonly, controller 2 will not be available and this will result in an HTTP404.

Status

IMPLEMENTED

URL

http://<<ip address>>/rest/controller/«controllerno»/tag/«tagno»

Method

PUT

Description

Sets value and color on a tag.

WIll only work if cabinet in de in mode tag. Refer to Cabinet to set cabinet in the correct mode.

controllerno is a number, tagno is an PTL ident (in the case of ATOP, this is also a number).

For the standardised PTL cabinet, controller 1 is the front, controller 2 is the back. Tag IDs are numbered from 11 upwards (left-to-right, bottom-to-top).

Request

{
  "value": «valuetodisplay»,
  ["color": "red|green|orange|blue|pink|cyan"]
}

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.

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

{
  "message": «human readable error»
}

HTTP404 with no body when controller does not exist

HTTP409 when cabinet not in correct mode

Note when the cabinet sides setting is set to frontonly, controller 2 will not be available and this will result in an HTTP404.

Status

IMPLEMENTED

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.