Advanced API

Set Light

GET /equipment/flatdevice/set-light

Set the light on the flatdevice

Query parameters

  • true boolean Required

    The actual parameter name is "on", but for some reason the documentation automatically renames it to true...

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Flatdevice not connected

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/flatdevice/set-light 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/flatdevice/set-light?true=true'
Response examples (200) 
{
  "Response": "Flatdevice light set",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Flatdevice not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}