ФРГУ

Описание команд всех сервисов, которые входят в состав ФРГУ.

ardos-access-adapter: сервис для работы с правами ардоса

Сервис является адаптером для ardos, а также реализует всю логику oberto. Команды могут приходить как по HTTP.

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура, сервис настроен аналогично oberto.

Запуск из консоли с помощью SBT

ARDOS_ACCESS_ADAPTER_SZI_URL=localhost:8090 ARDOS_ACCESS_ADAPTER_SZI_ADMINUSERNAME=user ARDOS_ACCESS_ADAPTER_SZI_ADMINPASSWORD=password sbt boot/run

Список переменных окружения сервиса ardos-access-adapter

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса ardos-access-adapter

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, ARDOS_ACCESS_ADAPTER_LOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• ARDOS_ACCESS_ADAPTER_LOGGING_SRC_IP, для параметра src в логах
• ARDOS_ACCESS_ADAPTER_LOGGING_SRC_HOST, для параметра shost в логах
• ARDOS_ACCESS_ADAPTER_LOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Маппинг групп

Переменная ARDOS_ACCESS_ADAPTER_GROUP_MAPPING отвечает за соответствие групп в ардос к группам в нашей системе.

Пример значения переменной:

CLERK=clerk;TECHNICALSUPPORT=technicalSupport;DEFAULT=default;SUBJECTMETHODOLOGIST=subjectMethodologist;COORDINATOR=coordinator;METHODOLOGISTADMIN=methodologistAdmin;DEVELOPER=developer

Список команд сервиса ardos-access-adapter

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованы команды:

• Миграция прав в Ардос

MigrateOperations

Мигрирует указанные права в Ардос.

• Input: MigrateOperationDTO[]
• Output: {}

Объекты сервиса

MigrateOperationDTO

Ardos Auth Adapter: сервис пользователей (адаптер ardos)

Сервис принимает запросы для работы с игроками и командами. Состояние хранится в PostgreSQL. Команды могут приходить как по HTTP, так и через Kafka в топик ARDOS_AUTH_ADAPTERcommands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Информацию по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/ardosAuthAdapter_db
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • ARDOS_AUTH_ADAPTERDB_HOST
  • ARDOS_AUTH_ADAPTERDB_PORT
  • ARDOS_AUTH_ADAPTERDB_NAME
  • ARDOS_AUTH_ADAPTERDB_USER
  • ARDOS_AUTH_ADAPTERDB_PASSWORD

Запуск из консоли с помощью SBT

ARDOS_AUTH_ADAPTERDB_HOST=localhost ARDOS_AUTH_ADAPTERDB_PORT=5432 ARDOS_AUTH_ADAPTERDB_NAME=ardosAuthAdapter ARDOS_AUTH_ADAPTERDB_USER=postgres ARDOS_AUTH_ADAPTERDB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса Ardos Auth Adapter

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса Ardos Auth Adapter

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, ARDOS_AUTH_ADAPTERLOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• ARDOS_AUTH_ADAPTERLOGGING_SRC_IP, для параметра src в логах
• ARDOS_AUTH_ADAPTERLOGGING_SRC_HOST, для параметра shost в логах
• ARDOS_AUTH_ADAPTERLOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Список команд сервиса Ardos Auth Adapter

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованно 2 команды:

• Получение ссылки аутентификации ЕСИА
• Проверка входа
• Выход

ArdosAuthUrl

Получение ссылки на аутентификацию в ЕСИА.

• Input: Пустое тело запроса
• Output: String (url для аутентификации)

CheckAuth

Проверяет аутентификация и выставляет cookie. Синхронизирует пользователя с ardos.

• Input: CheckAuthDTO
• Output: Пустое тело ответа (Выставляет cookie at)

Logout

Получение ссылки на выход из ЕСИА.

• Input: Пустое тело запроса
• Output: String (url для выхода)

Объекты сервиса Ardos Auth Adapter

CheckAuthDTO

Datamart Adapter: Сервис синхронизации данных в витрину НСУД

Сервис читает топики entityObjectEvent и catalogEvents и следуя маппингу загружает данные через prostore jdcbdriver в витрину данных.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/datamartAdapter_db
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • DATAMART_ADAPTER_DB_HOST
  • DATAMART_ADAPTER_DB_PORT
  • DATAMART_ADAPTER_DB_NAME
  • DATAMART_ADAPTER_DB_USER
  • DATAMART_ADAPTER_DB_PASSWORD

Запуск из консоли с помощью SBT

DATAMART_ADAPTER_DB_HOST=localhost DATAMART_ADAPTER_DB_PORT=5432 DATAMART_ADAPTER_DB_NAME=datamartAdapter_db DATAMART_ADAPTER_DB_USER=postgres DATAMART_ADAPTER_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса Datamart Adapter

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса Datamart Adapter

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, DATAMART_ADAPTER_LOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• DATAMART_ADAPTER_LOGGING_SRC_IP, для параметра src в логах
• DATAMART_ADAPTER_LOGGING_SRC_HOST, для параметра shost в логах
• DATAMART_ADAPTER_LOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Список команд сервиса Datamart Adapter

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованно 1 команда:

• Добавление маппинга

ImportMappings

Обновляет маппинг сущностей.

• Input: ListDataMartMapping
• Output: Пустое тело ответа

Сущности сервиса Datamart Adapter

DataMartMapping

DataMartFieldMapping

FRGU Migrator

Сервис принимает команды и хранит состояние в PostgreSQL. Команды могут приходить как по HTTP, так и через Kafka в топик frgu_migrator_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• [domain] в котором содержатся все доменные модели и их различные представления.
• [commands] в котором содержатся всё, что связано с командами, их описанием и обработчиками.
• [storage] содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• [service] содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• [boot] содержит зависимости и описание для сборки и запуска сервиса.

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу ${FRGU_MIGRATOR_DB_HOST}:${FRGU_MIGRATOR_DB_PORT}/${FRGU_MIGRATOR_DB_NAME} (по умолчанию localhost:5432/frgu-migrator)
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • FRGU_MIGRATOR_DB_HOST
  • FRGU_MIGRATOR_DB_PORT
  • FRGU_MIGRATOR_DB_NAME
  • FRGU_MIGRATOR_DB_USER
  • FRGU_MIGRATOR_DB_PASSWORD
  • FRGU_MIGRATOR_FRGU1_DB_HOST
  • FRGU_MIGRATOR_FRGU1_DB_PORT
  • FRGU_MIGRATOR_FRGU1_DB_NAME
  • FRGU_MIGRATOR_FRGU1_DB_USER
  • FRGU_MIGRATOR_FRGU1_DB_PASSWORD

Запуск из консоли с помощью SBT

FRGU_MIGRATOR_DB_HOST=localhost FRGU_MIGRATOR_DB_PORT=5432 FRGU_MIGRATOR_DB_NAME=frgu-migrator FRGU_MIGRATOR_DB_USER=postgres FRGU_MIGRATOR_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса FRGU Migrator

Все доступные переменные окружения для настройки сервиса.

Доступные миграции

ФРГУ 1.0

Для фргу 1.0 код миграции = коду соответствующего региона (Federal для федеральных)

Поле params должно быть равно null

ФРГУ 2.0

Для фргу 2.0 пока что доступна только миграция ГУ - MunicipalServiceCard

Поле params - массив id услуг в фргу 2.0:

[
  304821,
  303027,
  303458
]

Список команд сервиса FRGU Migrator

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованы следующие команды:

-Запуск миграций регионов -Поиск InternalId для миграции -Откат миграций регионов -Список миграций

StartMigrations

На входе список id миграций с опциональными входными параметрами

[
  {
    "code": "MunicipalServiceCard",
    "params": [
      304821,
      303027,
      303458
    ]
  },
  {
    "code": "DagestanRepublic"
  }
]

На выходе - пустое тело ответа

Миграции ставятся в очередь на запуск в том порядке, в котором были переданы в теле. Информация по миграциям в разделе "Доступные миграции"

При аварийном отключении frgu-migrator миграции в очереди помечаются статусом Failed

Имеет общую очередь с командой отката.

• Input: MigrationInput[]
• Output: None

GetInternalIdForMigration

На входе список entityId и classCode миграций

{
  "entityId": "101101",
  "classCode": "MunicipalServiceCard"
}

На выходе - internalId c описанием

{
  "status": "Completed",
  "timestamp": 1725017650609,
  "value": {
    "internalId": null,
    "status": "error",
    "error": "MigrationItem with entityId 291939 and classCode ServiceRequest not found"
  }
}

{
  "status": "Completed",
  "timestamp": 1725017736488,
  "value": {
    "internalId": "000020bd-c188-4d0b-871e-d3a39f7f2fa2",
    "status": "success",
    "error": null
  }
}

• Input: MigrationInput[]
• Output: String

SearchFrguId2ForMigration

На входе список предпологаемый frguId2

   101101

На выходе - Boolean true если можно мигрировать /false если нельзя мигрировать(нет в базе)

{
  "status": "Completed",
  "timestamp": 1725367497937,
  "value": true
}

• Input: [Int]
• Output: Boolean

RollbackMigrations

На входе список id миграций для отката миграции

[
  "DagestanRepublic",
  "Federal"
]

На выходе - пустое тело ответа

Запуск отката миграций.

При аварийном отключении frgu-migrator миграции в очереди помечаются статусом RollbackFailed

Имеет общую очередь с командой старта.

• Input: Seq[String] список регионов
• Output: None

ListMigrations

На входе параметры поиска, сортировки и пагинации (Search)

{
  "query": "title",
  "context": {
    "title": "like %Республика%"
  },
  "sorting": {
    "fieldName": "source",
    "order": "desc"
  },
  "paging": {
    "page": 1,
    "count": 5
  }
}

На выходе список миграций и их общее количество

{
  "items": [
    {
      "code": "DagestanRepublic",
      "title": "Республика Дагестан",
      "source": "FRGU1",
      "lastModified": 1711441100746,
      "status": "Finished",
      "author": "46abb0ac-f867-4041-9948-90361b6283e1",
      "processedStages": []
    }
  ],
  "total": 1
}

Получение списка миграций с поиском, сортировкой и пагинацией.

• Input: Search
• Output: Page[Migration]

Объекты сервиса FRGU Migrator

Migration

MigrationInput

MigrationStatus

Существует 8 статусов миграции

• Queued - миграция добавлена в очередь на исполнение
• InProcess - миграция в процессе исполнения
• Finished - миграция завершена
• Failed - ошибка (повторный запуск миграции с этим статусом продолжит её выполнение, а не начнёт заново)
• RollbackQueued - миграция добавлена в очередь на откат
• RollbackInProcess - миграция в процессе отката
• RollbackFinished - откат миграции завершена
• RollbackFailed - ошибка отката (повторный откат миграции с этим статусом продолжит её откат, а не начнёт заново)

Mon Szi: сервис для примера

Сервис принимает запросы для работы с игроками и командами. Состояние хранится в PostgreSQL. Команды могут приходить как по HTTP, так и через Kafka в топик mon_szi_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Информацию по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/monSzi_db
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • MON_SZI_DB_HOST
  • MON_SZI_DB_PORT
  • MON_SZI_DB_NAME
  • MON_SZI_DB_USER
  • MON_SZI_DB_PASSWORD

Запуск из консоли с помощью SBT

MON_SZI_DB_HOST=localhost MON_SZI_DB_PORT=5432 MON_SZI_DB_NAME=monSzi_db MON_SZI_DB_USER=postgres MON_SZI_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса Mon Szi

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса Mon Szi

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, MON_SZI_LOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• MON_SZI_LOGGING_SRC_IP, для параметра src в логах
• MON_SZI_LOGGING_SRC_HOST, для параметра shost в логах
• MON_SZI_LOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Список команд сервиса Mon Szi

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованно 2 команды:

• Список всех игроков
• Добавление нового игрока

CheckAuth

Проверяет аутентификация и выставляет cookie. Также обновляет атрибуты пользователя сессионными атрибутами из ЕСИА.

• Input: String
• Output: Пустое тело ответа (Выставляет cookie szi-token)

ConfirmOgrn

Принудительно обновляет атрибуты пользователя на новый огрн.

• Input: String
• Output: Пустое тело ответа

Sed Profiling: Сервис профилирования

Сервис для профилирования подуслуг. В ключевой функционал сервиса входит:

• Создание вопросов и ответов к подуслуге.
• Генерирование вариантов предоставления подуслуги.

Состояние хранится в PostgreSQL. Команды могут приходить как по HTTP, так и через Kafka в топик sed_profiling_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain в котором содержатся все доменные модели и их различные представления.
• commands в котором содержатся все, что связано с командами, их описанием и обработчиками.
• storage содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot содержит зависимости и описание для сборки и запуска сервиса.

Информацию по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/sedProfiling_db
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • SED_PROFILING_DB_HOST
  • SED_PROFILING_DB_PORT
  • SED_PROFILING_DB_NAME
  • SED_PROFILING_DB_USER
  • SED_PROFILING_DB_PASSWORD

Запуск из консоли с помощью SBT

SED_PROFILING_DB_HOST=localhost SED_PROFILING_DB_PORT=5432 SED_PROFILING_DB_NAME=sedProfiling_db SED_PROFILING_DB_USER=postgres SED_PROFILING_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса Sed Profiling

Все доступные переменные окружения для настройки сервиса.

Формат CEF для логов сервиса Sed Profiling

У логов есть возможность включить формат CEF для логирования по следующему шаблону:
2022-12-14T16:56:31+0500 CEF:Version|Device Vendor|Device Product|Device Version|EventClassId|Message|Severity|src=? dst=? shost=? suid=? suser=? msg=? end=currentTimeMillis|.

Чтобы включить логирование в формате CEF, нужно задать значение переменной с постфиксом CEF. Например, SED_PROFILING_LOG_OUTPUT = STDOUT_CEF. Если логи пишутся в формате CEF, то желательно поменять следующие переменные:

• SED_PROFILING_LOGGING_SRC_IP, для параметра src в логах
• SED_PROFILING_LOGGING_SRC_HOST, для параметра shost в логах
• SED_PROFILING_LOGGING_DST_IP, для параметра dst в логах

В файле src/main/resources/logback.xml можно поменять class path для основного класса приложения (переменная projectMainClassPath), если это необходимо.

Список команд сервиса Sed Profiling

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованно данные команды:

• Создание обычного вопроса
• Создание корневого вопроса
• Удаление обычного вопроса
• Получение списка вопросов и ответов к подуслуге
• Получение вопроса

• Обновление обычного вопроса

• Создание ответа

• Удаление ответа

• Привязка ответа к следующему вопросу

• Удаление привязки ответа к следующему вопроса

• Обновление ответа

• Получение ответа

• Получение вопросов для привязки

• Получение списка вариантов предоставления к подуслуге

• Получение варианта предоставления

• Обновление варианта предоставления

• Подсчёт вариантов предоставления для подуслуги

• Копирование данных для новой версии услуги

CreateQuestion

На входе атрибуты для создания нового обычного вопроса

{
  "subServiceId": "00000000-0000-0000-0000-000000000000",
  "text": "Обычный вопрос",
  "isActive": true
}

На выходе созданный вопрос

{
  "id": "bad94be9-da4b-40c9-acdd-7fbcdef3554f",
  "subServiceId": "00000000-0000-0000-0000-000000000001",
  "referenceQuestionId": null,
  "text": "Обычный вопрос",
  "isActive": true,
  "isRoot": false,
  "created": 1719818627138,
  "createdBy": "23607e42-a9e1-4530-b7e1-a60298cd9b8e",
  "modified": 1719818627138,
  "modifiedBy": "23607e42-a9e1-4530-b7e1-a60298cd9b8e",
  "removed": false,
  "version": 1
}

Создаёт новый обычный вопрос. Невозможно создание обычного вопроса без имеющегося корневого вопроса к данной подуслуге.

• Input: QuestionCreateDTO
• Output: Question

CreateRootQuestion

На входе RootQuestionCreateDTO subServiceEntityType равен SubService для обычного запроса или SubServiceTemplate для запроса шаблона

{
  "subServiceId": "0531f290-f575-44f6-b133-597199da6705",
  "subServiceEntityType": "SubService"
}

На выходе созданный вопрос и ответы

{
  "id": "920a7fab-2de5-43c7-90fe-2aeedcc6d59b",
  "subServiceId": "00000000-0000-0000-0000-000000000000",
  "subServiceEntityType": "SubService",
  "referenceQuestion": {
    "id": "ApplicantCategory",
    "text": "Категория заявителя"
  },
  "text": null,
  "isActive": true,
  "isRoot": true,
  "answers": [
    {
      "id": "01e4f92a-bc46-4c97-91c2-6c38be6b3295",
      "questionId": "442030cd-f591-460f-b828-1a766334bb08",
      "nextQuestionId": null,
      "referenceAnswerId": "PhysicalEntity",
      "text": null,
      "isActive": true,
      "isPaid": false,
      "proactiveMode": false,
      "isAdvanceRequest": null,
      "proactiveModeReason": null,
      "informationSystemIn": null,
      "informationSystemOut": null,
      "documentIds": [],
      "interdepartmentalInteractionIds": [],
      "data": {},
      "created": 1721286226543,
      "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
      "modified": 1721286226543,
      "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
      "removed": false,
      "version": 1
    }
  ],
  "created": 1721029829664,
  "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "modified": 1721029829664,
  "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "removed": false,
  "version": 1
}

Создаёт новый корневой вопрос, который всегда является активным.

• Input: RootQuestionCreateDTO
• Output: QuestionWithAnswers

DeleteQuestion

На входе ID вопроса

"bad94be9-da4b-40c9-acdd-7fbcdef3554f"

На выходе пустое тело ответа

Удаляет обычный вопрос, также удаляет и все ответы на него и привязки.

• Input: QuestionId
• Output: Пустое тело ответа

ListQuestions

На входе ID подуслуги и признак showInactive, отвечающий за вывод в ответ неактивных вопросов и ответов

{
  "subServiceId": "00000000-0000-0000-0000-000000000000",
  "showInactive": true
}

На выходе список вопросов с ответами

[
  {
    "id": "442030cd-f591-460f-b828-1a766334bb08",
    "subServiceId": "1aa1a00d-f8d2-4645-997a-f8e8c0e1ad93",
    "subServiceEntityType": "SubService",
    "referenceQuestionId": "ApplicantCategory",
    "text": null,
    "isActive": true,
    "isRoot": true,
    "answers": [
      {
        "id": "01e4f92a-bc46-4c97-91c2-6c38be6b3295",
        "questionId": "442030cd-f591-460f-b828-1a766334bb08",
        "nextQuestionId": null,
        "referenceAnswerId": "PhysicalEntity",
        "text": null,
        "isActive": true,
        "isPaid": false,
        "proactiveMode": false,
        "isAdvanceRequest": null,
        "proactiveModeReason": null,
        "informationSystemIn": null,
        "informationSystemOut": null,
        "documentIds": [],
        "interdepartmentalInteractionIds": [
          "2ebb9ce9-fca5-4fb4-ba19-360e8a60f219",
          "52493156-5fc8-43fa-96db-9b73a9da3aef",
          "4bdfcb67-f0a0-45b4-8fd9-71caf9456787"
        ],
        "data": {},
        "created": 1721286226543,
        "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
        "modified": 1721286226543,
        "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
        "removed": false,
        "version": 1
      },
      {
        "id": "52e5eb3c-da63-4c14-b5a2-44ef3df8df0b",
        "questionId": "442030cd-f591-460f-b828-1a766334bb08",
        "nextQuestionId": null,
        "referenceAnswerId": "LegalEntity",
        "text": null,
        "isActive": true,
        "isPaid": false,
        "proactiveMode": false,
        "isAdvanceRequest": null,
        "proactiveModeReason": null,
        "informationSystemIn": null,
        "informationSystemOut": null,
        "documentIds": [
          "9e5d800f-98ef-4bf5-a795-320302be4e98",
          "bdc0bd5b-10c8-4665-9673-0c6e9f167d00"
        ],
        "interdepartmentalInteractionIds": [],
        "data": {},
        "created": 1721286226544,
        "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
        "modified": 1721286226544,
        "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
        "removed": false,
        "version": 1
      }
    ],
    "created": 1721286226446,
    "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
    "modified": 1721286226446,
    "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
    "removed": false,
    "version": 1
  }
]

Возвращает вопросы и ответы для подуслуги.

• Input: ListQuestionDTO
• Output: ListQuestionWithAnswers

GetQuestion

На входе ID вопроса

"bad94be9-da4b-40c9-acdd-7fbcdef3554f"

На выходе Question

{
  "id": "d29b24c0-94dc-43c2-9993-0266417d5b68",
  "subServiceId": "1aa1a00d-f8d2-4645-997a-f8e8c0e1ad93",
  "subServiceEntityType": "SubService",
  "referenceQuestion": null,
  "text": "text",
  "isActive": true,
  "isRoot": false,
  "created": 1721286404536,
  "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "modified": 1721286404536,
  "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "removed": false,
  "version": 1
}

• Input: QuestionId
• Output: Question

UpdateQuestion

На входе атрибуты для обновления обычного вопроса

{
  "id": "67908c9a-8f60-4406-86b2-884465af8f1f",
  "version": 1,
  "text": "текст",
  "isActive": true
}

На выходе пустое тело ответа

Обновляет обычный вопрос.

• Input: QuestionUpdateDTO
• Output: Пустое тело ответа

CreateAnswer

На входе атрибуты для создания нового ответа и связанных сущностей

{
  "questionId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
  "referenceAnswerId": null,
  "text": "Текст",
  "isActive": true,
  "isPaid": true,
  "proactiveMode": true,
  "isAdvanceRequest": false,
  "proactiveModeReason": "Причина",
  "informationSystemIn": "in",
  "informationSystemOut": "out",
  "data": {},
  "documentsCreate": [
    {
      "order": 0,
      "documentCategory": "DocumentCategory_2",
      "document": "Document_1",
      "isMandatory": true,
      "approvedByRegulations": true,
      "submissionMethodsCreate": [
        {
          "submissionMethod": "SubmissionMethod_1",
          "documentRequirements": "requirements"
        }
      ]
    }
  ],
  "interdepartmentalInteractionCreate": [
    {
      "order": 1,
      "interactionType": "InteractionType_1",
      "supplierId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
      "serviceTitle": "Title",
      "typeInformationTitle": "TypeInformation",
      "dataMartTitle": "Data",
      "interdepartmentalRequestTitle": "request",
      "deadlineRequestUnit": "Days",
      "deadlineRequestAmount": 20,
      "responseTimeUnit": null,
      "responseTimeAmount": null
    },
    {
      "order": 1,
      "interactionType": "InteractionType_1",
      "supplierId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
      "serviceTitle": "Title",
      "typeInformationTitle": "TypeInformation",
      "dataMartTitle": "Data",
      "interdepartmentalRequestTitle": "request",
      "deadlineRequestUnit": "Days",
      "deadlineRequestAmount": 20,
      "responseTimeUnit": null,
      "responseTimeAmount": null
    }
  ],
  "paymentsCreate": [
    {
      "fee": 200,
      "feeType": "FeeType",
      "isFreeForm": false,
      "feeMethod": []
    }
  ]
}

На выходе созданный ответ

{
  "id": "566e44c5-9915-4a90-ace5-f0573aa83566",
  "questionId": "b9d65e3b-ccf3-4d1e-aa5c-8c0e0784a1bc",
  "nextQuestionId": null,
  "referenceAnswerId": null,
  "text": "Текст",
  "isActive": true,
  "isPaid": true,
  "proactiveMode": true,
  "isAdvanceRequest": false,
  "proactiveModeReason": "Причина",
  "informationSystemIn": "in",
  "informationSystemOut": "out",
  "data": {},
  "created": 1721301475314,
  "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "modified": 1721301475314,
  "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "removed": false,
  "version": 1
}

Создаёт новый ответ.

• Input: AnswerCreateDTO
• Output: Answer

DeleteAnswer

На входе ID ответа

"bad94be9-da4b-40c9-acdd-7fbcdef3554f"

На выходе пустое тело ответа

Удаляет ответ.

• Input: AnswerId
• Output: Пустое тело ответа

LinkAnswer

На входе ID ответа, вопроса и версия

{
  "answerId": "7a01be36-7057-46dc-86c4-99693e05dc80",
  "version": 3,
  "nextQuestionId": "b9d65e3b-ccf3-4d1e-aa5c-8c0e0784a1bc"
}

На выходе пустое тело ответа

Привязывает следующий вопрос к ответу.

• Input: LinkAnswerDTO
• Output: Пустое тело ответа

UnlinkAnswer

На входе ID ответа и версия

{
  "answerId": "7a01be36-7057-46dc-86c4-99693e05dc80",
  "version": 3
}

На выходе пустое тело ответа

Удаляет привязку ответа к следующему вопросу.

• Input: UninkAnswerDTO
• Output: Пустое тело ответа

UpdateAnswer

На входе атрибуты для обновления ответа и связанных сущностей

{
  "id": "566e44c5-9915-4a90-ace5-f0573aa83566",
  "version": 1,
  "questionId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
  "nextQuestionId": null,
  "referenceAnswerId": null,
  "text": "text",
  "isActive": true,
  "isPaid": true,
  "proactiveMode": true,
  "isAdvanceRequest": false,
  "proactiveModeReason": null,
  "informationSystemIn": "in",
  "informationSystemOut": null,
  "data": {
    "ah": "oh"
  },
  "interdepartmentalInteractionCreate": [
    {
      "order": 1,
      "interactionType": "InteractionType_1",
      "supplierId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
      "serviceTitle": "Title",
      "typeInformationTitle": "TypeInformation",
      "dataMartTitle": "Data",
      "interdepartmentalRequestTitle": "request",
      "deadlineRequestUnit": "Days",
      "deadlineRequestAmount": 20,
      "responseTimeUnit": null,
      "responseTimeAmount": null
    },
    {
      "order": 1,
      "interactionType": "InteractionType_1",
      "supplierId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
      "serviceTitle": "Title",
      "typeInformationTitle": "TypeInformation",
      "dataMartTitle": "Data",
      "interdepartmentalRequestTitle": "request",
      "deadlineRequestUnit": "Days",
      "deadlineRequestAmount": 20,
      "responseTimeUnit": null,
      "responseTimeAmount": null
    }
  ],
  "interdepartmentalInteractionDelete": [
    "8e13aa53-da0c-4b6f-8d04-717ae7fb68ee"
  ],
  "documentsCreate": [
    {
      "order": 0,
      "documentCategory": "DocumentCategory_2",
      "document": "Document_1",
      "isMandatory": true,
      "approvedByRegulations": true,
      "submissionMethodsCreate": [
        {
          "submissionMethod": "SubmissionMethod_1",
          "documentRequirements": "requirements"
        }
      ]
    }
  ],
  "paymentsCreate": [
    {
      "fee": 200,
      "feeType": "feeType",
      "receivingFeeProcedure": "feeProcedure",
      "feeMethod": [],
      "isFreeForm": false
    }
  ]
}

На выходе пустое тело ответа

Обновляет ответ.

• Input: AnswerUpdateDTO
• Output: Пустое тело ответа

GetAnswer

На входе ID ответа

"bad94be9-da4b-40c9-acdd-7fbcdef3554f"

На выходе Answer

{
  "id": "566e44c5-9915-4a90-ace5-f0573aa83566",
  "questionId": "d29b24c0-94dc-43c2-9993-0266417d5b68",
  "nextQuestionId": null,
  "referenceAnswerId": null,
  "text": "text",
  "isActive": true,
  "isPaid": true,
  "proactiveMode": true,
  "isAdvanceRequest": false,
  "proactiveModeReason": null,
  "informationSystemIn": "in",
  "informationSystemOut": null,
  "documentIds": [
    "69968b22-6179-4d6e-9459-6f1225debb4b",
    "5bb8431b-8177-4565-ba98-7c619a9d40ba"
  ],
  "interdepartmentalInteractionIds": [
    "2ebb9ce9-fca5-4fb4-ba19-360e8a60f219",
    "52493156-5fc8-43fa-96db-9b73a9da3aef",
    "4bdfcb67-f0a0-45b4-8fd9-71caf9456787"
  ],
  "paymentIds": [
    "2ebb9ce9-fca5-4fb4-ba19-360e8a60f219",
    "52493156-5fc8-43fa-96db-9b73a9da3aef",
    "4bdfcb67-f0a0-45b4-8fd9-71caf9456787"
  ],
  "data": {
    "ah": "oh"
  },
  "created": 1721301475314,
  "createdBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "modified": 1721301738146,
  "modifiedBy": "f48ec977-609a-4d8e-a57b-70cc84b22da9",
  "removed": false,
  "version": 2
}

• Input: AnswerId
• Output: Answer

ListAvailableQuestionsForLinkage

На входе ID ответа

"bad94be9-da4b-40c9-acdd-7fbcdef3554f"

На выходе список ID вопросов с которыми можно связать ответ

[
  "2ebb9ce9-fca5-4fb4-ba19-360e8a60f219",
  "52493156-5fc8-43fa-96db-9b73a9da3aef",
  "4bdfcb67-f0a0-45b4-8fd9-71caf9456787"
]

• Input: AnswerId
• Output: UUID[]

ListProvisionOptions

На входе ID подуслуги

"00000000-0000-0000-0000-000000000002"

На выходе список вариантов предоставления с вопросами в отсортированном порядке

[
  {
    "id": "4217e2f1-fddd-4ee7-a12a-9e435a189809",
    "subServiceId": "60a29175-f23d-477c-b9f5-62a4d3a5bb2d",
    "subServiceEntityType": "SubService",
    "order": 0,
    "title": "Вариант 1",
    "isDraft": true,
    "answerCount": 3,
    "rejectReasons": [
      {
        "id": "6de0dd49-d1d8-4481-83b5-050ce876241e",
        "provisionOptionId": "bd0d1cdd-ff02-4165-8e7c-8941455a10a7",
        "order": 0,
        "rejectionReason": "Причина 1",
        "solutionType": "Решение 1"
      }
    ],
    "suspensionReasons": [
      {
        "id": "69032eff-2dd7-458f-b2e6-ac314da12928",
        "provisionOptionId": "d1c4790e-7052-4a45-80ff-2b1eccfc3dfa",
        "order": 1,
        "suspensionReason": "SuspensionReason_1",
        "maxSuspensionPeriodAmount": 3,
        "maxSuspensionPeriodUnit": "WorkDay",
        "renewalBasis": "basis"
      }
    ],
    "data": {},
    "created": 1721817506668,
    "createdBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "modified": 1721818202594,
    "modifiedBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "removed": false,
    "version": 2
  },
  {
    "id": "4649e8ab-906a-4519-9d50-c925100ccd2d",
    "subServiceId": "60a29175-f23d-477c-b9f5-62a4d3a5bb2d",
    "subServiceEntityType": "SubService",
    "order": 1,
    "title": "Вариант 2",
    "isDraft": true,
    "answerCount": 2,
    "data": null,
    "created": 1721817506666,
    "createdBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "modified": 1721817506666,
    "modifiedBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "removed": false,
    "version": 1
  },
  {
    "id": "bd0d1cdd-ff02-4165-8e7c-8941455a10a7",
    "subServiceId": "60a29175-f23d-477c-b9f5-62a4d3a5bb2d",
    "subServiceEntityType": "SubService",
    "order": 2,
    "title": "Вариант 3",
    "isDraft": true,
    "answerCount": 3,
    "data": {},
    "created": 1721811049826,
    "createdBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "modified": 1721815997533,
    "modifiedBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "removed": false,
    "version": 4
  },
  {
    "id": "6734957e-f6b2-4a32-9774-f85d4d3e3277",
    "subServiceId": "60a29175-f23d-477c-b9f5-62a4d3a5bb2d",
    "subServiceEntityType": "SubService",
    "order": 3,
    "title": "Вариант 4",
    "isDraft": true,
    "answerCount": 4,
    "data": {},
    "created": 1721811049826,
    "createdBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "modified": 1721818376991,
    "modifiedBy": "46abb0ac-f867-4041-9948-90361b6283e1",
    "removed": false,
    "version": 2
  }
]