Get Switches

Gets a list of all switches (priority power switches and power switches).

URL

GET http://localhost:8080/getSwitches

Response Body

Name Type Description

ID

String

Unique ID of the Power Switch.

Name

String

Name of the Power Switch.

SwitchTag

String

Name of Power Switch.

ClassName

String

Class Name of the Power Switch.

IsOn

Boolean

Is the Power Switch on?

Connected0

Integer

Has a connection at A?

Connected1

Integer

Has a connection at B?

Primary

Integer

Circuit ID on connection A.

Secondary

Integer

Circuit ID on connection B.

Priority

Integer

Priority of the Power Switch (-1 = No Priority)

location

Object

Location details of the Power Switch.

  x

Float

X Location in the World.

  y

Float

Y Location in the World.

  z

Float

Z Location in the World.

  rotation

Float

Rotation of the Actor (0 - 359, 0 = North, 90 = East, 180 = South, 270 = West).

ColorSlot

Object

Color/Decoration information about the Actor.

  PrimaryColor

String

Hex Code of Primary Color

  SecondaryColor

String

Hex Code of Secondary Color

BoundingBox

Object

Bounding Box information about the Actor.

  min

Object

The minimum boundary of the bounding box in the corresponding axis.

    x

Float

Value along the X-axis.

    y

Float

Value along the Y-axis.

    z

Float

Value along the Z-axis.

  max

Object

The maximum boundary of the bounding box in the corresponding axis.

    x

Float

Value along the X-axis.

    y

Float

Value along the Y-axis.

    z

Float

Value along the Z-axis.

features

Object

An object with actor coordinates and name information.

  properties

Object

Name information about the actor.

    name

String

Display Name of the Actor.

    type

String

Type of the Object.

  geometry

Object

Geometry information about the Actor.

    coordinates

Object

The Actor coordinates.

      x

Float

X Location of the Actor.

      y

Float

Y Location of the Actor.

      z

Float

Z Location of the Actor.

    type

String

It’s always "Point".

Example Response

[
  {
    "ID": "Build_PriorityPowerSwitch_C_2147452709",
    "Name": "FicsitRemoteMonitoring rocks",
    "ClassName": "Build_PriorityPowerSwitch_C",
    "location": {
      "x": -56603.265625,
      "y": 261809.015625,
      "z": -3934.808349609375,
      "rotation": 300.00000024011166
    },
    "BoundingBox": {
      "min": {
        "x": -56703.265625,
        "y": 261759.015625,
        "z": -3934.808349609375
      },
      "max": {
        "x": -56503.265625,
        "y": 261859.015625,
        "z": -3634.808349609375
      }
    },
    "ColorSlot": {
      "PrimaryColor": "FA954900",
      "SecondaryColor": "5F668C00"
    },
    "SwitchTag": "FicsitRemoteMonitoring rocks",
    "Connected0": 1,
    "IsOn": true,
    "Connected1": 1,
    "Primary": 1,
    "Secondary": 9,
    "Priority": 5,
    "features": {
      "properties": {
        "name": "FicsitRemoteMonitoring rocks",
        "type": "Priority Power Switch"
      },
      "geometry": {
        "coordinates": {
          "x": -56603.265625,
          "y": 261809.015625,
          "z": -3934.808349609375
        },
        "type": "Point"
      }
    }
  }
]