Передача статусов и результатов предоставления государственных и муниципальных услуг
| Атрибут | Значение |
|---|---|
| Название | epgu-status |
| Наименование | Передача статусов и результатов предоставления государственных и муниципальных услуг |
| Тип | Адаптер для СМЭВ3 сервиса |
| Область применения | Межведомственное взаимодействие |
| Версия СМЭВ | СМЭВ3 |
| Версия ВС | 1.0.2 |
| Версия МР | 3.5 |
| Поставщик | Министерство цифрового развития, связи и массовых коммуникаций Российской Федерации |
| Потребители | По согласованию с Поставщиком |
Описание бизнес-процесса взаимодействия:
Организация хочет передать статусы и результаты предоставления государственных и муниципальных услуг гражданину в личный кабинет на ЕПГУ.
ИС организации отправляет запрос через Агредатор, Агредатор в свою очередь отправляет запрос в СМЭВ к виду сведений, СМЭВ получает запрос и направляет его в ЛК ЕПГУ.
Результат обработки запроса через СМЭВ направляется в Агредатор, Агредатор направляет данную информацию в ИС организации.
Если отправка запроса не произошла, то Агредатор получит от СМЭВ сообщение об ошибке и передаст его в ИС организации.
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 | Название СМЭВ сервиса, на который будут отправляться запросы |
Переменные для конфигурирования подключения к БД:
DATABASE_HOST, DATABASE_PORT, DATABASE_NAME, DATABASE_USER, DATABASE_PASS.
Переменные для конфигурирования отправки метрик в Elasticsearch:
ELASTIC_HOST, ELASTIC_PORT, ELASTIC_METRIC_PREFIX
Принимаемые параметры
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| env | значение используется для маршрутизации между средами ЕПГУ. В продуктивной среде допустимо только значение «EPGU». В тестовой среде значение «SVCDEV» | + | EPGU |
| create_orders | Запросы создания заявлений | -1 | Массив (1-unbounded) составных элементов CreateOrder |
| update_orders | Запросы изменения заявлений | -1 | Массив (1-unbounded) составных элементов UpdateOrder |
1 - обязательно должен присутствовать один из элементов
Структура элемента CreateOrder
Создание заявления
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| user | Данные заявителя (ФЛ) | -1 | Составной элемент User |
| org_id | Идентификатор организации в ЕСИА (ЮЛ / ИП) | -1 | |
| organization | Данные заявителя (ЮЛ/ИП) | -1 | Составной элемент Organization |
| sender_kpp | КПП организации, предоставляющей услугу (для ФОИВ – центральный аппарат) | - | 000000000 |
| sender_inn | ИНН организации-отправителя, предоставляющей услугу (для ФОИВ – центральный аппарат) | + | 0000000000 |
| service_target_code | Идентификатор цели обращения услуги в ФРГУ/КЦР | + | |
| user_selected_region | Местоположение заявителя по ОКТМО (Допустимо указание до уровня региона. В случае подачи заявления в электронном виде указывать 00000000) | + | |
| order_number | Номер заявления пользователя во внешней ИС | + | |
| request_date | Дата и время подачи заявления | + | 2001-12-17T09:30:47Z |
| office_info | Информация о канале приема заявления | + | Составной элемент OfficeInfo |
| status_history | История статусов по заявлению | + | Массив (1-unbounded) составных элементов HistoricalStatus |
1 - обязательно должен присутствовать один из элементов
Структура элемента User
Данные заявителя (ФЛ)
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| user_personal_doc | Данные заявителя с обязательным указанием типа документа, удостоверяющего личность | -1 | Составной элемент UserPersonalDoc |
| user_doc_snils | Данные заявителя с обязательным указанием СНИЛС | -1 | Составной элемент UserDocSnils |
| user_doc_snils_birth_date | Данные заявителя с обязательным указанием СНИЛС и даты рождения | -1 | Составной элемент UserDocSnilsBirthDate |
| user_doc_inn | Данные заявителя с обязательным указанием ИНН | -1 | Составной элемент UserDocInn |
| esia_id | Данные заявителя с обязательным указанием идентификатора заявителя в ЕСИА (ФЛ) | -1 | |
| ern_id | Данные заявителя с обязательным указанием ЕРН ID | -1 |
1 - обязательно должен присутствовать один из элементов
Структура элемента UserPersonalDoc
Данные заявителя с обязательным указанием типа документа, удостоверяющего личность
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| personal_doc_type | Тип документа удостоверяющего личность | + | 4096 |
| series | Серия | - | |
| number | Номер | + | |
| surname | Фамилия | + | Иванов |
| name | Имя | + | Иван |
| patronymic | Отчество | - | Иванович |
| citizenship | Гражданство | + | 4096 |
Структура элемента UserDocSnils
Данные заявителя с обязательным указанием СНИЛС
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| snils | СНИЛС | + | |
| surname | Фамилия | + | Иванов |
| name | Имя | + | Иван |
| patronymic | Отчество | - | Иванович |
| citizenship | Гражданство | + | 4096 |
Структура элемента UserDocSnilsBirthDate
Данные заявителя с обязательным указанием СНИЛС и даты рождения
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| citizenship | Гражданство | + | 4096 |
| snils | СНИЛС | + | |
| birth_date | Дата рождения | + |
Структура элемента UserDocInn
Данные заявителя с обязательным указанием ИНН
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| inn | ИНН | + | |
| surname | Фамилия | + | Иванов |
| name | Имя | + | Иван |
| patronymic | Отчество | - | Иванович |
| citizenship | Гражданство | + | 4096 |
Структура элемента Organization
Данные заявителя (ЮЛ/ИП)
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| ogrn_inn_ul | Пара ОГРН ИНН КПП ЮЛ | -1 | Составной элемент OgrnInnUL |
| ogrn_inn_ip | Пара ОГРН ИНН ИП | -1 | Составной элемент OgrnInnIP |
1 - обязательно должен присутствовать один из элементов
Структура элемента OgrnInnUL
Пара ОГРН ИНН КПП ЮЛ
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| ogrn | ОГРН | -1 | |
| inn_kpp | ИНН КПП | -1 | Составной элемент InnKpp |
| ul_title | Наименование юридического лица | - |
1 - обязательно должен присутствовать один из элементов
Структура элемента InnKpp
ИНН КПП
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| inn | ИНН | + | |
| kpp | КПП | - |
Структура элемента OgrnInnIP
Пара ОГРН ИНН ИП
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| ogrn | ОГРН ИП | + | |
| inn | ИНН | + | |
| surname | Фамилия | - | Иванов |
| name | Имя | - | Иван |
| patronymic | Отчество | - | Иванович |
Структура элемента OfficeInfo
Информация о канале приема заявления
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| office_name | Наименование офиса, где было подано заявление | - | 4096 |
| office_address | Адрес офиса, где было подано заявление. В случае приема через электронные каналы, указывается соответствующее описание канала, например, адрес сайта, через который принято заявление | - | |
| office_frgu_code | ФРГУ код офиса | - | |
| application_acceptance | Канал приема заявления | + |
Структура элемента HistoricalStatus
Статус по заявлению
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| status | Код статуса из справочника ЕПГУ | + | 4096 |
| is_informed | Уже проинформирован | - | true |
| status_date | Дата и время статуса | + | 2001-12-17T09:30:47Z |
| message_type | Мнемоника шаблона комментария к статусу оказания услуги (Заполняется из ЕСНСИ-справочника ЕЛК.Шаблоны уведомлений) | - | |
| params | Массив атрибутов результатов предоставления услуги | - | Массив (0-unbounded) составных элементов Param |
| attachments | Ссылки на передаваемые файлы | - | Массив (0-unbounded) составных элементов Attachment |
Структура элемента Param
Атрибут результата предоставления услуги
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| name | Наименование атрибута шаблона комментария | + | |
| value | Значение атрибута шаблона комментария | + |
Структура элемента Attachment
Ссылка на передаваемый файл
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| uuid | Идентификатор файла в хранилище сервиса filator | + | 4833e4c4385dc47f2d2a08469f246e7cd1f66f416691d0b5a92a00d722f8d4ec |
| doc_type_id | Код типа электронного дубликата документа, передаваемого через файловое хранилище. Заполняется из ЕСНСИ-справочника ЕЛК.Типы документов (вложений) | + |
Структура элемента UpdateOrder
Обновление заявления
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| order_number | Номер заявления пользователя во внешней ИС | -1 | |
| elk_order_number | Номер заявления в ЛК ЕПГУ | -1 | |
| sender_kpp | КПП организации, оказывающей услугу | - | |
| sender_inn | ИНН организации, оказывающей услугу | + | |
| status_history | История статусов по заявлению | + | Массив (1-unbounded) составных элементов HistoricalStatus |
1 - обязательно должен присутствовать один из элементов
Параметры ответа
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| create_orders_response | Ответ на создание заявлений | -1 | Составной элемент CreateOrdersResponse |
| update_orders_response | Ответ на изменение заявлений | -1 | Составной элемент UpdateOrdersResponse |
1 - обязательно должен присутствовать один из элементов
Структура элемента CreateOrdersResponse
Ответ на создание заявлений
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| code | Код результата | + | 4096 |
| message | Описание результата | + | |
| orders | Заявления | + | Массив (1-unbounded) составных элементов CreateOrderResponse |
Структура элемента UpdateOrdersResponse
Ответ на изменение заявлений
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| code | Код результата | + | 4096 |
| message | Описание результата | + | |
| orders | Заявления | + | Массив (1-unbounded) составных элементов UpdateOrderResponse |
Структура элемента CreateOrderResponse
Ответ на создание заявления
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| elk_order_number | Номер заявления в ЛК ЕПГУ | - | |
| order_number | Номер заявления пользователя во внешней ИС | + | |
| status | Код результата | + | 4096 |
| message | Описание результата | + |
Структура элемента UpdateOrderResponse
Ответ на обновление заявления
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| elk_order_number | Номер заявления в ЛК ЕПГУ | + | |
| order_number | Номер заявления пользователя во внешней ИС | - | |
| status | Код результата | + | 4096 |
| message | Описание результата | + |
Примеры
особенности эксплуатации
Параметр uuid в тестовых запросах — это значение "uuid" из ответа сервиса filator при загрузке в него файлов для подписания. Подробности загрузки файлов.
Тестовый сценарий 1. Создание заявления.
Запрос:
{
"env": "a",
"create_orders": [
{
"user": {
"user_personal_doc": {
"personal_doc_type": 4096,
"series": "a",
"number": "a",
"surname": "a",
"name": "a",
"patronymic": "a",
"citizenship": 4096
}
},
"sender_kpp": "000000000",
"sender_inn": "0000000000",
"service_target_code": "a",
"user_selected_region": "0",
"order_number": "a",
"request_date": "2001-12-17T09:30:47Z",
"office_info": {
"office_name": "a",
"office_address": "a",
"office_frgu_code": "a",
"application_acceptance": "4096"
},
"status_history": [
{
"status": "4096",
"is_informed": true,
"status_date": "2001-12-17T09:30:47Z",
"message_type": "a",
"params": [
{
"name": "a",
"value": "String"
}
],
"attachments": [
{
"uuid": "b8db842e8b72a60d4c4059326445359872b3bfe32accb57e9a2929bdf6c878f5",
"doc_type_id": "a"
}
]
}
]
}
]
}
Ответ:
{
"create_orders_response": {
"code": "4096",
"message": "a",
"orders": [
{
"elk_order_number": "0",
"order_number": "a",
"status": "4096",
"message": "a"
}
]
}
}
Тестовый сценарий 2. Изменение заявления.
Запрос:
{
"env": "a",
"update_orders": [
{
"order_number": "a",
"sender_kpp": "000000000",
"sender_inn": "0000000000",
"status_history": [
{
"status": "4096",
"is_informed": true,
"status_date": "2001-12-17T09:30:47Z",
"message_type": "a",
"params": [
{
"name": "a",
"value": "String"
}
],
"attachments": [
{
"uuid": "b8db842e8b72a60d4c4059326445359872b3bfe32accb57e9a2929bdf6c878f5",
"doc_type_id": "a"
}
]
}
]
}
]
}
Ответ:
{
"update_orders_response": {
"code": "4096",
"message": "a",
"orders": [
{
"elk_order_number": "0",
"order_number": "a",
"status": "4096",
"message": "a"
}
]
}
}