Направление в ГИС ЖКХ запросов о наличии задолженности по оплате жилищно-коммунальных услуг
| Атрибут | Значение |
|---|---|
| Название | zhkh-debt-requests |
| Наименование | Направление в ГИС ЖКХ запросов о наличии задолженности по оплате жилищно-коммунальных услуг |
| Тип | Адаптер для СМЭВ3 сервиса |
| Версия СМЭВ | СМЭВ3 |
| Версия ВС | 1.0.0 |
| Версия МР | 3.4 |
flowchart LR;
A[ИС организации] <--> B[Агредатор];
B <--> C[СМЭВ];
C <--> D[ГИС ЖКХ];
Описание бизнес-процесса взаимодействия: ИС организации хочет направить запрос о наличии или отсутствии задолженности по оплате услуг ЖКХ.
ИС организации отправляет запрос через Агредатор, Агредатор в свою очередь отправляет запрос в СМЭВ к виду сведений, СМЭВ получает запрос и направляет его к ГИС ЖКХ.
После получения запроса, ГИС ЖКХ проверяет корректность полученных данных, далее через СМЭВ направляет в Агредатор уведомление об успешном принятии запроса или сведения о системной ошибке, возникшей в ходе обработки запроса, Агредатор направляет данную информацию в ИС организации.
Если отправка запроса не произошла, то Агредатор получит от СМЭВ сообщение об ошибке и передаст его в ИС организации.
Переменные окружения
| Название | Описание |
|---|---|
| CA_CERT | Сертификат центра сертификации для подключения к rabbitmq |
| CLIENT_CERT | Сертификат, используемый для подключения к rabbitmq |
| CLIENT_KEY | Ключ, используемый для подключения к rabbitmq |
| MQ_HOST | Хост rabbitmq |
| MQ_PORT | Порт rabbitmq |
| SMEV_SERVICE | Название смэв сервиса, на который будут отправляться запросы |
| USE_PERSONAL_SIGNATURE | Необходимость подписи должностного лица (ЭП-СП) |
| SIGN_SERVICE | Сервис, генерирующий подпись должностного лица |
Переменные для конфигурирования подключения к БД:
DATABASE_HOST, DATABASE_PORT, DATABASE_NAME, DATABASE_USER, DATABASE_PASS.
Переменные для конфигурирования отправки метрик в Elasticsearch:
ELASTIC_HOST, ELASTIC_PORT, ELASTIC_METRIC_PREFIX
Принимаемые параметры
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| information_system_id | Идентификатор информационной системы | + | 35a823b4-55da-4622-a561-6bae5c0a00ba |
| organization_id | Идентификатор зарегистрированной организации | + | 6eef689e-48bb-4eb0-9c11-18b6db9909b7 |
| actions | Операции над запросами о наличии задолженности за ЖКУ | + | Последовательность элементов Action |
Структура элемента Action
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transport_id | Транспортный идентификатор | +1 | 03eb8e-6f80-11eb-9439-0242ac130002 |
| request_id | Идентификатор запроса о наличии задолженности за ЖКУ. Обязателен для операции Revoke. Для операции Send указывается в том случае, если поставщикам ЖКУ направляется уже существующий в ГИС ЖКХ запрос | - | 00000000-0000-0000-0000-000000000000 |
| action_type | Тип операции над запросом о наличии задолженности за ЖКУ. Допустимые значения: SEND - Направить запрос поставщикам ЖКУ; REVOKE - Отозвать запрос, ранее направленный поставщикам ЖКУ. Для операции SEND должен быть указан хотя бы один из элементов request_id или request_data. |
+ | SEND |
| request_data | Данные запроса о наличии задолженности за ЖКУ. Указывается только для операции SEND. Если операция связана с уже существующим в ГИС ЖКХ запросом (указан элемент request-id), то контент элемента используется для изменения запроса перед его направлением поставщикам ЖКУ. В противном случае, контент элемента используется для создания в ГИС ЖКХ нового запроса, который направляется поставщикам ЖКУ | - | Составной элемент RequestData |
1 - transport_id должен быть уникальным среди других action, переданных в текущем запросе
Структура элемента RequestData
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| applicant_info | Информация о заявителе | + | Структура элемента ApplicantInfo |
| housing_fund_object | Сведения об объекте жилищного фонда (ОЖФ), по которому осуществляется запрос | + | Составной элемент HousingFundObject |
| executor_id | Идентификатор сотрудника, сформировавшего запрос | + | df82b6d8-66d8-11eb-ae93-0242ac130002 |
Структура элемента ApplicantInfo
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| firstname | Имя | + | Иван |
| lastname | Фамилия | + | Иванов |
| middlename | Отчество | - | Иванович |
| snils | СНИЛС | + | 11111111145 |
| document | Документ, удостоверяющий личность заявителя | + | Составной элемент Document |
Структура элемента Document
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| type | Код документа, удостоверяющего личность. Допускаются любые значения из справочника ГИС ЖКХ "Документ, удостоверяющий личность" (НСИ #95) | + | 1 |
| series | Серия | + | 1234 |
| number | Номер | + | 123456 |
Структура элемента HousingFundObject
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| house_id | Идентификатор дома в Реестре адресных объектов ГИС ЖКХ | + | e786b770-28e6-4557-8dde-86e8e347587e |
| address-details | Дополнительная информация об ОЖФ (номер квартиры / помещения, комнаты, блока жилого дома). Обязателен для ОЖФ, имеющих тип многоквартирный дом или жилой дом блокированной застройки. Не указывается для ОЖФ, имеющих тип жилой дом | - | кв. 27 |
Параметры ответа
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| result | Список результатов импорта по каждой сущности | -1 | Составной элемент Result |
| error | Ошибка импорта | -1 | Составной элемент Error |
1 - обязательно присутствует только один из элементов
Структура элемента Result
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transport_id | Транспортный идентификатор | + | be03eb8e-6f80-11eb-9439-0242ac130002 |
| success | Успешный результат | -1 | Составной элемент Success |
| errors | Список ошибок | -1 | Последовательность элементов Error |
1 - обязательно присутствует только один из элементов
Структура элемента Error
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| error_code | Код ошибки | + | EXP001000 |
| description | Описание ошибки | + | Произошла ошибка при передаче данных. Попробуйте осуществить передачу данных повторно. В случае, если повторная передача данных не проходит - направьте обращение в службу поддержки пользователей ГИС ЖКХ. |
| stacktrace | StackTrace в случае возникновения исключения | - |
Структура элемента Success
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор объекта в ГИС ЖКХ | - | 8e495b0a-66f1-11eb-ae93-0242ac130002 |
| update_date | Дата модификации | - | 2021-02-04T13:45:47.000+03:00 |
Примеры
Для проверки настройки сервиса можно отправить в консоли отправки панели запрос соответствующего примера, и получить соответствующий ответ.
Пример 1
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"actions": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"action_type": "SEND",
"request_data": {
"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"
},
"executor_id": "df82b6d8-66d8-11eb-ae93-0242ac130002"
}
}
]
}
Ответ:
{
"result": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"success": {
"id": "3d62cf5c-66d6-11eb-ae93-0242ac130002",
"update_date": "2021-02-04T13:45:47.000+03:00"
}
}
]
}
Пример 2
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"actions": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"request_id": "00000000-0000-0000-0000-000000000000",
"action_type": "SEND"
}
]
}
Ответ:
{
"result": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"errors": [
{
"error_code": "INT054003",
"description": "Запрос о наличии задолженности за ЖКУ с уникальным идентификатором 00000000-0000-0000-0000-000000000000 не найден или имеет статус, отличный от статуса \"Проект\""
}
]
}
]
}
Пример 3
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"actions": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"request_id": "8e495b0a-66f1-11eb-ae93-0242ac130002",
"action_type": "SEND",
"request_data": {
"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"
},
"executor_id": "df82b6d8-66d8-11eb-ae93-0242ac130002"
}
}
]
}
Ответ:
{
"result": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"success": {
"id": "8e495b0a-66f1-11eb-ae93-0242ac130002",
"update_date": "2021-02-04T13:45:47.000+03:00"
}
}
]
}
Пример 4
Запрос:
{
"information_system_id": "35a823b4-55da-4622-a561-6bae5c0a00ba",
"organization_id": "6eef689e-48bb-4eb0-9c11-18b6db9909b7",
"actions": [
{
"transport_id": "be03eb8e-6f80-11eb-9439-0242ac130002",
"request_id": "8e495b0a-66f1-11eb-ae93-0242ac130002",
"action_type": "REVOKE"
}
]
}
Ответ:
{
"error": {
"error_code": "EXP001000",
"description": "Произошла ошибка при передаче данных. Попробуйте осуществить передачу данных повторно. В случае, если повторная передача данных не проходит - направьте обращение в службу поддержки пользователей ГИС ЖКХ"
}
}