Сценарии работы Сотрудника с Документами


Под сценариями работы Сотрудника понимаем:

  1. Просмотр данных документа, в т.ч. получение архива КЭДО

  2. Подписание документа: УНЭП, УКЭП, ПЭП
  3. Отклонение документа


 1. Сотрудник просматривает данные документа

Предоставить сотруднику всю необходимую информацию по кадровому документу

Предусловие - авторизация произведена

Или используется токен пользователя


Действия и API-методы

Примечание

1) Получение списка документов для Сотрудника (с учётом фильтров) 

POST /api/v1/clients/:clientId/documents/employeeRegistry


2) Получение данных документа по ID в своей ИС

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

GET /api/v1/clients/:clientId/documents/:documentId

Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется сохранить идентификатор документа в HRlink

3) Получение печатной формы документа с оттиском

GET /api/v1/clients/:clientId/documents/:documentId/printFormFile



2. Сотрудник подписывает (согласовывает) документ через УНЭП по коду из сообщения

подписать документ, со стороны Сотрудника, как работника компании

Предусловие - выполнен сценарий 1


Действия и API-методы

Примечание

1) Запуск подписания УНЭП - запрос сообщения с кодом

POST /api/v1/clients/:clientId/documents/:documentId/sign/nqes

По итогу вызова данного метода требуется отобразить форму ввода кода


2) Завершение подписания УНЭП - подтверждение кода из сообщения

PUT /api/v1/clients/:clientId/documents/:documentId/sign/nqes

В данный метод передается код, который направляется в сообщении

3) Получение данных документа по ID в своей ИС

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

GET /api/v1/clients/:clientId/documents/:documentId

 

Подписание документа - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние документа, чтобы:

  1. получить обновление по статусу

  2. перейти к запросу печатной формы с оттиском

Подробнее о том, как понять состояние документа см. раздел Объекты и связи. Документ

Дополнительный метод Получить данные запроса на подписание документа (УНЭП, Госключ, ПРР) позволяет получить подробную информацию о состоянии подписания документа.

4) Получение печатной формы документа с оттиском

GET /api/v1/clients/:clientId/documents/:documentId/printFormFile

Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется идентификатор документа в HR-link




Сценарий

Действия и API-методы

Примечание

3. Сотрудник отклоняет документ, ожидающий подписания (согласования)

Цель - передать информацию Кадровику о причине отклонения документа

Предусловие - выполнен сценарий 1

1) Отказ от подписания документа

PUT /api/v1/clients/:clientId/documents/:documentId/rejectSigning

Для отклонения подписания обязательным является указание причины - передача не пустого текстового поля, требуется получить от сотрудника текст причины отклонения

2) Получение данных документа по ID в своей ИС

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

GET /api/v1/clients/:clientId/documents/:documentId

рекомендуется запрашивать состояние документа, чтобы получить обновление по статусу


4. Сотрудник запрашивает Архив КЭДО по документу

Цель - предоставить Сотруднику все документы по КЭДО в рамках данного документа

Предусловие - выполнен сценарий 1

GET /api/v1/clients/:clientId/documents/:externalId/externalId/archive

или

GET /api/v1/clients/:clientId/documents/:documentId/archive

В архиве документооборота подписи файла документа могут отсутствовать, может быть одна подпись, и может быть обе подписи. Это зависит от того, кто подписал документ на момент скачивания архива документооборота.


5. Сотрудник подписывает (согласовывает) документ УКЭП

Предусловие - Известен идентификатор документа для подписания

Сотрудник подписывает (прикладывает файл подписи, сформированный во вне HRlink) документ УКЭПом

PUT /api/v1/clients/:clientId/documents/:documentId/sign/externalQes



6. Сотрудник подписывает (согласовывает) документ ПЭП Госуслуги

Предусловие - Известен идентификатор документа для подписания

POST /api/v1/clients/:clientId/documents/:documentId/sign/prr

На момент составления описания данные метод не оформлен в API-документации see-no-evil monkey



6. Сотрудник подписывает (согласовывает) документ ПЭП HRlink

Предусловие - Известен идентификатор документа для подписания

PUT /api/v1/clients/:clientId/documents/:documentId/sign/ses

На момент составления описания данные метод не оформлен в API-документации see-no-evil monkey



Поиск документации