Перейти к основному содержимому

Реестр сотрудников

POST 
/api/v1/clients/:clientId/employees/getRegistry

Описание метода​

Обязательных полей нет, но задать json-тело обязательно. В случае, если ни один из фильтров не указан, то как минимум необходимо задать тело запроса как пустой объект {}. Строка с ФИО сотрудника (nameSearch) может содержать любое количество как полных имён, так и их частичных представлений в любом порядке (например, «ванов Анд», «Андр»). В результате фильтрации по ФИО вернутся только сотрудники, в имени, фамилии или отчестве которых содержится каждая введенная строка, разделенная пробелами. В positionIdsid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и departmentIdsid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. необходимо указывать IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. должностей и отделов сотрудников, определенных в справочнике HRlink’а. IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. можно получить, используя методы, связанные со справочником должностей и справочником отделов. Допустимо указать null значение, чтобы выбрать сотрудников без должности и без отдела соответственно. В поле legalEntityIdsid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. необходимо указывать IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц, которые были присвоены в HRlink’е. IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлица можно получить, используя методы, связанные со справочником юрлиц.

Валидации запроса​

  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Если задано контекстное право, то оно должно существовать и соответствовать контексту получения данных сотрудников.
  • Текущий пользователь клиента имеет право на выполнение операции получения реестра сотрудников.
  • Количество элементов, которые нужно пропустить при выборке, корректно.
  • Количество возвращаемых при запросе элементов корректно.
  • Фильтр по проверке документов сотрудников корректен.
  • Входные данные фильтрации проходят базовую валидацию для выполнения операции постраничного получения сотрудников.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет, есть ли у пользователя клиента с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заданное право и возвращает кэш наличия прав у пользователя клиента.
  • Проверяет, что переданные элементы разрешены пользователю с заданным списком IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. разрешенных элементов пользовательских структур.
  • Проверяет, что количество элементов, которое нужно пропустить при выборке с пагинацией, корректно.
  • Набор данных соответствует одному из допустимых значений реестра сотрудников.
  • Проверяет, что заданное количество возвращаемых при запросе элементов корректно относительно набора запрашиваемых данных для реестра сотрудников.
  • Проверяет, что данные для фильтрации по проверкам документов человека заданы корректно.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • Проверяет, что заданное количество возвращаемых при запросе элементов корректно.
  • Выполняет проверку уникальности типа проверки документов человека в фильтре реестра сотрудников.

Request​

Responses​

Успешная операция.