Пользователи — Users

При получении карточки пользователя система не отдает информацию из блока Рабочая информация, если отсутствуют права на просмотр блока.

В методах для работы с пользователями:

  • Доступно получить все атрибуты пользователя, в том числе дополнительные.
  • Все атрибуты доступны по тегу.

Вы можете получить сведения о дате и времени последнего входа пользователя или клиента в систему Case.one через следующие методы публичного API:

  • GET /api/v1/users/{id}
  • GET /api/v1/users
  • GET /api/v2/users/{id}
  • GET /api/v2/users

В качестве источника данных параметра LastLoginDate методов берутся дата и время из статуса Последний вход колонки Статус в разделе Администрирование — Пользователи:

  • Формат данных: дата в ISO, время в UTC+0.
  • Поле может быть пустым, если пользователь никогда не входил в Case.one.

В результате будут получены сведения о последнем входе пользователя или клиента, если вход в Case.one был выполнен:

  • На странице входа Case.one.
  • С помощью Windows-аутентификации.
  • Через SSO.

Доступные версии: V1, V2:

  • GET /api/v2/users/{id} — метод позволяет получить указанного пользователя по идентификатору — в исходящих параметрах доступно указать:
    • Группы пользователя
    • Роли пользователя
    • Телефон
    • Часовой пояс
    • Должность
    • Подразделение
    • Организация
    • Сайт
  • GET /api/v2/users — метод позволяет получить список пользователей:
    • Доступна фильтрация:
      • Все, пользователи, клиенты
      • Все, только активные
    • Системные пользователи не отображаются
    • По пользователям передаются данные: ФИО (с учетом настроек локализации), почта, тип (клиент, пользователь), статус (активный, заблокированный)
    • Пользователи отсортированы по ФИО (с учетом настроек локализации), паджинация по 100 значений
  • POST /api/v2/users/{id}/notify — метод позволяет отправить уведомление стандартным всплывающим сообщением одному пользователю:
    • Полный аналог приватного запроса /api/NotifySingleUser
    • Метод принимает как просто текст, так и текст с html-разметкой
    • Сообщение у пользователя выводится в соответствии с разметкой
    • Стилизованная под Case.one разметка (остальные теги могут использоваться, но будут выводиться браузером)
      • Перенос строки: <br/>, \n, \r
      • Ссылки: <a href></a>
      • Стилизация текста: <b>, <i>, <u>
      • Списки: <ol>, <ul>
    • Можно добавить необязательный массив кнопок в формате: текст + ссылка:
      • По каждой ссылке можно указать параметр – открывается в том же окне или новом
      • Если параметр не указан, считается, что открывается в соответствии с настройками аккаунта
    • Для каждой кнопки предусмотрен параметр закрытия нотификации:
      • Параметр не обязательный
      • Если параметр не передан, нажатие на кнопку не закроет уведомление
    • Текущий механизм размещения кнопок не меняется (не гарантировано корректное отображения, если название слишком большое или много кнопок)
    • Кнопка Закрыть всегда отображается
  • POST /api/v1/users/{id}/openDialog — метод позволяет настраивать и отправлять уведомления указанному пользователю 
    • В зависимости от указанных в методе параметров уведомление:
      • Может отображаться только в определенной карточке объекта или во всех разделах Case.one
      • Может содержать форматированный текст и настроенную кнопку (аналогично работе метода публичного API POST /api/v2/users/{id}/notify)
    • Особенности отображения уведомления для пользователя:
      • Уведомление отображается по центру экрана
      • Во время отображения недоступны любые действия в Case.one, кроме действий с уведомлением (настроенная кнопка и кнопка закрытия уведомления)
      • Если вызвано несколько уведомлений, более новое заменяет предыдущее
      • Уведомление отображается на всех вкладках карточки объекта:
        • Если закрыть уведомление на одной вкладке, на остальных оно закроется автоматически
        • Если карточка объекта открыта в разных браузерах или в разных окнах одного браузера, уведомление нужно закрыть в каждом браузере или окне
    • Входящие параметры метода:
      • Идентификатор пользователя, обязательный параметр
      • Идентификатор объекта, в рамках которого будет отображаться диалоговое окно
      • Заголовок уведомления, обязательный параметр
      • Текст уведомления —  обязательный параметр, возможно указать текст с html-разметкой 
      • Параметры настраиваемой кнопки — параметры идентичны параметрам кнопки метода POST /api/v2/users/{id}/notify
      • Условия отображения диалогового окна:
        • True (Да) — значение по умолчанию, только в карточке объекта (диалоговое окно отображается на всех открытых вкладках)
        • False (Нет) — в любом разделе Case.one
    • Вызов метода доступен при правах не ниже Просмотр на карточки пользователя и объекта и уровнем доступа Просмотр к карточке объекта
    • Если у получателя нет прав на объект, при попытке вызвать метод пользователю, который вызвал метод, отобразится ошибка: Дело не найдено или недостаточно прав