Сотрудники
Информация о разделе
Страница содержит сценарии использования API для взаимодействия с сотрудниками.
Общая информация
Сотрудник организации — это человек, который работает на предприятии, компании или организации и выполняет определенные обязанности и задачи в рамках своей должности.
Машиночитаемая доверенность (МЧД) — цифровой аналог бумажной доверенности на подписание документов в электронном виде. Файл доверенности содержит информацию о доверителе и уполномоченном лице, а также его полномочия. Машиночитаемая доверенность (МЧД) подписывается усиленной квалифицированной подписью. МЧД требуется физ. лицам являющимися представителями ИП или ЮЛ для действий с документооборотом и регистрации абонента. Номер МЧД используется в теле запроса/ответа при манипуляциях с ДО.
Важно Если не будет указан номер доверенности в ключе warrantNumber и у сотрудника в БД есть активные доверенности, то при отправке документа будет подставлена автоматически доверенность с самой поздней датой начала действия.
Важно Если не будет указан номер доверенности в ключе warrantNumber и у сотрудника в БД нет активных доверенностей, то при отправке документа вернется ошибка "Не передан номер МЧД для подписания документа"
Добавление МЧД
Для добавления или обновления статуса МЧД у сотрудника, необходимо передать идентификатор сотрудника и номер доверенности с помощью метода [PUT]/api/v1/employees/{employeeId}/warrant/{warrantNumber} В успешном ответе (200) вернется информация о добавленной или обновленной доверенности.
Удаление МЧД
Чтобы удалить МЧД у сотрудника, необходимо передать идентификатор сотрудника и номер доверенности с помощью метода [DELETE]/api/v1/employees/{employeeId}/warrant/{warrantNumber} В успешном ответе (200) придет сообщение об успешном удалении МЧД.
Получение информации о всех доверенностях, выданных на сотрудника
Данный метод позволяет получить информацию о всех доверенностях, выданных на указанного сотрудника организации [GET]/api/v1/employees/{employeeId}/warrants. employeeId - идентификатор сотрудника, для которого необходимо получить информацию о доверенностях. В успешном ответе (200) будет информация о всех доверенностях, выданных на сотрудника .
Работа сотрудников в подразделениях
Cтраница содержит сценарии использования API для работы с реестром "Сотрудники", включая информацию о подразделении сотрудника, настройках прав доступа к документам.
Сервис, предназначенный для работы с реестром "Сотрудники", направлен на эффективное управление данными. Набор методов API, позволяет оперативно получать: данные о сотрудниках, информацию о том, в каком подразделении числятся сотрудники, а также просматривать информацию - какие документы организации доступны сотруднику.
При работе с сотрудниками доступны следующие действия:
- Получить сведения о списке сотрудников
- Получить детализированную информацию о сотруднике: подразделение сотрудника, персонализированные настройки доступа к документам
- Получить детализированную информацию о текущем сотруднике, включая: подразделение сотрудника, персонализированные настройки доступа к документам
Получение сведений о списке сотрудников
Для получения сведений о сотрудниках необходимо вызвать метод [GET]/api/v1/employees. При успешном выполнении операции метод вернет список сотрудников абонента в модели EmployeeShortInfo.
В качестве входных параметров необходимо передавать:
- внутренний идентификатор абонента,
- (необязательно) параметры поиска (ФИО),
- мин. количество символов = 1,
- макс. количество символов = 200,
- может начинаться только с буквы и заканчиваться только буквой,
- (необязательно) начальное значение списка,
- (необязательно) количество выводимых значений (по умолчанию: 15).
При успешной инициализации запроса, проверяется валидность входных параметров. Если проверка входных параметров не пройдена, то сервер вернет ошибки с текстовым описанием причины в теле ответа (См. таблицу 1).
Таблица 1. Ошибки входных параметров
| Описание ошибки | Причина |
|---|---|
| Пользователь {userId} не имеет доступа к абоненту {abonentId}. | Отказано в доступе: некорректно указан abonentId. Аккаунт пользователя не содержит абонента с указанным идентификатором |
| Невалидные данные в запросе | Переданы некорректные параметры запроса: один или несколько из указанных параметров не соответствуют их типу данных, или они не указаны вовсе |
(Описание ошибок будет систематически дополняться)
Если все проверки успешно пройдены, то сервер вернет положительный ответ с HTTP-кодом 200 и модель EmployeeShortInfoResultList, которая будет содержать список сотрудников абонента.
Получение детальной информации по сотруднику организации
Для получения подробной информации по сотруднику необходимо вызвать метод [GET]/api/v1/employees/{employeeId}. При успешном выполнении операции метод вернет информацию об указанном сотруднике, включая: подразделение сотрудника, доступ к документам организации, в модели EmployeeFullInfo.
В качестве входных параметров необходимо передавать:
- внутренний идентификатор абонента,
- идентификатор сотрудника (id, ранее полученный методом [GET]/api/v1/employees).
При успешной инициализации запроса, проверяется валидность входных параметров. Если проверка входных параметров не пройдена, то сервер вернет ошибки с текстовым описанием причины в теле ответа (См. таблицу 2).
Таблица 2. Ошибки входных параметров
| Описание ошибки | Причина |
|---|---|
| Пользователь {userId} не имеет доступа к абоненту {abonentId} | Отказано в доступе: некорректно указан abonentId. Аккаунт пользователя не содержит абонента с указанным идентификатором |
| Не удалось найти организацию с идентификатором {abonentId} | Передан некорректный параметр запроса: abonentId |
| Не удалось найти сотрудника с идентификатором {employeeId} | Передан некорректный параметр запроса: employeeId |
(Описание ошибок будет систематически дополняться)
Если все проверки успешно пройдены, то сервер вернет положительный ответ с HTTP-кодом 200 и модель EmployeeFullInfo, которая будет содержать информацию о сотруднике, сведения о закрепленном его подразделении и настройках доступа к документам организации.
Получение детальной информации по текущему сотруднику
Для получения подробной информации по текущему сотруднику необходимо вызвать метод [GET]/api/v1/employees/current. При успешном выполнении операции метод вернет информацию о текущем сотруднике, включая: подразделение сотрудника, доступ к документам организации, в модели EmployeeFullInfo.
Текущий сотрудник - сотрудник, определенный в токене по идентификатору пользователя (user_id), считается текущим сотрудником выбранной организации.
В качестве входных параметров необходимо передавать:
- внутренний идентификатор абонента.
При успешной инициализации запроса, проверяется валидность входного параметра. Если проверка входного параметра не пройдена, то сервер вернет ошибки с текстовым описанием причины в теле ответа (См. таблицу 3).
Таблица 3. Ошибки входных параметров
| Описание ошибки | Причина |
|---|---|
| Пользователь {userId} не имеет доступа к абоненту {abonentId} | Отказано в доступе: некорректно указан abonentId. Аккаунт пользователя не содержит абонента с указанным идентификатором |
(Описание ошибок будет систематически дополняться)
Если проверка успешно пройдена, то сервер вернет положительный ответ с HTTP-кодом 200 и модель EmployeeFullInfo, которая будет содержать информацию о текущем сотруднике, сведения о закрепленном его подразделении и настройках доступа к документам организации.