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

Запланированные отпуска

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

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

Метод возвращает сокращенную информацию по отпускам пользователей

  • идентификатор сотрудника и периоды его запланированных отпусков.

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

  • На тенантеTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. включен функционал «График отпусков».
  • Тело запроса задано.
  • Все обязательные поля тела запроса заданы.
  • Статус запрашиваемых отпусков либо не задан, либо соответствует одному из допустимых значений.
  • Даты начала и конца периода заданы корректно.
  • Параметры пагинации заданы корректно.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Пользователь клиента, который отправляет запрос, имеет право EMPLOYEE_PLANNED_VACATIONS на уровне пользователя клиента или на уровне одного из сотрудников.
  • Список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц задан корректно.
  • Список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. отделов задан корректно.
  • Список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сотрудников задан корректно.
  • Проверяет, что заданы все обязательные поля тела запроса.
  • Даты начала и конца периода либо заданы обе, либо не заданы совсем.
  • Если даты начала и конца периода заданы, то они соответствуют формату yyyy-MM-dd.
  • Если даты заданы, то начало периода не позже конца периода.
  • Проверяет, что количество возвращаемых при запросе элементов задано корректно.
  • Лимит не должен превышать допустимое максимальное значение.
  • Выполняет проверку корректности переданного списка юрлиц для фильтрации.
  • Если список юрлиц задан
  • выполняется проверка корректности переданных IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и доступность юрлиц для текущего пользователя клиента.
  • Выполняет проверку корректности переданного списка отделов для фильтрации.
  • Иначе
  • выполняется проверка корректности переданных IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и доступность отделов для текущего пользователя клиента.
  • Выполняет проверку корректности переданного списка сотрудников для фильтрации.
  • Если список сотрудников задан
  • выполняется проверка корректности переданных IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и доступность сотрудников для текущего пользователя клиента по отделам и юрлицам.
  • Проверяет, что на данном тенантеTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. включен функционал графика отпусков.
  • Проверяет, что количество элементов, которое нужно пропустить при выборке с пагинацией, корректно.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет, есть ли у пользователя клиента с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заданное право, и возвращает список юрлиц, где пользователь клиента имеет заданное право.
  • Проверяет, что заданное количество возвращаемых при запросе элементов корректно.
  • Список юрлиц не содержит пустых элементов.
  • Для каждого элемента из списка юрлиц задан либо IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях., либо IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе.
  • Юрлица по переданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существуют.
  • Юрлица по переданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. принадлежат заданному клиенту.
  • Проверяет, что список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц содержит только доступные юрлица.
  • Список отделов не содержит пустых элементов.
  • Для каждого элемента из списка отделов задан либо IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях., либо IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе.
  • Отделы по переданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существуют.
  • Отделы по переданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. принадлежат заданному клиенту.
  • Список сотрудников не содержит пустых элементов.
  • Сотрудники по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существуют.
  • Если заданы внешние IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. сотрудников, то по каждому внешнему IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. сотрудника можно либо однозначно определить сотрудника, либо сотрудники с одинаковыми внешними IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. относятся к юрлицам для фильтрации.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • Проверяет существование всех юрлиц клиента по заданному списку IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что заданное юрлицо относится к заданному клиенту.
  • Проверяет, что все UUID, заданные в списке, соответствуют существующим отделам клиента и возвращает список отделов клиента.
  • Проверяет, что заданный отдел клиента относится к заданному клиенту.
  • Проверяет идентифицированных работников по внешним IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. на принадлежность к данным переданных юрлиц.
  • Сотрудники принадлежат заданному клиенту.
  • Проверяет, что сотрудник по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует.
  • Проверяет, что сотрудник принадлежит клиенту с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что сотрудник по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе существует и возвращает его, если он существует.
  • Если юрлицо указано, то существование сотрудника проверяется в заданном юрлице.
  • Если юрлицо не указано, то существование сотрудника проверяется в клиенте с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что заданный сотрудник относится к заданному клиенту.

Request​

Responses​

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