Arrays and modules

Get Arrays

Returns information about all arrays

GEThttp://AAA-1234.local/psapi/arrays

Response

200500

OK

Body

application/json

Other propertiesapi.Array (object)

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/arrays', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

500

{
  "message": "text"
}

Get Array

Returns information for a specific array

GEThttp://AAA-1234.local/psapi/arrays/{arrayID}

Path parameters

arrayID*string

Array ID

Response

200400404500

OK

Body

application/json

healthapi.ArrayHealth (object)

modulesobject

namestring

Example: "Stage Left"

power_statusenum

Example: "awake"

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/arrays/{arrayID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "health": {
    "message": "Okay",
    "status": "okay"
  },
  "name": "Stage Left",
  "power_status": "awake"
}

Set Array Blink

Changes the blink state for a specific array

PUThttp://AAA-1234.local/psapi/arrays/{arrayID}/blink

Path parameters

arrayID*string

Array ID

Body

application/json

Blink

on*boolean

Response

204400500

No Content

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/arrays/{arrayID}/blink', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "on": false
    }),
});
const data = await response.json();

Response

400500

{
  "message": "text"
}

Set Array Power State

Changes the target power state for the array, allowed values are "on" and "sleep"

PUThttp://AAA-1234.local/psapi/arrays/{arrayID}/power

Path parameters

arrayID*string

Array ID

Body

application/json

Power

target*enum

Example: "on"

Response

204400500

No Content

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/arrays/{arrayID}/power', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "target": "on"
    }),
});
const data = await response.json();

Response

400500

{
  "message": "text"
}

Get Modules

Returns information about all modules.If a module is not paired, the field "name" will be an empty string.

GEThttp://AAA-1234.local/psapi/modules

Response

200500

OK

Body

application/json

Other propertiesapi.Module (object)

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/modules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

500

{
  "message": "text"
}

Get Module

Returns information for a specific module.If a module is not paired, the field "name" will be an empty string.

GEThttp://AAA-1234.local/psapi/modules/{moduleID}

Path parameters

moduleID*string

Module ID

Response

200400404500

OK

Body

application/json

blinkingboolean

Example: false

manufacturerstring

Example: "HOLOPLOT"

namestring

Example: "ABC-1234"

positionapi.Coordinates3 (object)

power_statusenum

Example: "awake"

productstring

Example: "X1"

typestring

Example: "MD96"

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/modules/{moduleID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "blinking": false,
  "manufacturer": "HOLOPLOT",
  "name": "ABC-1234",
  "position": {
    "front_direction": {
      "x": 1,
      "y": 2,
      "z": 3
    },
    "position": {
      "x": 1,
      "y": 2,
      "z": 3
    },
    "up_direction": {
      "x": 1,
      "y": 2,
      "z": 3
    }
  },
  "power_status": "awake",
  "product": "X1",
  "type": "MD96"
}

Set Module Blink

Changes the blink state for a specific module

PUThttp://AAA-1234.local/psapi/modules/{moduleID}/blink

Path parameters

moduleID*string

Module ID

Body

application/json

Blink

on*boolean

Response

204400500

No Content

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/modules/{moduleID}/blink', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "on": false
    }),
});
const data = await response.json();

Response

400500

{
  "message": "text"
}

Set Module Power State

Changes the target power state for the module, allowed values are "on" and "sleep"

PUThttp://AAA-1234.local/psapi/modules/{moduleID}/power

Path parameters

moduleID*string

Module ID

Body

application/json

Power

target*enum

Example: "on"

Response

204400500

No Content

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/modules/{moduleID}/power', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "target": "on"
    }),
});
const data = await response.json();

Response

400500

{
  "message": "text"
}