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

Массовое приглашение пользователей

POST 
/api/v1/clients/:clientId/users/invite

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

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

  • Тело запроса задано.
  • В теле запроса задан тип приглашения.
  • В теле запроса корректно задан список с данными для приглашения пользователей клиента.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • У текущего пользователя есть права для приглашения.
  • Данные для приглашения каждого пользователя клиента в списке заданы корректно.
  • ТенантTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. должен иметь активный пакет лицензий.
  • ТенантTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. должен иметь свободные лицензии пользователя для всех приглашаемых пользователей клиента.
  • ТенантTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. должен иметь свободные лицензии администраторов для всех приглашаемых пользователей клиента с его правами.
  • Лимит на выполнение операций создания печатной формыпечатная форма PDF-документ с визуальным оттиском подписей, который система формирует после завершения документооборота. Печатная форма доступна для скачивания и используется для архивного хранения. файла для заданного тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. не будет превышен.
  • Существует активный пакет СМС и лимит СМС в пакете лицензий не должен быть исчерпан или превышен в результате данного действия.
  • Список задан.
  • Список не содержит пустых элементов.
  • Данные для приглашения каждого пользователя клиента корректны.
  • Пользователь клиента, который выполняет приглашение, не совпадает с приглашаемыми пользователями.
  • Приглашаемые пользователи клиента не повторяются.
  • Тип приглашения задан.
  • Тип приглашения не WHATS_APP.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Производит проверку, что у тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. есть активный пакет лицензий.
  • Если у тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. никогда ещё не было пакетов лицензий, то проверка пропускается.
  • Производит проверку, что у тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. имеется требуемое количество доступных лицензий пользователя.
  • Выполняет проверку и возвращает результат проверки, что у тенантаTenant Экземпляр системы HRlink на отдельном домене (например, company.hr-link.ru). Внутри одного тенанта может быть несколько пространств клиентов. есть требуемое количество доступных лицензий администраторов или кадровиков.
  • Задан IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. пользователя клиента.
  • Задан логин для приглашения.
  • Пользователь клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует.
  • Пользователь клиента принадлежит заданному клиенту.
  • Логин задан корректно.
  • Список типов подписания для включения при приглашении пользователя задан корректно.
  • Если в теле запроса задан тип канала подтверждения подписания УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа., в списке типов подписания для включения должен быть задан УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа..
  • Если в теле запроса задан тип канала подтверждения подписания ПРР, данные для включения возможности подписания через ПРР заданы корректно.
  • Проверяет, что пользователь клиента, который осуществляет приглашение, не совпадает с приглашаемым пользователем.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • Возвращает результат неуспешно пройденной проверки.
  • Проверка пройдена?
  • Список данных для включения ПРР задан и не пустой.
  • Список данных для включения ПРР не содержит пустых элементов.
  • Пользователь клиента, выполняющий операцию, имеет право CLIENT_USERS_INVITE на уровне пользователя клиента или право CLIENT_USERS_INVITE на уровне юрлица, в котором происходит включение подписания через ПРР.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц заданы корректно.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. руководителей заданы корректно.
  • Среди IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц нет повторяющихся данных.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. пользователя клиента задан в данных приглашения.
  • Проверяет, что заданный пользователь клиента принадлежит клиенту с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • В списке нет дубликатов типов подписания.
  • В списке нет одновременно значений «УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа. с очной идентификацией» и «УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа. с удалённой идентификацией».
  • Заданные типы подписания можно включать при заданном типе приглашения.
  • Проверяет, что в данных пользователей для включения типов подписания содержится одно из значений УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа.: NQES_REMOTE или NQES_IN_PERSON.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлица задано.
  • Юрлицо существует по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Юрлицо относится к заданному клиенту.
  • Пользователь имеет доступ к заданному юрлицу.
  • Проверяет, что в списке IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц, переданного в данных для включения возможности подписания через ПРР нет дубликатов.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. руководителя задан.
  • Руководитель задан корректно.
  • Проверяет, что в списке типов подписания для включения не содержится дубликатов.
  • Проверяет, что среди типов подписания для включения нет одновременно значений УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа. с удалённой и очной идентификацией.
  • Проверяет, что типы подписания для включения можно задавать при данном типе приглашения.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлица задан.
  • Проверяет, что юрлицо клиента существует по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает юрлицо клиента, если он существует.
  • Проверяет, что заданное юрлицо относится к заданному клиенту.
  • Проверяет, что список IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. юрлиц содержит только доступные юрлица.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. руководителя задан.
  • Руководитель существует по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Руководитель относится к заданному клиенту.
  • Руководитель относится к заданному юрлицу.
  • Руководитель обладает правом HEAD_MANAGER.
  • Руководитель является активным и не уволенным.
  • Проверяет, что сотрудник по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует.
  • Проверяет, что сотрудник принадлежит клиенту с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что сотрудник относится к юрлицу.
  • Проверяет, что данный сотрудник работает.
  • Проверяет, что сотрудник по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе существует и возвращает его, если он существует.
  • Если юрлицо указано, то существование сотрудника проверяется в заданном юрлице.
  • Если юрлицо не указано, то существование сотрудника проверяется в клиенте с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Проверяет, что заданный сотрудник относится к заданному клиенту.

Request​

Responses​

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