Table of Contents

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

Tipexcerpt

title	Цель

...

Note

title	Предусловие

...

1

API-методы

Примечания

1

Создание юрлица, в рамках которого будет осуществляться КЭДО

POST /api/v1/clients/:clientId/legalEntities

Создавать ЮЛ может только пользователь с ролью Администратор

При создании можно указать Идентификатор ЮЛ в ИС Клиента, через поле externalId, это позволит в дальнейшем использовать внутренний (с точки зрения Клиента) идентификатор для работы с ЮЛ.

2

Создания отдела клиента

POST /api/v1/clients/:clientId/departments

При создании можно указать Идентификатор Отдела в ИС Клиента, через поле externalId, это позволит в дальнейшем использовать внутренний (с точки зрения Клиента) идентификатор для работы с отделами.

Info

title	О чём раздел

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

Просмотр данных документа, в т.ч. получение архива КЭДО
Подписание документа: УНЭП, УКЭП, ПЭП, в т.ч. подписание со стороны работодателя и согласование документа участниками документооборота
Отклонение документа

Table of Contents

3

Создание МЧД
или
Импорт МЧД

Сценарий

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

Примечание

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

Цель - предоставить

Tip

title	Цель

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

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

при использовании мастер-токена
с помощью логина/пароля
по коду

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

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

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

ID своей ИС ID в HRL HR-linkНа момент составления описания данные метод не оформлен в API-документации

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

Примечание

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

Status

subtle	true
colour	Green
title	redoc

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

2) Получение данных документа по

идентификатору документа в

ИС клиента

Status

subtle	true
colour	Green
title	redoc

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

или

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

идентификатору документа в HRlink
Status
subtle true
colour Green
title redoc

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

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

HRlink

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

Status

subtle	true
colour	Green
title	redoc

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

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

Цель - подписать

Tip

title	Цель

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

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

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

Примечание

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

Status

subtle	true
colour	Green
title	redoc

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

по

По итогу вызова данного метода

требуется

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

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

Status

subtle	true
colour	Green
title	redoc

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

в

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

3) Получение данных документа по

ID

идентификатору документа в

своей

ИС клиента

Status

subtle	true
colour	Green
title	redoc

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

или

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

ID в HRL

идентификатору документа в HRlink
Status
subtle true
colour Green
title redoc

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

подписание 4)

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

получить обновление по статусу
перейти к запросу печатной формы с оттиском

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

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)

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

Status

subtle	true
colour	Green
title	redoc

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

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

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

Цель -

Tip

title	Цель

Отклонить документ (отказаться от подписания документа) и передать информацию Кадровику о причине отклонения документа

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

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

Примечание

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

Status

subtle	true
colour	Green
title	redoc

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

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

2) Получение данных документа по

ID

идентификатору документа в

своей

ИС клиента

Status

subtle	true
colour	Green
title	redoc

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

или

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

ID в HRL

идентификатору документа в HRlink
Status
subtle true
colour Green
title redoc

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

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

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

Tip

title	Цель

- предоставить

Предоставить Сотруднику все

документы по

артефакты КЭДО в рамках данного документа, а именно:

оригинал файла, который подписывался
печатную форму с оттисками
файлы подписи, если есть

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

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

Примечание

1) Запрос архива документооборота по

ID

идентификатору документа в

своей ИС

ИС клиента

Status

subtle	true
colour	Green
title	redoc

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

или

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

по ID в HRL

по идентификатору документа в HRlink
Status
subtle true
colour Green
title redoc

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

Скачать архив документооборота можно на любом этапе.

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

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

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

Tip

title	Цель

Подписать (согласовать) документ со стороны работодателя или его представителя.

Предусловие:

Известен идентификатор документа для подписания
Если при подписании используется МЧД, то идентификатор МЧД должен быть известен, т.е. загружен или создан в HRlink - подробнее см. раздел 01. Администратор. Базовые настройки справочников

Действия и API-методы	Примечание

Сотрудник подписывает (прикладывает файл подписи, сформированный во вне 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-документации

2. Сценарии работы Сотрудника с Заявлениями

2) Сотрудник выбирает кто будет согласовывать заявление

1) Получены типы Заявлений

GET /api/v1/applicationTypes

2) Сотрудник выбирает кто будет согласовывать заявление

Порядок действий

API-метод

Примечания

1. Сотрудник подает заявление из файла и подписывает его УНЭП

Цель - предоставить Сотруднику возможность направить заявление, оформленное произвольным образом или по заранее подготовленному файлу

Предусловия

авторизация произведена
Получены типы Заявлений (для использования идентификатора заявления из файла)
1. GET /api/v1/applicationTypes
Определён список сотрудников, для Согласования
1. GET /api/v1/clients/:clientId/colleagues

1) Сотрудник загружает файл для подачи заявления

POST /api/v1/files

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

На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий, подробнее о метод

Подробнее о методе см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#3.1.-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%A1%D0%BE%D1%82%D1%80%D1%83%D0%B4%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D0%B2%D1%8B%D0%B1%D0%BE%D1%80%D0%B0-%D0%A1%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D1%83%D1%8E%D1%89%D0%B5%D0%B3%D0%BE

3) Сотрудник подаёт заявление из загруженного файла

POST /api/v1/clients/:clientId/applicationGroups

Система сама сконвертирует загруженный файл в pdf/a формат для дальнейшего подписания.

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

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

POST /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes

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

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

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

PUT /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes

в данный метод передается код, который направляется в сообщении, метод аналогичен методу подтверждения кода для Документа

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

6) Получение данных Заявления

GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId

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

получить обновление по статусу
перейти к запросу печатной формы с оттиском

7) Получение печатной формы заявления с оттиском

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП

Цель - предоставить Сотруднику возможность направить заявление, по заранее определённому шаблону, ожидающему заполнения заданных полей.

Предусловия

Получены системные поля
1. GET /api/v1/applicationTypeFields/system
Определён список сотрудников, для Согласования
1. GET /api/v1/clients/:clientId/colleagues

Данный метод предоставляет сотруднику список шаблонов, доступных для подачи - необходим, чтобы сотрудник выбрал заявление по какому шаблону будет подано.

На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий

Подробнее о методе см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#3.1.-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%A1%D0%BE%D1%82%D1%80%D1%83%D0%B4%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D0%B2%D1%8B%D0%B1%D0%BE%D1%80%D0%B0-%D0%A1%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D1%83%D1%8E%D1%89%D0%B5%D0%B3%D0%BE

3) Создание заявления по шаблону

POST /api/v1/clients/:clientId/applicationGroups

На основании того, какой был выбран шаблон заявления необходимо заполнить обязательные поля:

это может быть передача ранее определённых данных
это может быть UI форма для заполнения

Идентификатор файла - не заполняется, т.к. Система сама формирует файл заявления и конвертирует его в pdf/a формат для последующего подписания.

4) Получение данных Заявления

GET /api/v1/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

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

метод аналогичен методу запроса кода для Документа

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

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

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

Status

subtle	true
colour	Green
title	redoc

PUT /api/v2/clients/{clientId}/documentsByExternalId/{documentId}/signByQes

Сотрудник подписывает документ УКЭПом (прикладывает файл подписи, сформированный во вне HRlink) по идентификатору документа в HRlink
Status
subtle true
colour Green
title redoc

PUT /api/v2/clients/{clientId}/documents/{documentId}/signByQes

Устаревший метод:

PUT /api/v1/clients/:clientId/

applicationGroups

documents/:

applicationGroupId

documentId/sign/

nqes

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

метод аналогичен методу подтверждения кода для Документа

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

8) Получение данных Заявления

GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId

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

получить обновление по статусу
перейти к запросу печатной формы с оттиском

9) Получение печатной формы заявления с оттиском

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

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

3. Сотрудник просматривает Заявление

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

Предусловия (одно из)

Заявление подано сотрудником
Сотрудник является согласующим

1) Сотрудник загружает список заявлений, в соответствии с фильтрами

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

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

Метод аналогичен методу получение реестр заявлений для Кадровика

2) Получение данных Заявления

GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId

Данный метод возвращает метаданные заявления, но не файл для просмотра

externalQes

Перед подписанием (вызовом метода) необходимо сформировать файл подписи документа вне системы HRlink и приложить этот файл в формате base64, которая содержит бинарные данные подписи созданной с помощью УКЭП.

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

Tip

title	Цель

Подписать (согласовать) документ со стороны другого согласующего Сотрудника через портал Работа России

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

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

Примечание

1) Сотрудник подписывает документ ПЭП с помощью портала Работа в России

Status

subtle	true
colour	Green
title	redoc

POST /api/v2/clients/{clientId}/documents/{documentId}/sign/prr

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

Tip

title	Цель

Подписать (согласовать) документ со стороны другого согласующего Сотрудника

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

1) Сотрудник выбирает кто будет согласовывать заявление

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

Примечание

1) Сотрудник подписывает документ ПЭП HRlink

Status

subtle	true
colour	Green
title	redoc

PUT

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

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

4. Сотрудник Обрабатывает заявление как Согласующий

Цель - предоставить ответственному сотруднику возможность принять решение по заявлению:

согласовано
отклонено
нужно заменить согласующего

Предусловия

Заявление подано сотрудником
Сотрудник является согласующим
выполнен сценарий - Сотрудник просматривает Заявление

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

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

2) Получение данных Заявления

GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId

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

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса

Цель - скорректировать согласующего, так как предыдущий сотрудник запросил смену согласующего

Предусловия

Заявление подано сотрудником
Сотрудник является согласующим
выполнен сценарий - Сотрудник просматривает Заявление
Определён список сотрудников, для Согласования
1. GET /api/v1/clients/:clientId/colleagues

На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий

Подробнее о методе см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#3.1.-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%A1%D0%BE%D1%82%D1%80%D1%83%D0%B4%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D0%B2%D1%8B%D0%B1%D0%BE%D1%80%D0%B0-%D0%A1%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D1%83%D1%8E%D1%89%D0%B5%D0%B3%D0%BE

2) Сотрудник передает данные идентификатор нового согласующего

PUT /api/v1/clients/:clientId/applications/:applicationId/participants/approver/change

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

Замена Согласующего происходит только если Согласующий отметил в Заявлении, что не является Согласующим

6. Сотрудник загружает архив КЭДО по Заявлению

Цель - предоставить сотруднику архив, содержащий:

файл который подписывался
печатную форму с оттисками
файл подписи

Предусловия

выполнен сценарий - Сотрудник просматривает Заявление

Сотрудник запрашивает архив КЭДО по Заявлению

GET

/api/v1/clients/:clientId/

applications

documents/:

applicationId

documentId/sign/

Page tree

Versions Compared

Old Version 1

New Version Current

Key

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

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

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

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

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

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

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

2. Сценарии работы Сотрудника с Заявлениями

1. Сотрудник подает заявление из файла и подписывает его УНЭП

2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП

3. Сотрудник просматривает Заявление

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

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

4. Сотрудник Обрабатывает заявление как Согласующий

5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса

6. Сотрудник загружает архив КЭДО по Заявлению

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

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

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

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

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

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

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

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

2. Сценарии работы Сотрудника с Заявлениями

1. Сотрудник подает заявление из файла и подписывает его УНЭП

2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП

3. Сотрудник просматривает Заявление

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

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

4. Сотрудник Обрабатывает заявление как Согласующий

5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса

6. Сотрудник загружает архив КЭДО по Заявлению