Метод: updateSmartGroup
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
groupId (обязательный) | string | ID смарт-группы, которое нужно отредактировать. |
name (необязательный) | string | Название смарт-группы. |
rules (необязательный) | array | Список правил смарт-группы. |
attributeType (обязательный) | int | Может принимать значения: |
attributeId (необязательный) | string | Идентификатор поля профиля. Заполняется только для полей профиля (attributeType — 3). |
operator (обязательный) | int | Для подразделений:
Для групп и полей профиля:
|
value (обязательный) | string | Для подразделений:
Для групп:
Для поля профиля:
Внимание: для поля Страна нужно использовать ID страны, а не название. ID страны можно получить при помощи метода Получение списка полей профиля пользователя. |
Вы можете добавить несколько групп условий для добавления пользователей в смарт-группу. Они будут работать по принципу «И», то есть должны будут сработать одновременно.
Внутри этих групп создайте любое число правил. Они, напротив, работают по принципу «ИЛИ», то есть достаточно выполнения одного из правил.
Подробнее о смарт-группах и их условиях читайте в статье Смарт-группы.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют редактировать смарт-группы.
Возвращаемые значения
После того как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если смарт-группа была успешно отредактирована. |
Возможные ошибки
Тип | Описание |
---|---|
Unknown Group | Смарт-группа не найдена. |
Permission denied | У пользователя недостаточно прав для обновления данных смарт-группы. |
Wrong Parameters | Один из указанных параметров задан неверно. |
Пример запроса
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <updateSmartGroupRequest> <credentials> <accountUrl>https://myaccount.ispringlearn.ru</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> <groupId>06a7dcfe-e05a-11e9-b1e5-0a580af40b37</groupId> <name>Отдел продаж</name> <rules> <and> <or> <rule> <attributeType>1<attributeType> <attributeId></attributeId> <operator>2</operator> <value>id_department</value> </rule> </or> <or> <rule> <attributeType>2</attributeType> <attributeId></attributeId> <operator>1</operator> <value>id_group</value> </rule> </or> <or> <rule> <attributeType>3</attributeType> <attributeId>JOB_TITLE</attributeId> <operator>1</operator> <value>Кассир</value> </rule> </or> </and> </rules> </updateSmartGroupRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://new.webservice.namespace"> <SOAP-ENV:Body> <updateSmartGroupResult> <success>true</success> </updateSmartGroupResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>