Rooms API

GET Room List

Returns a list of O3 rooms that the user, who has logged in, has access to. These rooms have sensor hubs that are online.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms?alt=json

Request Path Parameters

Name	Description
{enteliWEB Server IP Address}	The IP address of the enteliWEB server in the O3 room network.

Response Body Attributes

Name	Nested Names	Data Type	Description
id	--	string	Room ID
name	--	string	Room Name
description	--	string	Room Description
photo			Room Photo
	id	string	Photo ID
	filename	string	Photo file name
	url	string	Photo file URL
	caption	string	Photo caption
currentActivity	--	string	The current room activity ID
deviceHubs			Room's associated sensor hubs
	id	string	The sensor hub ID
	roomId	string	Room ID
	deviceRef	string	The sensor hub's associated O3-DIN controller DEV object
	instance	integer	Address of the sensor hub assigned by its rotary switch
	beaconId	string	Sensor hub MAC address

GET Room List by Sensor Hub

Returns a list of rooms closest to the Bluetooth antenna on the device of the logged in user. The room list is based on the proximity of the antenna to specific sensor hubs using the hub's MAC address and Bluetooth beacon signal strength received by the antenna.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms?beacon[]={“id”:“sensor hub #1 MAC address”, “signal”:60}&beacon[]={“id”:“sensor hub # 2 MAC address”, “signal”:60}

In the above sample request, the signal strength received is a value of 60.

Note: The beacon information between the { } brackets has to be URL encoded.

Request Path Parameters

Name	Description
Sensor hub MAC Address	To find out the MAC address of the O3-HUB sensor hub, see the Create the Sensor Hub Object Database section in the Getting Started topic.
Received signal strength from the hub's Bluetooth beacon	This is a required parameter. This value is derived from the user's device.

Response Body Attributes

Name	Nested Names	Data Type	Description
id	--	string	Room ID
name	--	string	Room Name
description	--	string	Room Description
photo			Room Photo
	id	string	Photo ID
	filename	string	Photo file name
	url	string	Photo file URL
	caption	string	Photo caption
currentActivity	--	string	The current room activity ID
deviceHubs			Room's associated sensor hubs
	id	string	Sensor hub ID
	roomId	string	Room ID
	deviceRef	string	The sensor hub's associated O3-DIN controller DEV object
	instance	integer	Address of the sensor hub assigned by its rotary switch
	beaconId	string	Sensor hub MAC address

GET Single Room

Returns room information by room ID.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}?alt=json

Returns room information by room name.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{room name}?alt=json

Request Path Parameters

Name	Data Type	Description
{roomId} {room name}	string	The O3 room ID or room name. To find out the room ID or room name, perform a GET of the room list.

Response Body Attributes

Name	Nested Names	Data Type	Description
id	--	string	Room ID
name	--	string	Room Name
description	--	string	Room Description
photo			Room Photo
	id	string	Photo ID
	filename	string	Photo file name
	url	string	Photo file URL
	caption	string	Photo caption
currentActivity	--	string	The current room activity ID
deviceHubs			A list of the room's associated sensor hubs
	id	string	Sensor hub ID
	roomId	string	Room ID
	deviceRef	string	The sensor hub's associated O3-DIN controller DEV object
	instance	integer	Address of the sensor hub assigned by its rotary switch
	beaconId	string	Sensor hub MAC address
activities			A list of the room's activities that have been enabled in enteliWEB
	id	string	Room activity ID
	name	string	Name of room activity
	description	string	Room activity description
	color	string	Color hex associated with the activity to help users identify it in the O3 app.
	appLabel	string	Specifies the name used in the O3 app for this activity. When Activity Label in App is blank, then Activity Name is displayed in the O3 app.
components		list	A list of the room's control setpoints set up in enteliWEB

PUT Absolute Temperature Setpoint

Changes the temperature setpoint in a room. The room must be set up in enteliWEB to use the Absolute Setpoint Type. This allows the O3 user to select the setpoint temperature within a range set by a minimum and a maximum value.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints/temp sp?&alt=json

In the body of the request, add

{
  "$base": "Real",
  "value": "new setpoint value"
} 

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature room control setpoint.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

Response

{
  "$base": "Real",
  "value": "new setpoint value"
  "errorText": "OK",
  "error": "-1"
} 

PUT Temperature Setpoint Offset

Changes the temperature setpoint offset in a room. The room must be set up in enteliWEB to use the Offset Setpoint Type. This allows the O3 user to increase or decrease an offset to the base setpoint temperature.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints/offset?&alt=json

In the body of the request, add

{
  "$base": "Real",
  "value": "new offset value"
} 

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature offset control.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

Response

{
  "$base": "Real",
  "value": "new offset value"
  "errorText": "OK",
  "error": "-1"
} 

PUT Light Controls

Turn on or off the lights in the room, or set a percentage value for the light dimmer.

For On/Off control type room control (no dimmer switch):

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints?&alt=json

In the body of the request, add:

{
  "$base": "Composition",
  "on": {
      "base": "String",
      "value": "active"
  },
  "off": {
      "base": "String",
      "value": "active"
  }										
} 

If you are turning on the lights, remove the "off" name/value pair from the request, and set the "on" value to "active".

If you are turning off the lights, remove the "on" name/value pair from the request, and set the "off" value to "inactive".

For Dimmer control type room control:

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints?&alt=json

In the body of the request, add:

{
  "$base": "Composition",
  "dimmer": {
      "base": "Real",
      "value": "new dimmer value"
  }										
} 

For Dimmer and On/Off combination control type room control:

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints?&alt=json

In the body of the request, add:

{
  "$base": "Composition",
  "dimmer": {
      "base": "Real",
      "value": "new dimmer value"
  },
  "on": {
      "base": "String",
      "value": "active"
  },
  "off": {
       "base": "String",
       "value": "active"
  }														
} 

If you are only turning on the lights, remove the "off" and "dimmer" name/value pairs from the request, and set the "on" value to "active".

If you are only turning off the lights, remove the "on" and "dimmer" name/value pairs from the request, and set the "off" value to "inactive".

If you are changing the "dimmer" value and turning on or off the lights, remove the "on" or "off" name/value pair that isn't needed from the request.

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature room control setpoint. This ID changes if you change any settings in enteliWEB. To find out the component ID, perform a GET of the component list.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

PUT Blinds Position and Angle

Change the position of the blinds and blind angle (if controlled).

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints?&alt=json

In the body of the request, add:

{
  "$base": "Composition",
  "position": {
      "base": "Real",
      "value": "new position value"
  },
  "angle": {
      "base": "Real",
      "value": "new angle value"
  }										
} 

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature room control setpoint. This ID changes if you change any settings in enteliWEB. To find out the component ID, perform a GET of the component list.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

PUT Blinds Position

Change the position of the blinds.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints/position?&alt=json

In the body of the request, add:

{
      "base": "Real",
      "value": "new blind position value"									
} 

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature room control setpoint. This ID changes if you change any settings in enteliWEB. To find out the component ID, perform a GET of the component list.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

PUT Blinds Angle

Change the angle of the blinds.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints/angle?&alt=json

In the body of the request, add:

{
      "base": "Real",
      "value": "new blind angle value"									
} 

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature room control setpoint. This ID changes if you change any settings in enteliWEB. To find out the component ID, perform a GET of the component list.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

PUT Fan

Change the fan state in the room.

https://{enteliWEB Server IP Address}/enteliweb/api/rooms/{roomId}/components/{componentid}/controlpoints/fan?&alt=json

In the body of the request, add:

{
      "base": "String",
      "value": "new fan state"									
} 

Request Body Parameters

Name	Data Type	Description
{roomId}	string	The O3 room ID. To find out the room ID, perform a GET of the room list.
{componentid}	string	The ID of the temperature room control setpoint. This ID changes if you change any settings in enteliWEB. To find out the component ID, perform a GET of the component list.

Requires Authentication

Assumes request is made during a session that has not expired.

In the authorization header, add X-Csrf-Token: {_csrfToken} where {_csrfToken} is the CSRF token generated when you make a basic login GET request.

© 2019 Delta Controls O3 Room REST API Version 1.0