Вы можете создать новую смарт-группу с помощью метода addSmartGroup.
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют добавлять смарт-группы.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
name (обязательный) | string | Название новой группы. |
attributeType (обязательный) | Может принимать значения: | |
attributeId (необязательный) | Идентификатор поля профиля. Заполняется только для полей профиля (attributeType — 3). | |
operator (обязательный) | Для подразделений:
Для групп и полей профиля:
| |
value (обязательный) | Для подразделений:
Для групп:
Для поля профиля:
Внимание: для поля Страна нужно использовать ID страны, а не название. ID страны можно получить при помощи метода Получение списка полей профиля пользователя. |
Возвращаемые значения
После того, как запрос был успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
groupId | string | ID добавленной группы. |
Возможные ошибки
Тип | Описание |
---|---|
Permission denied | У пользователя недостаточно прав для добавления смарт-групп. |
Wrong parameters | Не удалось обработать запрос, т.к. он не включает все нужные параметры или они заданы неверно. |
Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap"> <soapenv:Header/> <soapenv:Body> <soap:AddSmartGroupRequest> <soap:credentials> <soap:accountUrl>https://acc-124.gray.local.learn.ispringdev.com</soap:accountUrl> <soap:email>owner</soap:email> <soap:password>12345Q</soap:password> </soap:credentials> <soap:name> NEW GROUP</soap:name> <soap:rules> <!--1 or more repetitions:--> <soap:and> <!--1 or more repetitions:--> <soap:or> <soap:rule> <soap:attributeType>1</soap:attributeType> <!--Optional:--> <soap:attributeId> </soap:attributeId> <soap:operator>2</soap:operator> <soap:value>id_departnent</soap:value> </soap:rule> </soap:or> <soap:or> <soap:rule> <soap:attributeType>2</soap:attributeType> <!--Optional:--> <soap:attributeId></soap:attributeId> <soap:operator>1</soap:operator> <soap:value>id_group</soap:value> </soap:rule> </soap:or> <soap:or> <soap:rule> <soap:attributeType>3</soap:attributeType> <!--Optional:--> <soap:attributeId>JON_TITLE</soap:attributeId> <soap:operator>1</soap:operator> <soap:value>кассир</soap:value> </soap:rule> </soap:or> </soap:and> </soap:rules> </soap:AddSmartGroupRequest> </soapenv:Body> </soapenv:Envelope>
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <AddSmartGroupResult> <groupId>string</groupId> </AddSmartGroupResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>