Information

GET /equipment/switch/info

Get switch information

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response object Required
      Hide Response attributes Show Response attributes object
      • WritableSwitches array[object] Required
        Hide WritableSwitches attributes Show WritableSwitches attributes object
        • Maximum integer Required
        • Minimum integer Required
        • StepSize number Required
        • TargetValue integer Required
        • Id integer Required
        • Name string Required
        • Description string Required
        • Value integer Required
      • ReadonlySwitches array[object] Required
        Hide ReadonlySwitches attributes Show ReadonlySwitches attributes object
        • Id integer Required
        • Name string Required
        • Description string Required
        • Value integer Required
      • SupportedActions array[string] Required
      • Connected boolean Required
      • Name string Required
      • DisplayName string Required
      • Description string Required
      • DriverInfo string Required
      • DriverVersion string Required
      • DeviceId string Required
    • Error string Required
    • StatusCode integer Required
    • Success boolean Required
    • Type string Required
  • 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/switch/info
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/switch/info'
Response examples (200)
{
  "Response": {
    "WritableSwitches": [
      {
        "Maximum": 42,
        "Minimum": 42,
        "StepSize": 42.0,
        "TargetValue": 42,
        "Id": 42,
        "Name": "string",
        "Description": "string",
        "Value": 42
      }
    ],
    "ReadonlySwitches": [
      {
        "Id": 42,
        "Name": "string",
        "Description": "string",
        "Value": 42
      }
    ],
    "SupportedActions": [
      "string"
    ],
    "Connected": true,
    "Name": "string",
    "DisplayName": "string",
    "Description": "string",
    "DriverInfo": "string",
    "DriverVersion": "string",
    "DeviceId": "string"
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}
Response examples (500)
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}