| Excerpt | |||||
|---|---|---|---|---|---|
|
Table of Contents
Сценарии работы Сотрудника с Заявлениями
1. Сотрудник подает заявление из файла и подписывает его УНЭП
| Tip | ||
|---|---|---|
| ||
Цель - предоставить Предоставить Сотруднику возможность направить заявление, оформленное произвольным образом или по заранее подготовленному файлу. Предусловия
|
API-метод | Примечания | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Сотрудник загружает файл для подачи заявления POST /api/v1/files | После загрузки файла, будет получен идентификатор загруженного файла, данный идентификатор надо передать в методе создания заявления. | ||||||||
2) Сотрудник выбирает кто будет согласовывать заявление | На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий, подробнее о метод | ||||||||
3) Сотрудник подаёт заявление из загруженного файла POST /api/v1/clients/:clientId/applicationGroups | Система сама сконвертирует загруженный файл в pdf/a формат для дальнейшего подписания. В ответе будет получен идентификатор заявления, его можно использовать при завершении процесса для отображения формы заявления | ||||||||
4) Запуск подписания Заявления УНЭП - запрос сообщения с кодом POST /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes | По итогу вызова данного метода требуется отобразить форму ввода кода | ||||||||
5) Завершение подписания Заявления УНЭП - подтверждение кода из сообщения PUT /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes | В данный метод передается код, который направляется в сообщении | ||||||||
6) Получение данных Заявления GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | подписание заявления - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:
| ||||||||
7) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП
| Tip | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Цель - предоставить Предоставить Сотруднику возможность направить заявление, по заранее определённому шаблону, ожидающему заполнения заданных полей. Предусловия
|
API-метод | Примечания | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Получены типы Заявлений GET /api/v1/applicationTypes | Данный метод предоставляет сотруднику список шаблонов, доступных для подачи - необходим, чтобы сотрудник выбрал по какому шаблону будет подано заявление. | ||||||||
2) Сотрудник выбирает кто будет согласовывать заявление | На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий | ||||||||
3) Создание заявления по шаблону POST /api/v1/clients/:clientId/applicationGroups | На основании того, какой был выбран шаблон заявления необходимо заполнить обязательные поля:
Идентификатор файла - не заполняется, т.к. Система сама формирует файл заявления и конвертирует его в pdf/a формат для последующего подписания. | ||||||||
4) Получение данных Заявления GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | После того, как создано заявление, система формирует pdf файл, который можно отобразить для проверки перед подписанием | ||||||||
5) Загрузка файла заявления, сформированного по шаблону GET /api/v1/clients/:clientId/applications/:applicationId/convertedFile | Данный этап не является обязательным, но позволяет Сотруднику увидеть, что получилось по итогу заполнения полей шаблона заявления, если результат устраивает - переход к шагу 5, в случае если результат не устраивает - переход к шагу 2 | ||||||||
6) Запуск подписания Заявления УНЭП - запрос сообщения с кодом POST /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes | По итогу вызова данного метода требуется отобразить форму ввода кода | ||||||||
7) Завершение подписания Заявления УНЭП - подтверждение кода из сообщения PUT /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes | В данный метод передается код, который направляется в сообщении | ||||||||
8) Получение данных Заявления GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | Подписание заявления - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:
| ||||||||
7) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
3. Сотрудник просматривает Заявление
| Tip | ||
|---|---|---|
| ||
Цель - предоставить Предоставить Сотруднику всю информацию по заявлению Предусловия (одно из)
|
API-метод | Примечания | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Сотрудник загружает список заявлений, в соответствии с фильтрами POST /api/v2/clients/:clientId/applicationGroups/getEmployeeRegistry | |||||||||
2) Получение данных Заявления GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | Данный метод возвращает метаданные заявления, но не файл для просмотра | ||||||||
3) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
4. Сотрудник Обрабатывает заявление как Согласующий
| Tip | ||
|---|---|---|
| ||
Цель - предоставить Предоставить ответственному сотруднику возможность принять решение по заявлению:
Предусловия
|
API-метод | Примечания | ||||||||
|---|---|---|---|---|---|---|---|---|---|
1) Сотруднику, который указан согласующим при просмотре заявления, ожидающего согласования необходимо предоставить выбор совершаемого действия:
PUT /api/v1/clients/:clientId/applications/:applicationId/participants/approver/approve
PUT /api/v1/clients/:clientId/applications/:applicationId/participants/approver/reject
PUT /api/v1/clients/:id/applications/:applicationId/participants/approver/rejectApproving | |||||||||
2) Получение данных Заявления GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | |||||||||
3) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса
| Tip | ||
|---|---|---|
| ||
| Цель - скорректировать Скорректировать согласующего, так как предыдущий сотрудник запросил смену согласующего
Предусловия
|
API-метод | Примечания |
|---|---|
1) Сотрудник выбирает кто будет согласовывать заявление | На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий |
2) Сотрудник передает данные идентификатор нового согласующего PUT /api/v1/clients/:clientId/applications/:applicationId/participants/approver/change | На данный момент данный метод не оформлен в API-документации Замена Согласующего происходит только если Согласующий отметил в Заявлении, что не является Согласующим |
6. Сотрудник загружает архив КЭДО по Заявлению
| Tip | ||
|---|---|---|
| ||
Цель - предоставить Предоставить сотруднику архив, содержащий:
Предусловия
|
API-метод | Примечания |
|---|---|
GET /api/v1/clients/:clientId/applications/:applicationId/archive |
Поиск документации
| Livesearch | ||
|---|---|---|
|