Spaces

Get Spaces

Returns information about all physical spaces in the venue

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

Response

200500

OK

Body

application/json

Other propertiesapi.Space (object)

Request

JavaScriptCurlPython

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

Response

500

{
  "message": "text"
}

Get Space

Returns information for a specific physical space in the venue

GEThttp://AAA-1234.local/psapi/spaces/{spaceID}

Path parameters

spaceID*string

Space ID

Response

200400404500

OK

Body

application/json

active_environmental_conditions_idstring (uuid)

active_preset_idstring (uuid)

environmental_conditionsapi.EnvironmentalConditions (object)

namestring

Example: "Theatre hall"

preset_idsarray of string

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "active_environmental_conditions_id": "123e4567-e89b-12d3-a456-426614174000",
  "active_preset_id": "123e4567-e89b-12d3-a456-426614174000",
  "environmental_conditions": {
    "atmospheric_pressure_pascal": 101325,
    "humidity_percentage": 55,
    "temperature_celsius": 21.5
  },
  "name": "Theatre hall",
  "preset_ids": [
    "text"
  ]
}

Change details of a space

This endpoint can be used to modify details of a physical space in the venue.

Environmental Conditions

To set the environmental conditions for a space make a PATCH request to /spaces/{spaceID} with a body that contains the environmental_conditions key, like in the following example:

{
  "environmental_conditions": {
    "atmospheric_pressure_pascal": 101345,
    "humidity_percentage": 34,
    "temperature_celsius": 23.4
  }
}

When environmental conditions are submitted, the system will persist them. To activate and identify the closest matching set of stored conditions for the currently selected preset you have to apply the environmental condition with a post request to /spaces/{spaceID}/environmental-conditions/apply.

Active Preset

The following request body changes the active preset of the space:

{
  "active_preset_id": "7aa69f98-b697-11ed-b9c5-b445062a7e37"
}

Note that the ID used here must match one of the presets listed for the space, or the request will get a response of 400 Bad Request.

A change of the active preset will trigger a match of the environmental conditions.

PATCHhttp://AAA-1234.local/psapi/spaces/{spaceID}

Path parameters

spaceID*string

Space ID

Body

application/json

Space

active_preset_idstring (uuid)

environmental_conditionsapi.EnvironmentalConditions (object)

Response

200400404500

OK

Body

application/json

active_environmental_conditions_idstring (uuid)

active_preset_idstring (uuid)

environmental_conditionsapi.EnvironmentalConditions (object)

namestring

Example: "Theatre hall"

preset_idsarray of string

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/spaces/{spaceID}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "active_environmental_conditions_id": "123e4567-e89b-12d3-a456-426614174000",
  "active_preset_id": "123e4567-e89b-12d3-a456-426614174000",
  "environmental_conditions": {
    "atmospheric_pressure_pascal": 101325,
    "humidity_percentage": 55,
    "temperature_celsius": 21.5
  },
  "name": "Theatre hall",
  "preset_ids": [
    "text"
  ]
}

Apply the stored environmental conditions for a space

This endpoint is used to apply the environmental conditions in a space. The algorithm will identify the closest set of stored conditions for the current active preset and will activate those. This might result in an audible effect, glitch.

POSThttp://AAA-1234.local/psapi/spaces/{spaceID}/environmental-conditions/apply

Path parameters

spaceID*string

Space ID

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/spaces/{spaceID}/environmental-conditions/apply', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

400404500

{
  "message": "text"
}

Stream Spaces Updates

This endpoint can be used to stream updates about spaces through WebSockets. The payload returned is the same as in GET /spaces but only the space that has changed will be populated.

Find a Javascript client to use use this endpoint below.

const WebSocket = require('ws');

const client = new WebSocket('ws://localhost:6789/ws/spaces');
client.on('message', msg => console.log("Spaces update:" + msg.toString()));

GEThttp://AAA-1234.local/psapi/ws/spaces

Response

200

OK

Request

JavaScriptCurlPython

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