Get Portal

Gets a list of all portals.

URL

GET http://localhost:8080/getPortal

Response Body

Name Type Description

ID

String

Unique ID of the Portal.

Name

String

Name of the Portal.

ClassName

String

ClassName of the Portal.

location

Object

Location details of the Portal.

  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_Portal_C_2147455423",
    "Name": "Main Portal",
    "ClassName": "Build_Portal_C",
    "location": {
      "x": -65200,
      "y": 240100,
      "z": 21100,
      "rotation": 90
    },
    "BoundingBox": {
      "min": {
        "x": -65600,
        "y": 239700,
        "z": 21100
      },
      "max": {
        "x": -64800,
        "y": 240500,
        "z": 22300
      }
    },
    "ColorSlot": {
      "PrimaryColor": "C800BD00",
      "SecondaryColor": "C800BD00"
    },
    "PowerInfo": {
      "CircuitGroupID": -1,
      "CircuitID": -1,
      "FuseTriggered": false,
      "PowerConsumed": 0,
      "MaxPowerConsumed": 0
    }
  },
  {
    "ID": "Build_PortalSatellite_C_2147245145",
    "Name": "Satellite Portal",
    "ClassName": "Build_PortalSatellite_C",
    "location": {
      "x": -64700,
      "y": 262000,
      "z": 21100,
      "rotation": 90
    },
    "BoundingBox": {
      "min": {
        "x": -65100,
        "y": 261600,
        "z": 21100
      },
      "max": {
        "x": -64300,
        "y": 262400,
        "z": 22100
      }
    },
    "ColorSlot": {
      "PrimaryColor": "C800BD00",
      "SecondaryColor": "C800BD00"
    },
    "PowerInfo": {
      "CircuitGroupID": -1,
      "CircuitID": -1,
      "FuseTriggered": false,
      "PowerConsumed": 0,
      "MaxPowerConsumed": 0
    }
  }
]