Выгрузка из ГИС ЖКХ ответов поставщиков жилищно-коммунальных услуг на запросы о наличии задолженности по оплате
Атрибут |
Значение |
Название |
zhkh-debt-responses |
Наименование |
Выгрузка из ГИС ЖКХ ответов поставщиков жилищно-коммунальных услуг на запросы о наличии задолженности по оплате |
Тип |
Адаптер для СМЭВ3 сервиса |
Версия СМЭВ |
СМЭВ3 |
Версия ВС |
1.0.0 |
Версия МР |
3.0 |
Переменные окружения
Название |
Описание |
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.
Принимаемые параметры
Параметр |
Описание |
Обязательное |
Пример |
information_system_id |
Идентификатор информационной системы |
+ |
b6d9d2d2-33a6-4982-9ffd-6a0010be9bf9 |
organization_id |
Идентификатор зарегистрированной организации |
+ |
59749f1b-8feb-41f7-96d7-2a287ce233d5 |
request_ids |
Идентификаторы запросов о наличии задолженности за ЖКУ |
-1 |
["27f2b925-45e6-4802-9006-d7822542a29c"] |
request_numbers |
Номер запросов, присвоенный ГИС ЖКХ |
-1 |
["1234567890"] |
criteria |
Условия отбора по атрибутам запроса |
-1 |
Составной элемент Criteria |
1 - обязательно должен присутствовать только один из элементов
Структура элемента Criteria
Параметр |
Описание |
Обязательное |
Пример |
request_creation_period |
Период создания запроса в ГИС ЖКХ. Указываемый период не должен превышать 6-ти месяцев |
+ |
Составной элемент RequestPeriod |
period_of_sending_request |
Период направления запроса поставщикам ЖКУ. Указываемый период не должен превышать 6-ти месяцев |
- |
Составной элемент RequestPeriod |
period_of_response_date |
Период крайнего срока ответа на запрос |
- |
Составной элемент OpenPeriod |
applicant_info |
Информация о заявителе |
- |
Составной элемент ApplicantInfo |
house_ids |
Идентификатор домов в Реестре адресных объектов ГИС ЖКХ, по которому осуществляются запросы. (не более 100 штук) |
- |
["3463557f-4ade-4852-9355-07d79533ceb4"] |
request_statuses |
Статусы запросов в ГИС ЖКХ (не более 4) |
- |
["DRAFT"] |
request_results |
Результаты выполнения запросов о наличии задолженности за ЖКУ |
- |
[1,2,3] |
export_request_id |
Идентификатор, используемый для экспорта 2-го и последующих блоков данных |
- |
1e029a86-215b-4cd7-bbd3-d78a216b655c |
Структура элемента RequestPeriod
Параметр |
Описание |
Обязательное |
Пример |
start |
Начало периода |
+ |
2021-02-04 |
end |
Конец периода |
+ |
2021-02-04 |
Структура элемента OpenPeriod
Параметр |
Описание |
Обязательное |
Пример |
start |
Начало периода |
- |
2012-04-04 |
end |
Конец периода |
- |
2012-04-04 |
Структура элемента ApplicantInfo
Параметр |
Описание |
Обязательное |
Пример |
firstname |
Имя |
- |
Петр |
lastname |
Фамилия |
- |
Петров |
middlename |
Отчество |
- |
Петрович |
snils |
СНИЛС |
- |
12345678901 |
document |
Документ, удостоверяющий личность заявителя |
- |
Document |
Структура элемента Document
Параметр |
Описание |
Обязательное |
Пример |
type |
Вид документа |
+ |
1 |
series |
Серия |
+ |
1234 |
number |
Номер |
+ |
123456 |
Параметры ответа
Параметр |
Описание |
Обязательное |
Пример |
request_data |
В ГИС ЖКХ данные запроса о наличии задолженности за ЖКУ |
- |
Последовательность элементов RequestData |
found_not |
Запросы о наличии задолженности за ЖКУ, данные о которых не найдены в ГИС ЖКХ |
- |
Составной элемент FoundNot |
paged_output |
Параметры, необходимые для экспорта следующего блока данных |
- |
Составной элемент PagedOutput |
error |
Ошибка контроля или бизнес-процесса |
- |
Составной элемент Error |
attachments |
Информация о полученных вложениях, сохраненных в файловом хранилище Агредатора |
- |
Последовательность элементов AggredatorAttachment |
Структура элемента RequestData
Параметр |
Описание |
Обязательное |
Пример |
request_id |
Идентификатор запроса, присвоенный в ГИС ЖКХ |
+ |
d1fedc52-b86a-47a0-826b-f0482566ebdc |
request_number |
Номер запроса, присвоенный в ГИС ЖКХ |
+ |
123456789 |
applicant_info |
Информация о заявителе |
+ |
Составной элемент ApplicantResponseInfo |
house_fund_object |
Сведения об объекте жилищного фонда (ОЖФ), по которому осуществляется запрос |
+ |
Составной элемент HouseFundObject |
period |
Период, за который запрашивается задолженность |
- |
Составной элемент Period |
organization |
Сформировавшая запрос организация |
+ |
Составной элемент Organization |
executor_info |
Информация о сотруднике, сформировавшем запрос |
+ |
Составной элемент ExecutorInfo |
status |
Статус запроса в ГИС ЖКХ о наличии задолженности за ЖКУ |
+ |
PROCESSED |
result |
Результат выполнения запроса |
+ |
4 |
creation_date |
Дата создания запроса |
+ |
2021-02-04+03:00 |
sent_date |
Дата направления запроса поставщикам ЖКУ |
- |
2021-02-04+03:00 |
response_date |
Крайний срок ответа на запрос |
- |
2021-02-08+03:00 |
subrequests |
Запросы, направленные организациям, предоставляющим ЖКУ |
- |
Последовательность элементов Subrequest |
Структура элемента FoundNot
Параметр |
Описание |
Обязательное |
Пример |
request_ids |
Идентификаторы запроса о наличии задолженности за ЖКУ |
- |
["b5fb85dd-023f-45b4-9676-19343f661edd"] |
request_numbers |
Номера запросов, присвоенные в ГИС ЖКХ |
- |
["1b18626d-c5d8-4aa5-b383-bdb19c268b44"] |
Структура элемента PagedOutput
Параметр |
Описание |
Обязательное |
Пример |
next_request_id |
Идентификатор, который необходимо указать в элементе export_request_id для экспорта следующего блока данных |
- |
2f353cfc-4cc8-41db-b469-752b35deda4c |
last_page |
Признак того, что текущий экспортируемый блок является последним |
- |
true |
Структура элемента Error
Параметр |
Описание |
Обязательное |
Пример |
error_code |
Код ошибки |
+ |
INT002012 |
description |
Описание ошибки |
+ |
Нет объектов для экспорта |
stacktrace |
StackTrace в случае возникновения исключения |
- |
|
Структура элемента AggredatorAttachment
Параметр |
Описание |
Обязательное |
Пример |
uuid |
Идентификатор файла в файловом хранилище Агредатора |
+ |
7ca24dd0450bf0cc509f384f6198ff9ac12dd52f0ef1fc10d3af8c14c49876aa |
checksum |
Контрольная сумма |
+ |
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 |
created_at |
Время загрузки файла |
+ |
2020-11-16T12:27:20.726+03:00 |
tags |
Последовательность строк-тегов файла |
+ |
["test"] |
filename |
Имя загруженного файла |
+ |
test.txt |
smev_id |
Идентификатор вложения, используемый в СМЭВ конверте |
+ |
attachment.txt |
Структура элемента ApplicantResponseInfo
Параметр |
Описание |
Обязательное |
Пример |
firstname |
Имя |
+ |
Петр |
lastname |
Фамилия |
+ |
Петров |
middlename |
Отчество |
- |
Петрович |
snils |
СНИЛС |
+ |
12345678910 |
document |
Документ, удостоверяющий личность заявителя |
+ |
Document |
Структура элемента HouseFundObject
Параметр |
Описание |
Обязательное |
Пример |
house_id |
Идентификатор дома в Реестре адресных объектов ГИС ЖКХ |
+ |
ac86917f-cf3d-4768-93e8-aac35566018a |
address_details |
Дополнительная информация об ОЖФ (номер квартиры / помещения, комнаты, блока жилого дома). Обязателен для ОЖФ, имеющих тип многоквартирный дом или жилой дом блокированной застройки. Не указывается для ОЖФ, имеющих тип жилой дом |
- |
кв. 27 |
fias_house_id |
Идентификатор дома по ФИАС |
+ |
a266b05d-4b0b-42bf-b4b6-6db5a368fa1c |
address |
Адресная строка |
+ |
153045, Ивановская обл, г. Иваново, ул. 3 Июня, д. 14 |
Структура элемента Period
Параметр |
Описание |
Обязательное |
Пример |
start_date |
Начало периода |
+ |
2018-02-01+03:00 |
end_date |
Конец периода |
+ |
2021-01-31+03:00 |
Структура элемента Organization
Параметр |
Описание |
Обязательное |
Пример |
organization_root_id |
Корневой идентификатор организации (в Реестре организаций ГИС ЖКХ) |
+ |
f8bead93-37bc-4408-93f2-86a1594c6896 |
name |
Наименование организации |
+ |
Администрация г. Иваново |
tel |
Телефон организации |
- |
+7(4932)32-80-83 |
Структура элемента ExecutorInfo
Параметр |
Описание |
Обязательное |
Пример |
id |
Идентификатор исполнителя |
+ |
c845aa8a-3398-4ac0-9bd4-7e5d611dd8a5 |
fio |
ФИО исполнителя |
+ |
Четвертак Иван Иванович |
Структура элемента Subrequest
Параметр |
Описание |
Обязательное |
Пример |
organization |
Организация, представляющая ЖКУ |
+ |
Составной элемент Organization |
response |
Ответ организации |
- |
Составной элемент Response |
Структура элемента Document
Параметр |
Описание |
Обязательное |
Пример |
type |
Вид документа |
+ |
1 |
series |
Серия |
+ |
1234 |
number |
Номер |
+ |
123456 |
Структура элемента Response
Параметр |
Описание |
Обязательное |
Пример |
type |
Способ формирования ответа на подзапрос |
- |
PROVIDED |
has_debt |
Признак наличия задолженности, подтвержденной судебным актом |
- |
false |
debt_info |
Информация о непогашенной задолженности, подтвержденной судебным актом |
- |
DebtInfo |
additional_files |
Дополнительный файл |
- |
Attachment |
description |
Дополнительная информация |
- |
|
executor_info |
Информация о сотруднике, сформировавшем ответ |
- |
ExecutorInfo |
Структура элемента DebtInfo
Параметр |
Описание |
Обязательное |
Пример |
person |
Информация о лице, в отношении которого имеется задолженность |
+ |
Составной элемент DebtPerson |
documents |
Документ, подтверждающий задолженность |
- |
Последовательность элементов CourtDocument |
Структура элемента DebtPerson
Параметр |
Описание |
Обязательное |
Пример |
firstname |
Имя |
+ |
Петр |
lastname |
Фамилия |
+ |
Петров |
middlename |
Отчество |
- |
Петрович |
snils |
СНИЛС |
- |
12345678910 |
document |
Документ, удостоверяющий личность |
- |
Составной элемент Document |
Структура элемента CourtDocument
Параметр |
Описание |
Обязательное |
Пример |
type |
Код типа документа судебного акта |
+ |
1 |
attachment |
Прикрепленный файл |
+ |
Составной элемент Attachment |
Структура элемент Attachment
Параметр |
Описание |
Обязательное |
Пример |
metadata |
Информация о файле |
+ |
Составной элемент FileInformation |
smev_attachment_ref_guid |
Уникальный идентификатор вложения из блока RefAttachmentHeaderList сообщения СМЭВ |
- |
df8aa667-0875-4eb2-bc63-5f2b34f3b3a1 |
Параметр |
Описание |
Обязательное |
Пример |
guid |
Уникальный идентификатор файла |
+ |
dcced63b-d0b6-438a-b3fd-9343e5bbbf38 |
name |
Наименование файла |
+ |
|
description |
Описание файла |
- |
|
hash |
Хэш-сумма, рассчитанная по алгоритму ГОСТ-34 в binhex |
- |
|
Примеры
Для проверки настройки сервиса можно отправить в консоли отправки панели администрирования отправить запрос соответствующий контрольному примеру и получить соответствующий ответ.
Пример 1
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"request_ids": [
"bac4c940-6ad3-11eb-9439-0242ac130002",
"00000000-0000-0000-0000-000000000000"
]
}
Ответ:
{
"request_data": [
{
"request_id": "bac4c940-6ad3-11eb-9439-0242ac130002",
"request_number": "022021173",
"applicant_info": {
"firstname": "Иван",
"lastname": "Иванов",
"middlename": "Иванович",
"snils": "11111111145",
"document": {
"type": "1",
"series": "1234",
"number": "123456"
}
},
"housing_fund_object": {
"house_id": "e786b770-28e6-4557-8dde-86e8e347587e",
"address_details": "кв. 27",
"fias_house_id": "497cdeef-0388-466b-a063-36f51d94800c",
"address": "153045, Ивановская обл, г. Иваново, ул. 3 Июня, д. 14"
},
"period": {
"start_date": "2018-02-01+03:00",
"end_date": "2021-01-31+03:00"
},
"organization": {
"organization_root_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"name": "Администрация г. Иваново",
"tel": "+7(4932)32-80-83"
},
"executor_info": {
"id": "84b12e02-6ad8-11eb-9439-0242ac130002",
"fio": "Четвертак Иван Иванович"
},
"status": "PROCESSED",
"result": "4",
"creation_date": "2021-02-04+03:00",
"sent_date": "2021-02-04+03:00",
"response_date": "2021-02-08+03:00",
"subrequests": [
{
"organization": {
"organization_root_id": "ad50290c-6ad9-11eb-9439-0242ac130002",
"name": "УК ООО \"ГУЖФ\"",
"tel": "8-800-200-50-58"
},
"response": {
"type": "PROVIDED",
"has_debt": "false",
"executor_info": {
"id": "38a794b8-6ada-11eb-9439-0242ac130002",
"fio": "Герасимова Ольга Ивановна"
}
}
}
]
}
],
"not_found": {
"request_ids": [
"00000000-0000-0000-0000-000000000000"
]
}
}
Пример 2
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"request_numbers": [
"022021173",
"0220210"
]
}
Ответ:
{
"request_data": [
{
"request_id": "bac4c940-6ad3-11eb-9439-0242ac130002",
"request_number": "022021173",
"applicant_info": {
"firstname": "Иван",
"lastname": "Иванов",
"middlename": "Иванович",
"snils": "11111111145",
"document": {
"type": "1",
"series": "1234",
"number": "123456"
}
},
"housing_fund_object": {
"house_id": "e786b770-28e6-4557-8dde-86e8e347587e",
"address_details": "кв. 27",
"fias_house_id": "497cdeef-0388-466b-a063-36f51d94800c",
"address": "153045, Ивановская обл, г. Иваново, ул. 3 Июня, д. 14"
},
"period": {
"start_date": "2018-02-01+03:00",
"end_date": "2021-01-31+03:00"
},
"organization": {
"organization_root_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"name": "Администрация г. Иваново",
"tel": "+7(4932)32-80-83"
},
"executor_info": {
"id": "84b12e02-6ad8-11eb-9439-0242ac130002",
"fio": "Четвертак Иван Иванович"
},
"status": "PROCESSED",
"result": "4",
"creation_date": "2021-02-04+03:00",
"sent_date": "2021-02-04+03:00",
"response_date": "2021-02-08+03:00",
"subrequests": [
{
"organization": {
"organization_root_id": "ad50290c-6ad9-11eb-9439-0242ac130002",
"name": "УК ООО \"ГУЖФ\"",
"tel": "8-800-200-50-58"
},
"response": {
"type": "PROVIDED",
"has_debt": "false",
"executor_info": {
"id": "38a794b8-6ada-11eb-9439-0242ac130002",
"fio": "Герасимова Ольга Ивановна"
}
}
}
]
}
],
"not_found": {
"request_numbers": [
"0220210"
]
}
}
Пример 3
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"criteria": {
"request_creation_period": {
"start": "2021-02-04",
"end": "2021-02-04"
},
"house_ids": [
"e786b770-28e6-4557-8dde-86e8e347587e"
]
}
}
Ответ:
{
"request_data": [
{
"request_id": "bac4c940-6ad3-11eb-9439-0242ac130002",
"request_number": "022021173",
"applicant_info": {
"firstname": "Иван",
"lastname": "Иванов",
"middlename": "Иванович",
"snils": "11111111145",
"document": {
"type": "1",
"series": "1234",
"number": "123456"
}
},
"housing_fund_object": {
"house_id": "e786b770-28e6-4557-8dde-86e8e347587e",
"address_details": "кв. 27",
"fias_house_id": "497cdeef-0388-466b-a063-36f51d94800c",
"address": "153045, Ивановская обл, г. Иваново, ул. 3 Июня, д. 14"
},
"period": {
"start_date": "2018-02-01+03:00",
"end_date": "2021-01-31+03:00"
},
"organization": {
"organization_root_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"name": "Администрация г. Иваново",
"tel": "+7(4932)32-80-83"
},
"executor_info": {
"id": "84b12e02-6ad8-11eb-9439-0242ac130002",
"fio": "Четвертак Иван Иванович"
},
"status": "PROCESSED",
"result": "4",
"creation_date": "2021-02-04+03:00",
"sent_date": "2021-02-04+03:00",
"response_date": "2021-02-08+03:00",
"subrequests": [
{
"organization": {
"organization_root_id": "ad50290c-6ad9-11eb-9439-0242ac130002",
"name": "УК ООО \"ГУЖФ\"",
"tel": "8-800-200-50-58"
},
"response": {
"type": "PROVIDED",
"has_debt": "false",
"executor_info": {
"id": "38a794b8-6ada-11eb-9439-0242ac130002",
"fio": "Герасимова Ольга Ивановна"
}
}
}
]
}
],
"paged_output": {
"last_page": true
}
}
Пример 4
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"criteria": {
"request_creation_period": {
"start": "2021-02-04",
"end": "2021-02-04"
},
"house_ids": [
"00000000-0000-0000-0000-000000000000"
]
}
}
Ответ:
{
"error": {
"error_code": "INT002012",
"description": "Нет объектов для экспорта"
}
}