Створити кімнату

POST 
/rooms

Створити кімнату

примітка

Ім'я кімнати повинно бути унікальним

Request

application/json

Body

namestring
Назва кімнати.
Example: Коридор
orderinteger
Порядок кімнат у секції
Example: 1
section_idinteger
Батьківський розділ кімнати
Example: 1
background_imagestring
Зображення тла кімнати
Example: 123321.jpg
iconstring
Значок кімнати, для списку доступних значків дивіться Список значків
Example: ch-door

main_devices

object

Основні пристрої кімнати

temperature_sensorinteger

Первинний температурний датчик.

Example: 132

humidity_sensorinteger

Первинний датчик вологості

Example: 22

luminosity_sensorinteger

Світло.

Example: 23

power_sensorinteger

Датчик потужності

property name*integer

Будь-який сенсор багаторівневого сенсору може стати первинним кімнатним сенсором для свого типу. Ім'я властивості складається з типу сенсору з приставкою _sensor у нижньому регістрі (наприклад, сенсор з "sensorType": "Smoke" стане smoke_sensor в властивості main_devices)

Responses

200

Кімната створена

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

idinteger
Ідентифікатор кімнати
Example: 3
namestring
Назва кімнати.
Example: Коридор
orderinteger
Порядок кімнат у секції
Example: 1
section_idinteger
Батьківський розділ кімнати
Example: 1
background_imagestring
Зображення тла кімнати
Example: 123321.jpg
iconstring
Значок кімнати, для списку доступних значків дивіться Список значків
Example: ch-door

main_devices

object

Основні пристрої кімнати

temperature_sensorinteger

Первинний температурний датчик.

Example: 132

humidity_sensorinteger

Первинний датчик вологості

Example: 22

luminosity_sensorinteger

Світло.

Example: 23

power_sensorinteger

Датчик потужності

property name*integer

Будь-який сенсор багаторівневого сенсору може стати первинним кімнатним сенсором для свого типу. Ім'я властивості складається з типу сенсору з приставкою _sensor у нижньому регістрі (наприклад, сенсор з "sensorType": "Smoke" стане smoke_sensor в властивості main_devices)

Example (from schema)

{
  "success": true,
  "id": 3,
  "name": "Коридор",
  "order": 1,
  "section_id": 1,
  "background_image": "123321.jpg",
  "icon": "ch-door",
  "main_devices": {
    "temperature_sensor": 132,
    "humidity_sensor": 22,
    "luminosity_sensor": 23,
    "power_sensor": 0
  }
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}

409

Кімната з вказаною назвою вже існує.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4129,
  "errorMessage": "Object already exists",
  "errorParameters": {
    "type": "room",
    "id": 11
  }
}