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

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

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

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

Работа метода (входные параметры для фильтрации и результаты выполнения метода) аналогичны методу получение списка документов для Кадровика (с учётом фильтров)

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

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

или

• Получение данных документа по ID в HRL

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

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

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

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

На момент составления описания данные метод не оформлен в 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

или

• Получение данных документа по ID в HRL

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

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

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

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

Подробнее о том, как понять состояние документа см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#1.1.-%D0%9F%D0%BE%D0%BD%D1%8F%D1%82%D1%8C-%D1%81%D0%BE%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D0%B5-%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2-%D0%BD%D0%B0-%D0%BE%D1%81%D0%BD%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B8-%D0%BD%D0%B0%D0%B1%D0%BE%D1%80%D0%B0-%D0%BF%D1%80%D0%B8%D0%B7%D0%BD%D0%B0%D0%BA%D0%BE%D0%B2

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

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

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

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

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

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

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

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

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

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

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

или

• Получение данных документа по ID в HRL

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

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

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

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

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

• Запрос архива документооборота по ID в своей ИС

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

или

• Запрос архива документооборота по ID в HRL

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-документации

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

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

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

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