| Excerpt | ||||||
|---|---|---|---|---|---|---|
|
Основные задачи Сотрудника
Администратор отвечает за настройку ЛК HRlink. Что именно это означает? Рассмотрим основные функции.
Сотрудник без какой-либо дополнительной роли -| title | Важно |
|---|
| Note | ||
|---|---|---|
| ||
Под управлением структурой подразумевается:
|
| Note | ||
|---|---|---|
| ||
Под управлением персоналом подразумевается:
|
1. Сценарии работы Сотрудника с Документами
| Tip | ||
|---|---|---|
| ||
... |
| Note | ||
|---|---|---|
| ||
... |
API-методы
Примечания
POST /api/v1/clients/:clientId/legalEntities
Создавать ЮЛ может только пользователь с ролью Администратор
При создании можно указать Идентификатор ЮЛ в ИС Клиента, через поле externalId, это позволит в дальнейшем использовать внутренний (с точки зрения Клиента) идентификатор для работы с ЮЛ.
POST /api/v1/clients/:clientId/departments
- Создание МЧД
или - Импорт МЧД
Сценарий
Действия и API-методы
Примечание
1. Сотрудник просматривает данные документа
Цель - предоставить сотруднику всю необходимую информацию по кадровому документу
Предусловие - авторизация произведена
при использовании мастер-токена
с помощью логина/пароля
по коду
Или используется токен пользователя
1) Получение списка документов для Сотрудника (с учётом фильтров)
POST /api/v1/clients/:clientId/documents/employeeRegistry
На момент составления описания данные метод не оформлен в API-документации
Работа метода (входные параметры для фильтрации и результаты выполнения метода) аналогичны методу получение списка документов для Кадровика (с учётом фильтров)
2) Получение данных документа по ID в своей ИС
GET /api/v1/clients/:clientId/documents/:externalId/externalId
или
GET /api/v1/clients/:clientId/documents/:documentId
Для того, чтобы скачать Печатную форму документа, не скачивая архив, требуется сохранить идентификатор документа в HR-link
3) Получение печатной формы документа с оттиском
GET /api/v1/clients/:clientId/documents/:documentId/printFormFile
На момент составления описания данные метод не оформлен в API-документации
2. Сотрудник подписывает (согласовывает) документ через УНЭП по коду из сообщения
Цель - подписать документ, со стороны Сотрудника, как работника компании
Предусловие - выполнен сценарий 1
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
подписание документа - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние документа, чтобы:
получить обновление по статусу
перейти к запросу печатной формы с оттиском
Подробнее о том, как понять состояние документа см. раздел 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
или
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-документации
6. Сотрудник подписывает (согласовывает) документ ПЭП HRlink
Предусловие - Известен идентификатор документа для подписания
PUT /api/v1/clients/:clientId/documents/:documentId/sign/ses
На момент составления описания данные метод не оформлен в API-документации
2. Сценарии работы Сотрудника с Заявлениями
Порядок действий
API-метод
Примечания
1. Сотрудник подает заявление из файла и подписывает его УНЭП
Цель - предоставить Сотруднику возможность направить заявление, оформленное произвольным образом или по заранее подготовленному файлу
Предусловия
авторизация произведена
Получены типы Заявлений (для использования идентификатора заявления из файла)
GET /api/v1/applicationTypes
Определён список сотрудников, для Согласования
GET /api/v1/clients/:clientId/colleagues
1) Сотрудник загружает файл для подачи заявления
POST /api/v1/files
После загрузки файла, будет получен идентификатор загруженного файла, данный идентификатор надо передать в методе создания заявления.
2) Сотрудник выбирает кто будет согласовывать заявление
На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий, подробнее о метод
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-документации
GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId
подписание заявления - ассинхронный процесс, в рамках которого кроме самого подписания ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:
получить обновление по статусу
перейти к запросу печатной формы с оттиском
7) Получение печатной формы заявления с оттиском
GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile
2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП
Цель - предоставить Сотруднику возможность направить заявление, по заранее определённому шаблону, ожидающему заполнения заданных полей.
Предусловия
GET /api/v1/applicationTypeFields/system
Определён список сотрудников, для Согласования
GET /api/v1/clients/:clientId/colleagues
GET /api/v1/applicationTypes
Данный метод предоставляет сотруднику список шаблонов, доступных для подачи - необходим, чтобы сотрудник выбрал заявление по какому шаблону будет подано.
2) Сотрудник выбирает кто будет согласовывать заявление
На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий
3) Создание заявления по шаблону
POST /api/v1/clients/:clientId/applicationGroups
На основании того, какой был выбран шаблон заявления необходимо заполнить обязательные поля:
это может быть передача ранее определённых данных
это может быть UI форма для заполнения
Идентификатор файла - не заполняется, т.к. Система сама формирует файл заявления и конвертирует его в pdf/a формат для последующего подписания.
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) Завершение подписания Заявления УНЭП - подтверждение кода из сообщения
PUT /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes
в данный метод передается код, который направляется в сообщении
метод аналогичен методу подтверждения кода для Документа
На данный момент данный метод не оформлен в API-документации
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-документации
Метод аналогичен методу получение реестр заявлений для Кадровика
GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId
Данный метод возвращает метаданные заявления, но не файл для просмотра
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-документации
GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId
3) Получение печатной формы заявления с оттиском
GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile
5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса
Цель - скорректировать согласующего, так как предыдущий сотрудник запросил смену согласующего
Предусловия
Заявление подано сотрудником
Сотрудник является согласующим
выполнен сценарий - Сотрудник просматривает Заявление
Определён список сотрудников, для Согласования
GET /api/v1/clients/:clientId/colleagues
|
Основные задачи Сотрудника
01. Сотрудник. Сценарии работы Сотрудника с Документами
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
02. Сотрудник. Сценарии работы Сотрудника с Заявлениями
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
1) Сотрудник выбирает кто будет согласовывать заявление
На основании метода GET /api/v1/clients/:clientId/colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий
2) Сотрудник передает данные идентификатор нового согласующего
PUT /api/v1/clients/:clientId/applications/:applicationId/participants/approver/change
На данный момент данный метод не оформлен в API-документации
Замена Согласующего происходит только если Согласующий отметил в Заявлении, что не является Согласующим
6. Сотрудник загружает архив КЭДО по Заявлению
Цель - предоставить сотруднику архив, содержащий:
файл который подписывался
печатную форму с оттисками
файл подписи
Предусловия
выполнен сценарий - Сотрудник просматривает Заявление
Поиск документации
| Livesearch | ||
|---|---|---|
|