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