|
Предоставить Сотруднику возможность направить заявление, оформленное произвольным образом или по заранее подготовленному файлу. Предусловия
|
API-метод | Примечания |
---|---|
Данный метод предоставляет список типов заявлений, доступных для подачи, а также маршруты подписания по этим типам. Для подачи заявления из файла необходимо выбрать соответствующий тип Заявления - для стандартного типа "Загрузка из файла" всегда указан
| |
Сотрудник заранее создает файл и прикладывает его при оформлении Заявления в системе. После загрузки файла, будет получен идентификатор загруженного файла. Данный идентификатор надо передать в методе создания группы заявлений. (см. п 4) | |
3) Сотрудник выбирает кто будет согласовывать заявление | Определить Согласующих возможно несколькими способами:
|
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 | Передача кода для проверки в УЦ. Результат проверки кода не возвращается в ответе метода, т.к. процесс асинхронный. Требуется опрашивать статус Заявления для продолжения процесса. Подробнее про состояния Заявления. |
В рамках процесса подписания Заявления, кроме самого подписания, ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:
| |
8) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
Предоставить Сотруднику возможность направить заявление, по заранее определённому шаблону, ожидающему заполнения заданных полей. Предусловия
|
API-метод | Примечания |
---|---|
1) Получены типы Заявлений и маршрут подписания GET /api/v1/applicationTypes | Данный метод предоставляет список типов заявлений, доступных для подачи, а также маршруты подписания по этим типам. Для подачи заявления из файла необходимо выбрать соответствующий тип Заявления.
|
| |
2) Сотрудник выбирает кто будет согласовывать заявление | Определить Согласующих возможно несколькими способами:
|
3) Создание заявления по шаблону POST /api/v1/clients/:clientId/applicationGroups | На основании того, какой был выбран тип (шаблон) заявления необходимо заполнить обязательные поля:
|
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 | В данный метод передается код, который направляется в сообщении |
GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | Подписание заявления - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:
|
7) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
Предоставить Сотруднику всю информацию по заявлению Предусловия (одно из)
|
API-метод | Примечания |
---|---|
1) Сотрудник загружает список заявлений, в соответствии с фильтрами POST /api/v2/clients/:clientId/applicationGroups/getEmployeeRegistry | |
GET /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | Данный метод возвращает метаданные заявления, но не файл для просмотра |
3) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
Предоставить ответственному сотруднику возможность принять решение по заявлению:
Предусловия
|
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 /api/v2/clients/:clientId/applicationGroups/:applicationGroupId | |
3) Получение печатной формы заявления с оттиском GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile |
Скорректировать согласующего, так как предыдущий сотрудник запросил смену согласующего
Предусловия
|
API-метод | Примечания |
---|---|
1) Сотрудник выбирает кто будет согласовывать заявление | На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий |
2) Сотрудник передает данные идентификатор нового согласующего PUT /api/v1/clients/:clientId/applications/:applicationId/participants/approver/change | На данный момент данный метод не оформлен в API-документации Замена Согласующего происходит только если Согласующий отметил в Заявлении, что не является Согласующим |
Предоставить сотруднику архив, содержащий:
Предусловия
|
API-метод | Примечания |
---|---|
GET /api/v1/clients/:clientId/applications/:applicationId/archive |
Поиск документации