---
metadata:
- name: generator
content: Diplodoc Platform v5.66.0
alternate:
- https://yandex.ru/dev/dialogs/smart-home/doc/en/concepts/platform-user-info.md
- https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/platform-user-info.md
- href: https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/platform-user-info.md
type: text/markdown
title: Markdown version
- href: https://yandex.ru/dev/dialogs/smart-home/doc/ru/llms.txt?revision=r21995741
rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/dialogs/smart-home/doc/ru/llms.txt?revision=r21995741
# Получение полной информации об умном доме пользователя
Запрос на получение полной информации о сущностях умного дома пользователя.
## Формат запроса {#format-request}
```bash translate=no
GET https://api.iot.yandex.net/v1.0/user/info
```
#### Заголовки запроса {#headers}
#|
||**Заголовок** | **Описание** | **Обязательный**||
||Authorization | Авторизационный токен oauth-приложения. | Да ||
|#
## Формат ответа {#format-response}
{% list tabs %}
- Успешный ответ
**Сокращенная структура**
```json translate=no
HTTP/1.1 200 OK
{
"status": "ok",
"request_id": String,
"rooms": [RoomObject],
"groups": [GroupObject],
"devices": [DeviceObject],
"scenarios": [ScenarioObject],
"households": [HouseholdObject]
}
```
**Полная структура**
```json translate=no
HTTP/1.1 200 OK
{
"status": "ok",
"request_id": String,
"rooms": [{
"id": String,
"name": String,
"household_id": String,
"[devices](*row-room-devices)": [String]
},
{
"id": String,
"name": String,
"household_id": String,
"[devices](*row-room-devices)": [String]
}
],
"groups": [{
"[id](*row-group-id)": String,
"[name](*row-group-name)": String,
"aliases": [String],
"household_id": String,
"type": "devices.types.{type}",
"[devices](*row-group-devices)": [String],
"capabilities": [{
"retrievable": Boolean,
"[type](*row-group-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"state": {}
},
{
"retrievable": Boolean,
"[type](*row-group-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"state": {}
}
]
}],
"devices": [{
"[id](*row-device-id)": String,
"[name](*row-device-name)": String,
"[aliases](*row-device-aliases)": [String],
"[type](*row-device-type)": "devices.types.{type}",
"external_id": String,
"skill_id": String,
"household_id": String,
"[room](*row-device-room)": String,
"[groups](*row-device-groups)": [String],
"capabilities": [{
"reportable": Boolean,
"retrievable": Boolean,
"[type](*row-group-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"state": {},
"last_updated": Float
},
{
"reportable": Boolean,
"retrievable": Boolean,
"[type](*row-group-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"state": {},
"last_updated": Float
}
],
"properties": []
},
{
"[id](*row-device-id)": String,
"[name](*row-device-name)": String,
"[aliases](*row-device-aliases)": [String],
"[type](*row-device-type)": "devices.types.{type}",
"external_id": String,
"skill_id": String,
"household_id": String,
"[room](*row-device-room)": String,
"[groups](*row-device-groups)": [String],
"capabilities": [{
"reportable": Boolean,
"retrievable": Boolean,
"[type](*row-group-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"state": {},
"last_updated": Float
},
{
"reportable": Boolean,
"retrievable": Boolean,
"[type](*row-group-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"state": {},
"last_updated": Float
}
],
"properties": []
}
],
"scenarios": [{
"[id](*row-scenario-id)": String,
"[name](*row-scenario-name)": String,
"is_active": Boolean
},
{
"[id](*row-scenario-id)": String,
"[name](*row-scenario-name)": String,
"is_active": Boolean
}
],
"households": [{
"[id](*row-household-id)": String,
"[name](*row-household-name)": String
}]
}
```
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
request_id
|
[String](*string)
|
Идентификатор запроса. Необходимо логировать для расследования инцидентов.
|
Да
||
||
status1
|
[String](*string)
|
Статус обработки запроса. Допустимые значения:
- `ok`.
|
Да
||
||
rooms
|
[Array](*array) of [RoomObjects](#room_object)
|
Массив комнат.
|
Да
||
||
groups
|
[Array](*array) of [GroupObjects](#group_object)
|
Массив групп устройств.
|
Да
||
||
devices
|
[Array](*array) of [DeviceObjects](#device_object)
|
Массив устройств.
|
Да
||
||
scenarios
|
[Array](*array) of [ScenarioObjects](#scenario_object)
|
Массив сценариев.
|
Да
||
||
households
|
[Array](*array) of [HouseholdObjects](#household_object)
|
Массив домов.
|
Да
||
|#
##### **Тип `RoomObject`** {#room_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
id
|
[String](*string)
|
Идентификатор комнаты.
|
Да
||
||
name
|
[String](*string)
|
Название комнаты.
|
Да
||
||
devices
|
[Array](*array) of [Strings](*string)
|
Массив идентификаторов устройств в комнате.
|
Да
||
||
household_id
|
[String](*string)
|
Идентификатор дома, в котором находится комната.
|
Да
||
|#
##### **Тип `GroupObject`** {#group_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
id
|
[String](*string)
|
Идентификатор группы устройств.
|
Да
||
||
name
|
[String](*string)
|
Имя группы устройств.
|
Да
||
||
aliases
|
[Array](*array) of [Strings](*string)
|
Массив с дополнительными именами устройств.
|
Да
||
||
type
|
[String](*string)
|
Тип группы устройств. Совпадает с [типом устройств](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/device-types.md), входящих в группу.
|
Да
||
||
capabilities
|
[Array](*array) of [GroupCapabilityObjects](#group-capability-object)
|
Массив с информацией об умениях группы устройств.
|
Да
||
||
devices
|
[Array](*array) of [Strings](*string)
|
Массив идентификаторов устройств, входящих в группу.
|
Да
||
||
household_id
|
[String](*string)
|
Идентификатор дома группы устройств.
|
Да
||
|#
**Массив `capabilities`**
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
capability1
|
GroupCapabilityObject
|
Описание умения. Подробнее со списком доступных умений и их параметрами можно ознакомиться в разделе [Умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md).
|
Нет
||
||
capability2
|
GroupCapabilityObject
|
Описание умения. Подробнее со списком доступных умений и их параметрами можно ознакомиться в разделе [Умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md).
|
Нет
||
|#
##### **Тип `GroupCapabilityObject`** {#group-capability-object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
type
|
[String](*string)
|
[Тип умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md#types).
|
Да
||
||
retrievable
|
[Boolean](*boolean)
|
Доступен ли для данного умения запрос состояния.
|
Да
||
||
parameters
|
CapabilityParametersObject
|
Параметры умения. Соответствует значению поля `parameters` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#discovery-example).
|
Да
||
||
state
|
CapabilityStateObject
|
Текущее состояние умения. Если значение `null`, значит это умение не находится в одинаковом состоянии на устройствах в группе. Соответствует значению поля `state` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#state-example).
|
Да
||
|#
##### **Тип `DeviceObject`** {#device_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
id
|
[String](*string)
|
Идентификатор устройства.
|
Да
||
||
name
|
[String](*string)
|
Имя устройства.
|
Да
||
||
aliases
|
[Array](*array) of [Strings](*string)
|
Массив с дополнительными именами устройства.
|
Да
||
||
room
|
[String](*string)
|
Идентификатор комнаты устройства. Значение `null` передается, если устройство не привязано к комнате.
|
Да
||
||
external_id
|
[String](*string)
|
Идентификатор устройства в облаке производителя.
|
Да
||
||
skill_id
|
[String](*string)
|
Идентификатор навыка производителя устройства.
|
Да
||
||
type
|
[String](*string)
|
[Тип устройства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/device-types.md).
|
Да
||
||
groups
|
[Array](*array) of [Strings](*string)
|
Массив с идентификаторами групп устройства.
|
Да
||
||
capabilities
|
[Array](*array) of [DeviceCapabilityObjects](#device_capability_object)
|
Массив с информацией об умениях устройства.
|
Да
||
||
properties
|
[Array](*array) of [DevicePropertyObjects](#device_property_object)
|
Массив с информацией о свойствах устройства.
|
Да
||
||
household_id
|
[String](*string)
|
Идентификатор дома устройства.
|
Да
||
|#
**Массив `capabilities`**
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
capability1
|
[DeviceCapabilityObject](#device_capability_object)
|
Описание умения.
|
Нет
||
||
capability2
|
[DeviceCapabilityObject](#device_capability_object)
|
Описание умения.
|
Нет
||
|#
**Массив `properties`**
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
property1
|
[DevicePropertyObject](#device_property_object)
|
Описание свойства.
|
Нет
||
||
property2
|
[DevicePropertyObject](#device_property_object)
|
Описание свойства.
|
Нет
||
|#
##### **Тип `DeviceCapabilityObject`** {#device_capability_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
type
|
[String](*string)
|
[Тип умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md#types).
|
Да
||
||
reportable
|
[Boolean](*boolean)
|
Оповещает ли умение об изменении состояния платформу умного дома, используя сервис уведомлений.
|
Да
||
||
retrievable
|
[Boolean](*boolean)
|
Доступен ли для данного умения устройства запрос состояния.
|
Да
||
||
parameters
|
CapabilityParametersObject
|
Параметры умения. Соответствует значению поля `parameters` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#discovery-example).
|
Да
||
||
state
|
CapabilityStateObject
|
Текущее состояние умения. Если значение `null`, значит состояние никогда не передавалось в систему. Соответствует значению поля `state` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#state-example).
|
Да
||
||
last_updated
|
[Float](*float)
|
Время последнего обновления состояния в секундах, формат unix timestamp.
|
Да
||
|#
##### **Тип `DevicePropertyObject`** {#device_property_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
type
|
[String](*string)
|
[Тип свойства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/properties-types.md#types).
|
Да
||
||
reportable
|
[Boolean](*boolean)
|
Оповещает ли свойство об изменении состояния платформу умного дома, используя сервис уведомлений.
|
Да
||
||
retrievable
|
[Boolean](*boolean)
|
Доступен ли для данного свойства устройства запрос состояния.
|
Да
||
||
parameters
|
PropertyParametersObject
|
Параметры свойства. Соответствует значению поля `parameters` из [описания свойства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/float.md#example).
|
Да
||
||
state
|
PropertyStateObject
|
Текущее состояние свойства. Если значение `null` , значит состояние никогда не передавалось в систему. Соответствует значению поля `state` из [описания свойства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/float.md#example).
|
Да
||
||
last_updated
|
[Float](*float)
|
Время последнего обновления состояния в секундах, формат unix timestamp.
|
Да
||
|#
##### **Тип `ScenarioObject`** {#scenario_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
id
|
[String](*string)
|
Идентификатор сценария.
|
Да
||
||
name
|
[String](*string)
|
Название сценария.
|
Да
||
||
is_active
|
[Boolean](*boolean)
|
Флаг того, активен ли этот сценарий сейчас. Неактивный сценарий не удален пользователем, но его нельзя запустить.
|
Да
||
|#
##### **Тип `HouseholdObject`** {#household_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
id
|
[String](*string)
|
Идентификатор дома.
|
Да
||
||
name
|
[String](*string)
|
Название дома.
|
Да
||
|#
- Ответ с ошибкой
```json translate=no
HTTP/1.1 500 Internal Server Error
{
"[request_id](*row-err-request-id)": String,
"[status](*row-err-status)": "error",
"[message](*row-err-message)": String
}
```
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
request_id
|
[String](*string)
|
Идентификатор запроса. Необходимо логировать для расследования инцидентов.
|
Да
||
||
status
|
[String](*string)
|
Статус обработки запроса. Допустимые значения:
- `error`.
|
Да
||
||
message
|
[String](*string)
|
Сообщение об ошибке.
|
Нет
||
|#
[Коды ошибок](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/platform-error-codes.md)
{% endlist %}
## Пример {#example}
{% list tabs %}
- Запрос
```bash translate=no
curl -i -X GET 'https://api.iot.yandex.net/v1.0/user/info' \
-H 'Authorization: Bearer 123qwe456a...'
```
- Успешный ответ
```json translate=no
HTTP/1.1 200 OK
{
"status": "ok",
"request_id": "8348dba1-ad56-4984-b953-ccd27e42f009",
"rooms": [{
"id": "room-id-1",
"name": "Гостиная",
"household_id": "household-id-1",
"devices": [
"lamp-id-1",
"lamp-id-2",
"lamp-id-3",
"speaker-id-1"
]
},
{
"id": "room-id-2",
"name": "Прихожая",
"household_id": "household-id-1",
"devices": [
"vacuum-cleaner-id-1"
]
}
],
"groups": [{
"id": "light-group-id-1",
"name": "Люстра",
"aliases": ["Верхний свет"],
"household_id": "household-id-1",
"type": "devices.types.light",
"devices": [
"lamp-id-1",
"lamp-id-2",
"lamp-id-3"
],
"capabilities": [{
"retrievable": true,
"type": "devices.capabilities.color_setting",
"parameters": {
"color_model": "hsv",
"temperature_k": {
"min": 1700,
"max": 6500
}
},
"state": {
"instance": "temperature_k",
"value": 3400
}
},
{
"retrievable": true,
"type": "devices.capabilities.on_off",
"parameters": {
"split": false
},
"state": {
"instance": "on",
"value": false
}
},
{
"retrievable": true,
"type": "devices.capabilities.range",
"parameters": {
"instance": "brightness",
"unit": "unit.percent",
"random_access": true,
"range": {
"min": 1,
"max": 100,
"precision": 1
}
},
"state": {
"instance": "brightness",
"value": 100
}
}
]
}],
"devices": [{
"id": "lamp-id-1",
"name": "Лампочка 1",
"aliases": [],
"type": "devices.types.light",
"external_id": "external-lamp-id-1",
"skill_id": "skill-id-1",
"household_id": "household-id-1",
"room": "room-id-1",
"groups": [
"light-group-id-1"
],
"capabilities": [{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.on_off",
"parameters": {
"split": false
},
"state": {
"instance": "on",
"value": false
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.range",
"parameters": {
"instance": "brightness",
"unit": "unit.percent",
"random_access": true,
"range": {
"min": 1,
"max": 100,
"precision": 1
}
},
"state": {
"instance": "brightness",
"value": 100
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.color_setting",
"parameters": {
"color_model": "rgb",
"temperature_k": {
"min": 1700,
"max": 6500
}
},
"state": {
"instance": "temperature_k",
"value": 3400
},
"last_updated": 1626681729.2964342
}
],
"properties": []
},
{
"id": "lamp-id-2",
"name": "Лампочка 2",
"aliases": [],
"type": "devices.types.light",
"external_id": "external-lamp-id-2",
"skill_id": "skill-id-1",
"household_id": "household-id-1",
"room": "room-id-1",
"groups": [
"light-group-id-1"
],
"capabilities": [{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.on_off",
"parameters": {
"split": false
},
"state": {
"instance": "on",
"value": false
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.range",
"parameters": {
"instance": "brightness",
"unit": "unit.percent",
"random_access": true,
"range": {
"min": 1,
"max": 100,
"precision": 1
}
},
"state": {
"instance": "brightness",
"value": 100
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.color_setting",
"parameters": {
"color_model": "rgb",
"temperature_k": {
"min": 1700,
"max": 6500
}
},
"state": {
"instance": "temperature_k",
"value": 3400
},
"last_updated": 1626681729.2964342
}
],
"properties": []
},
{
"id": "lamp-id-3",
"name": "Лампочка 3",
"aliases": [],
"type": "devices.types.light",
"external_id": "external-lamp-id-3",
"skill_id": "skill-id-1",
"household_id": "household-id-1",
"room": "room-id-1",
"groups": [
"light-group-id-1"
],
"capabilities": [{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.on_off",
"parameters": {
"split": false
},
"state": {
"instance": "on",
"value": false
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.range",
"parameters": {
"instance": "brightness",
"unit": "unit.percent",
"random_access": true,
"range": {
"min": 1,
"max": 100,
"precision": 1
}
},
"state": {
"instance": "brightness",
"value": 100
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.color_setting",
"parameters": {
"color_model": "rgb",
"temperature_k": {
"min": 1700,
"max": 6500
}
},
"state": {
"instance": "temperature_k",
"value": 3400
},
"last_updated": 1626681729.2964342
}
],
"properties": []
},
{
"id": "vacuum-cleaner-id-1",
"name": "Пылесос",
"aliases": [],
"type": "devices.types.vacuum_cleaner",
"external_id": "external-vacuum-cleaner-id-1",
"skill_id": "skill-id-2",
"household_id": "household-id-1",
"room": "room-id-2",
"groups": [],
"capabilities": [{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.on_off",
"parameters": {
"split": false
},
"state": {
"instance": "on",
"value": false
},
"last_updated": 1626681729.2964342
},
{
"reportable": false,
"retrievable": true,
"type": "devices.capabilities.toggle",
"parameters": {
"instance": "pause"
},
"state": {
"instance": "pause",
"value": false
},
"last_updated": 1626681729.2964342
}
],
"properties": [{
"type": "devices.properties.float",
"reportable": false,
"retrievable": true,
"parameters": {
"instance": "battery_level",
"unit": "unit.percent"
},
"state": {
"instance": "battery_level",
"value": 100
},
"last_updated": 1626681729.2964342
}]
},
{
"id": "speaker-id-1",
"name": "Яндекс Станция",
"aliases": [],
"type": "devices.types.smart_speaker.yandex.station",
"external_id": "external-speaker-id-1",
"skill_id": "Q",
"household_id": "household-id-1",
"room": "room-id-1",
"groups": [],
"capabilities": [],
"properties": []
}
],
"scenarios": [{
"id": "scenario-id-1",
"name": "Световой будильник",
"is_active": true
},
{
"id": "scenario-id-2",
"name": "Время уборки",
"is_active": true
},
{
"id": "scenario-id-3",
"name": "Музыка для настолок",
"is_active": false
}
],
"households": [{
"id": "household-id-1",
"name": "Мой дом"
}]
}
```
- Ответ с ошибкой
```json translate=no
HTTP/1.1 500 Internal Server Error
{
"request_id": "9813e54b-021d-4203-b22a-02c6370d07b1",
"status": "error",
"message": "Внутренняя ошибка сервера"
}
```
{% endlist %}
[](https://yandex.ru/dev/dialogs/smart-home/doc/ru/feedback.md)
[*float]:
Число с плавающей точкой с точностью до 6-9 десятичных знаков.
[*string]:
Cтрока, выделяется кавычками, например `"Hello world"`.
[*boolean]:
Логическое значение без кавычек: `true` (истина) или `false` (ложь).
[*array]:
Массив элементов, разделенных запятой. Элементом могут быть стандартные элементы JSON: строка, число, `true`, `false`, объект или массив. Массив выделяется квадратными скобками `[]`:
```json translate=no
"cities": ["Moscow", "Tokyo", "New York"]
```
[*row-room-devices]:
**Тип**
[Array](*array) of [Strings](*string)
**Описание**
Массив идентификаторов устройств в комнате.
**Обязательный**
Да
[*row-group-id]:
**Тип**
[String](*string)
**Описание**
Идентификатор группы устройств.
**Обязательный**
Да
[*row-group-name]:
**Тип**
[String](*string)
**Описание**
Имя группы устройств.
**Обязательный**
Да
[*row-group-devices]:
**Тип**
[Array](*array) of [Strings](*string)
**Описание**
Массив идентификаторов устройств, входящих в группу.
**Обязательный**
Да
[*row-group-capability-type]:
**Тип**
[String](*string)
**Описание**
[Тип умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md#types).
**Обязательный**
Да
[*row-device-id]:
**Тип**
[String](*string)
**Описание**
Идентификатор устройства.
**Обязательный**
Да
[*row-device-name]:
**Тип**
[String](*string)
**Описание**
Имя устройства.
**Обязательный**
Да
[*row-device-aliases]:
**Тип**
[Array](*array) of [Strings](*string)
**Описание**
Массив с дополнительными именами устройства.
**Обязательный**
Да
[*row-device-type]:
**Тип**
[String](*string)
**Описание**
[Тип устройства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/device-types.md#types).
**Обязательный**
Да
[*row-device-room]:
**Тип**
[String](*string)
**Описание**
Идентификатор комнаты устройства. Значение `null` передается, если устройство не привязано к комнате.
**Обязательный**
Да
[*row-device-groups]:
**Тип**
[Array](*array) of [Strings](*string)
**Описание**
Массив с идентификаторами групп устройства.
**Обязательный**
Да
[*row-scenario-id]:
**Тип**
[String](*string)
**Описание**
Идентификатор сценария.
**Обязательный**
Да
[*row-scenario-name]:
**Тип**
[String](*string)
**Описание**
Название сценария.
**Обязательный**
Да
[*row-household-id]:
**Тип**
[String](*string)
**Описание**
Идентификатор дома.
**Обязательный**
Да
[*row-household-name]:
**Тип**
[String](*string)
**Описание**
Название дома.
**Обязательный**
Да
[*row-err-request-id]:
**Тип**
[String](*string)
**Описание**
Идентификатор запроса. Необходимо логировать для расследования инцидентов.
**Обязательный**
Да
[*row-err-status]:
**Тип**
[String](*string)
**Описание**
Статус обработки запроса. Допустимые значения:
- `error`.
**Обязательный**
Да
[*row-err-message]:
**Тип**
[String](*string)
**Описание**
Сообщение об ошибке.
**Обязательный**
Нет