Выгрузка информации о начислениях, о произведенных платежах и характеристиках объектов жилищного фонда
| Атрибут | Значение |
|---|---|
| Название | zhkh-dom-gosuslugi-accruals-payments |
| Наименование | Выгрузка информации о начислениях, о произведенных платежах и характеристиках объектов жилищного фонда |
| Тип | Адаптер для СМЭВ3 сервиса |
| Версия СМЭВ | СМЭВ3 |
| Версия ВС | 1.0.2 |
| Версия МР | 3.4 |
| Поставщик | Акционерное общество «Оператор информационной системы» |
| Потребители | ЕГИССО, ПФР |
Описание бизнес-процесса взаимодействия:
ИС организации хочет получить информацию о начислениях, платежах и характеристиках объектов жилищного фонда.
ИС организации отправляет запрос через Агредатор, Агредатор в свою очередь отправляет запрос в СМЭВ к виду сведений, СМЭВ получает запрос и направляет его к ИС АО «Оператор информационной системы».
После получения запроса АО «Оператор информационной системы» проверяет корректность полученных данных, далее через СМЭВ направляет в Агредатор запрошенные сведения или отказ в предоставлении сведений, Агредатор направляет данную информацию в ИС организации.
Если отправка запроса не произошла, то Агредатор получит от СМЭВ сообщение об ошибке и передаст его в ИС организации.
Переменные окружения
| Название | Описание |
|---|---|
| CA_CERT | Сертификат центра сертификации для подключения к rabbitmq |
| CLIENT_CERT | Сертификат, используемый для подключения к rabbitmq |
| CLIENT_KEY | Ключ, используемый для подключения к rabbitmq |
| MQ_HOST | Хост rabbitmq |
| MQ_PORT | Порт rabbitmq |
| SMEV_SERVICE | Название СМЭВ сервиса, на который будут отправляться запросы |
Переменные для конфигурирования подключения к БД:
DATABASE_HOST, DATABASE_PORT, DATABASE_NAME, DATABASE_USER, DATABASE_PASS.
Переменные для конфигурирования отправки метрик в Elasticsearch:
ELASTIC_HOST, ELASTIC_PORT, ELASTIC_METRIC_PREFIX
Принимаемые параметры
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор бизнес запроса. В соответствии с требованиями СМЭВ, атрибут обязателен при необходимости наложения ЭП-СП на запрос. | - | ID1 |
| information_system_id | Идентификатор информационной системы | + | 5ffb153e-f5f8-4578-8427-a0bdaf229d60 |
| organization_id | Идентификатор организации | + | 1fb5a683-d77c-4b2f-ac64-191ad2b02ddb |
| information_type | Тип сведений. Возможные значения: ACCRUALS - информация о начислениях; PAYMENTS - информация о произведенных платежах. | + | PAYMENTS |
| housing_fund_object | Информация об объекте жилищного фонда | +1 | Массив составных элементов HousingFundObject |
| unified_account_number | Единый лицевой счет | +1 | Массив номеров единого лицевого счета ["70ББ000584", "70ББ000585"] |
| start_date | Дата начала периода. День даты должен быть равен 1. | + | 2022-01-01 |
| end_date | Дата окончания периода. День даты должен быть равен 1. | + | 2022-05-01 |
1 - должен быть заполнен только один из элементов
Структура элемента HousingFundObject
Информация об объекте жилищного фонда
| Параметр | Название | Обязательное | Пример |
|---|---|---|---|
| apartment_house | Помещение или комната в многоквартирном доме | +1 | Составной элемент ApartmentHouse |
| living_house | Жилой дом или комната в жилом доме | +1 | Составной элемент LivingHouse |
| living_block_house | Блок или комната в жилом доме блокированной застройки | +1 | Составной элемент LivingBlockHouse |
1 - должен быть заполнен только один из элементов
Структура элемента ApartmentHouse
Помещение или комната в многоквартирном доме
| Параметр | Название | Обязательное | Пример |
|---|---|---|---|
| premise_guid | Глобальный уникальный идентификатор помещения | +1 | 796e7d71-2750-4367-ad0d-bdbe2dface73 |
| room_guid | Глобальный уникальный идентификатор комнаты | +1 | 84304cfd-3721-4906-9f5e-be8feb8817b0 |
1 - должен быть заполнен только один из элементов
Структура элемента LivingHouse
Жилой дом или комната в жилом доме
| Параметр | Название | Обязательное | Пример |
|---|---|---|---|
| fias_house_code | Глобальный уникальный идентификатор дома по ФИАС / Идентификационный код дома в ГИС ЖКХ | +1 | 97dd1052-29e7-44d7-a0f7-70b18dd00a41 |
| hm_house_guid | Глобальный уникальный идентификатор дома (РОЖФ) | +1 | 6c7d8fea-447f-409b-8328-64513e8f2561 |
| room_guid | Глобальный уникальный идентификатор комнаты | +1 | 84304cfd-3721-4906-9f5e-be8feb8817b0 |
1 - должен быть заполнен только один из элементов
Структура элемента LivingBlockHouse
Блок или комната в жилом доме блокированной застройки
| Параметр | Название | Обязательное | Пример |
|---|---|---|---|
| premise_guid | Глобальный уникальный идентификатор помещения/блока | +1 | 796e7d71-2750-4367-ad0d-bdbe2dface73 |
| room_guid | Глобальный уникальный идентификатор комнаты | +1 | 84304cfd-3721-4906-9f5e-be8feb8817b0 |
1 - должен быть заполнен только один из элементов
Параметры ответа
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| exported_to_ftp | Признак того, что в качестве результата запроса сформирован файл, который выложен на FTP. Элемент имеет фиксированное значение true (fixed="true") | + | true |
| create_date | Дата и время формирования файла, содержащего информации о начислениях, о произведенных платежах и характеристиках объектов жилищного фонда | + | 2001-12-17T09:30:47.000+03:00 |
| error | Список ошибок, возникших при обработке запроса | - | Массив составных элементов Error |
| attachment | Информация о связанном вложении | - | Составной элемент AggredatorAttachment |
Вложение предоставляется потребителю в виде zip-архива, содержащего xml-файл с экспортируемой информацией, передаваемого в ответе на запрос как внешнее вложение. Имя zip-архива, содержащего выгрузку, имеет вид GUID.ZIP, где GUID – глобальный уникальный идентификатор, генерируемый для ответа на запрос. Описание структуры выгрузки представлено элементом ExportAccrualsPaymentsPackage схемы dom-gosuslugi-ru-smev3-accruals-payments-egisso.xsd.
Структура элемента Error
Ошибка, возникщая при обработке запроса
| Параметр | Название | Обязательное | Пример |
|---|---|---|---|
| error_code | Код ошибки | + | |
| description | Описание ошибки | + | |
| stacktrace | StackTrace в случае возникновения исключения | - |
Структура элемента AggredatorAttachment
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| uuid | Идентификатор файла в хранилище | + | 4833e4c4385dc47f2d2a08469f246e7cd1f66f416691d0b5a92a00d722f8d4ec |
| checksum | Контрольная сумма | + | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 |
| created_at | Время загрузки файла | + | 2020-11-16T12:27:20.726+03:00 |
| tags | Последовательность строк-тегов файла | + | ["test"] |
| metadata | Метаданные | + | {} |
| delete_at | Время, когда файл будет удален из хранилища. В случае, если значение равно null - файл не будет удален | + | null |
| filename | Имя загруженного файла | + | test.txt |
| store | Хранилище, в котором хранится файл | + | db |
| identifier_in_store | Идентификатор файла в хранилище | + | 4833e4c4385dc47f2d2a08469f246e7cd1f66f416691d0b5a92a00d722f8d4ec |
| smev_id | Идентификатор вложения, используемый в СМЭВ конверте | + | attachment.txt |
Примеры
Для проверки настройки сервиса можно в консоли отправки панели администрирования отправить запрос, соответствующий контрольному примеру, и получить соответствующий ответ.
{
"id": "ID1",
"information_system_id": "5ffb153e-f5f8-4578-8427-a0bdaf229d60",
"organization_id": "1fb5a683-d77c-4b2f-ac64-191ad2b02ddb",
"information_type": "ACCRUALS",
"housing_fund_object": [
{
"apartment_house": {
"premise_guid": "796e7d71-2750-4367-ad0d-bdbe2dface73"
}
},
{
"apartment_house": {
"room_guid": "84304cfd-3721-4906-9f5e-be8feb8817b0"
}
},
{
"living_house": {
"fias_house_code": "97dd1052-29e7-44d7-a0f7-70b18dd00a41"
}
},
{
"living_house": {
"room_guid": "6fe7adb5-3ab0-419a-bd37-bd26c8de2787"
}
},
{
"living_house": {
"hm_house_guid": "6c7d8fea-447f-409b-8328-64513e8f2561"
}
}
],
"start_date": "2022-01-01",
"end_date": "2022-05-01"
}
В случае корректной настройки должен прийти следующий ответ:
{
"exported_to_ftp": "true",
"create_date": "2001-12-17T09:30:47.000+03:00"
}