Документация по iSpring Learn

Дерево страниц

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Метод: addSmartGroup

Параметры запроса

ПараметрТипОписание
token (обязательный)stringТокен доступа. Вы можете получить токен с помощью запроса
name (обязательный)stringНазвание новой смарт-группы
rules (необязательный)arrayСписок правил смарт-группы
attributeType (обязательный)int

Может принимать значения:

  • 1 - подразделение,

  • 2 - группа,

  • 3 - поля профиля

attributeId (необязательный)stringИдентификатор поля профиля. Заполняется только для полей профиля (attributeType — 3)
operator (обязательный)int

Для подразделений:

  • 1 - одно подразделение без его дочерних подразделений,
  • 2 - подразделение и все его дочерние подразделения.

Для групп и полей профиля:

  • всегда 1
value (обязательный)string

Для подразделений:

  • ID подразделения.

Для групп:

  • ID группы.

Для поля профиля:

  • значение поля профиля (например, для поля Фамилия значение — Соколов).

Внимание: для поля Страна нужно использовать ID страны, а не название. ID страны можно получить при помощи метода Получение списка полей профиля пользователя

Вы можете добавить несколько групп условий для добавления пользователей в смарт-группу. Они будут работать по принципу «И», то есть должны будут сработать одновременно.

Внутри этих групп создайте любое число правил. Они, напротив, работают по принципу «ИЛИ», то есть достаточно выполнения одного из правил.

Подробнее о смарт-группах и их условиях читайте в статье Смарт-группы.

Права пользователя для выполнения запроса

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

Возвращаемые значения

После того, как запрос был успешно обработан, система отправляет объект со следующими свойствами:

Параметр

Тип

Описание

groupId

string

ID добавленной смарт-группы

Возможные ошибки

ТипОписание
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>
      <AddSmartGroupRequest>
       <credentials>
          <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
        </credentials>
        <name> NEW GROUP</name>
        <rules>
            <and>
                <or>
                  <rule>
                    <attributeType>1<attributeType>
                    <attributeId> </attributeId>
                    <operator>2</operator>
                    <value>id_departnent</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>JON_TITLE</attributeId>
                    <operator>1</operator>
                    <value>кассир</value>
                  </rule>
                </or>
              </and>
            </rules>
      </AddSmartGroupRequest>
 </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://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <AddSmartGroupResult>
      <groupId>string</groupId>
    </AddSmartGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>