POST /engine/resources/ble-room-devices/write-devices-multiple
This resource is used to update multiple BLE Room Devices in one request.
resourceIndexes property is usefull only when writeMode property is equal to onAllSelectedResourceIndex.
When writeMode property is equal to devices, resourceIndex is required for each BLE Room devices passed if the property devices.
Only BLE Room Device properties provided are updated.
In the example below only the pinCode is updated:\"writeMode\": \"devices\", \"devices\": [ { \"resourceIndex\": 2, \t\"pinCode\": \"123456\", } ] }
Object Name: BleRoomDevice
| Property Name | Type | Description | Method |
|---|---|---|---|
| resourceIndex | Integer | This is the unique identifier of the BLE Room Device | GET POST |
| bluetoothMode | Integer | This is the Bluetooth mode required for the device. Possible values are: |
POST /engine/resources/ble-room-devices/write-devices-multiple
This resource is used to update multiple BLE Room Devices in one request.
resourceIndexes property is usefull only when writeMode property is equal to onAllSelectedResourceIndex.
When writeMode property is equal to devices, resourceIndex is required for each BLE Room devices passed if the property devices.
Only BLE Room Device properties provided are updated.
In the example below only the pinCode is updated:\"writeMode\": \"devices\", \"devices\": [ { \"resourceIndex\": 2, \t\"pinCode\": \"123456\", } ] }
Object Name: BleRoomDevice
| Property Name | Type | Description | Method |
|---|---|---|---|
| resourceIndex | Integer | This is the unique identifier of the BLE Room Device | GET POST |
| bluetoothMode | Integer | This is the Bluetooth mode required for the device. Possible values are:
|
GET POST |
| modelType | Integer | This is the model type of the BLE Room Device Possible values are:
|
GET |
| name | String | This is the name | GET |
| roomName | String | Description of the room or location of where the device is located. This name will appear on the UNITOUCH screen as well as in the my PERSONIFY mobile application device list. | GET POST |
| pinCode | String | This is the Bluetooth PIN Code. If Private Bluetooth mode is enabled, the PIN code is required to wirelessly connect to the device using a smartphone or tablet. A minimum of six (6) digit PIN code which must be different that the default PIN code (999995) |
GET POST |
| subnetId | String | This is the current subnet ID assigned to the device. | GET |
| uuid | String | This is the universally unique identifier (UUID) to uniquely identify your your beacons’ network. A UUID is composed of 32 hexadecimal digits split into 5 groups separated by hyphens. Example : 74be2bd-47e1-5995-889b-4f0316eed60a |
GET POST |
| sunBlindGroups | Array<sunBlindGroup> | This a list of Sunblind Group | GET POST |
| lightGroups | Array<lightGroup> | This is a list of Light Group | GET POST |
| spaceOwners | Array<String> | This is the list of name of the space owners | GET POST |
Object Name: writeDevicesMultiple
| Property Name | Type | Description | Method |
|---|---|---|---|
| writeMode | String | Defines the write mode.
|
POST |
| devices | Array<BleRoomDevice> | POST | |
| resourceIndex | Array<String> | This is a list of BLE Room devices' Indexes | POST |
URL Example: https://0.0.0.0/api/rest/v1/engine/resources/ble-room-devices/write-devices-multiple
{
"writeMode": "devices",
"devices": [
{
"resourceIndex": 1,
"bluetoothMode": 4,
"pinCode": "1234567"
},
{
"resourceIndex": 2,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 3,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 4,
"bluetoothMode": 3,
"pinCode": "123456"
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/engine/resources/ble-room-devices/write-devices-multiple
{
"writeMode": "devices",
"devices": [
{
"resourceIndex": 1,
"bluetoothMode": 4,
"pinCode": "1234567"
},
{
"resourceIndex": 2,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 3,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 4,
"bluetoothMode": 3,
"pinCode": "123456"
}
]
}
-BLE**
| GET | |
| name | String | This is the name | GET | |
| roomName | String | Description of the room or location of where the device is located. This name will appear on the UNITOUCH screen as well as in the my PERSONIFY mobile application device list. | GET
POST |
| pinCode | String | This is the Bluetooth PIN Code.
If Private Bluetooth mode is enabled, the PIN code is required to wirelessly connect to the device using a smartphone or tablet.
A minimum of six (6) digit PIN code which must be different that the default PIN code (999995) | GET
| POST |
| subnetId | String | This is the current subnet ID assigned to the device. | GET | |
| uuid | String | This is the universally unique identifier (UUID) to uniquely identify your your beacons’ network.
A UUID is composed of 32 hexadecimal digits split into 5 groups separated by hyphens.
Example : 74be2bd-47e1-5995-889b-4f0316eed60a | GET
POST |
| sunBlindGroups | Array<sunBlindGroup> | This a list of Sunblind Group | GET
POST |
| lightGroups | Array<lightGroup> | This is a list of Light Group | GET
POST |
| spaceOwners | Array<String> | This is the list of name of the space owners | GET
POST |
Object Name: writeDevicesMultiple
| Property Name | Type | Description | Method | |
|---|---|---|---|---|
| writeMode | Defines the write mode. |
onAllSelectedResourceIndex
Updates the BLE Room Devices having resourceIndex specified in the property resourceIndex.
The first BLE Room Device object defined in the property devices is used as reference object for the update.
devices
Updates each BLE Room Devices as defined in the property devices.
onAllDevice
Updates all BLE Room Devices configured in the controller
The first BLE Room Device object defined in the property devices is used as reference object for the update. | POST |
devices | | | POST |
resourceIndex | | This is a list of BLE Room devices' Indexes | POST |
URL Example: https://0.0.0.0/api/rest/v1/engine/resources/ble-room-devices/write-devices-multiple
{
"writeMode": "devices",
"devices": [
{
"resourceIndex": 1,
"bluetoothMode": 4,
"pinCode": "1234567"
},
{
"resourceIndex": 2,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 3,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 4,
"bluetoothMode": 3,
"pinCode": "123456"
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/engine/resources/ble-room-devices/write-devices-multiple
{
"writeMode": "devices",
"devices": [
{
"resourceIndex": 1,
"bluetoothMode": 4,
"pinCode": "1234567"
},
{
"resourceIndex": 2,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 3,
"bluetoothMode": 3,
"pinCode": "123456"
},
{
"resourceIndex": 4,
"bluetoothMode": 3,
"pinCode": "123456"
}
]
}