Пользователь (CL_Client)

Owned by Corteos Platform (Unlicensed)
Last updated: Jul 31, 2024 by Виктория
3 min read

Пользователь (CL_Client) - лицо, имеющее доступ к системе.
Пользователю могут быть предоставлены различные права доступа, он может быть заблокирован, пользователь привязывается к определенной персоне.

Поля пользователя следующие:

  • id (пример: "123") - первичный ключ пользователя (обязательное поле, число);

  • Email (пример: "super@ivanov.ru") - электронная почта, логин в систему (обязательное поле, строка);

  • IsBlocked (пример: "true") - флаг блокировки пользователя (обязательное для заполнения булево поле);

  • id_Person (пример: "123") - ссылка на персону, привязанную к этому пользователю (обязательное поле, число);

  • id_Group (пример: "123") - ссылка на группу контрагентов (обязательное поле, число);

  • id_Role (пример: "123") - ссылка на роль текущего пользователя (обязательное поле, число);

  • id_Substitutor (пример: "123") - идентификатор заместителя (обязательное поле, число);

  • Password (пример:"test") -  пароль пользователя (обязательное поле, строка);

  • TimeZone (пример: "3") - часовой пояс клиента, по умолчанию "+3" (может быть числом от 2 до 12) (обязательное поле, число);

  • OuterId (пример: "a88733f3-032c-44e4-a2a0-c56b1a0885ea") - идентификатор внешней системы (необязательное поле, строка).

 

В интерфейсе в редактор пользователя со стороны клиента можно зайти следующим образом:

1) Меню "Настройки -> Персоны и пользователи":


 2) из списка персон выбираем нужную персону:

 3) переходим в редактор персоны:

Со стороны агента для редактирования пользователя необходимо:

1) Выбрать пункт меню "Редактор пользователей агента", затем из списка выбрать нужного пользователя для редактирования:

Соответствие полей интерфейса полям в модели:

Соответственно, действие, аналогичное редактированию пользователя из API, можно произвести на интерфейсе в разделе персон и пользователей.

Перед использованием метода необходимо пройти аутентификацию и получить валидный токен. Подробнее об этом: Авторизация (получение токена)

Для получения контекста пользователя используется сервис UserManagement.asmx

WSDL можно скачать с демо-сайта: https://stage1.corteos.ru/XmlGate/V3/StaticData/Users/UserManagement.asmx?wsdl

Для работы в продуктовой среде необходимо заменить “stage1.corteos.ru” на свой домен (на котором работают пользователи вашей компании).

В API реализованы следующие методы для работы с пользователем:

  1. GetV2 - получение пользователя по первичному ключу (CL_Client.id);

  2. SaveV2 - создание нового пользователя или редактирование существующего;

  3. RolesListV2 - получение списка ролей пользователей группы компаний;

  4. CheckV2 -проверка наличия пользователя с определенным email;

  5. DeleteV2 - удаление пользователя по первичному ключу.

 

Подробное описание методов с примерами:


1. Получение пользователя по первичному ключу (GetV2)

Для проведения выгрузки данных, необходимо передать первичный ключ пользователя.

 запрос / ответ
2. Создание нового пользователя или редактирование существующего (SaveV2)

Для сохранения изменений в уже созданном пользователе необходимо передать первичный ключ пользователя.

В том случае, если мы создаем нового пользователя, первичный ключ не передаем.

Если нам надо удалить пользователя, то в атрибуте deleted передаем значение true.

запрос на создание / запрос на изменение/ ответ
4. Проверка наличия пользователя с определенным email (CheckV2)

Для проверки наличия пользователя с определенным email необходимо передать e-mail пользователя.

запрос / ответ
5. Удаление пользователя (DeleteV2)

Для удаления пользователя по первичному ключу используется метод DeleteV2.

запрос / ответ