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