Метод: updateGroupMembers
Параметры запроса
Параметр | Тип | Описание |
---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
groupId (обязательный) | string | ID группы, пользователи которой будут заменены |
. |
userIds (обязательный) | string [] | Массив из ID пользователей, которые будут добавлены в группу |
.
Подсказка |
---|
Переданные с помощью метода пользователи полностью заменяют состав группы. То есть, переданный и пустой параметр userIds удалит всех пользователей из группы. Если переданы ID двух пользователей, все ранее включенные в группу пользователи удалятся, а два новых пользователя добавятся. Важно: если Администратор подразделения или Автор отправили список новых пользователей, которых надо добавить в группу, из существующих пользователей удалятся только те, которые входят в состав подразделений, которыми данный Администратор подразделения или Автор управляют, или их дочерних подразделений. |
...
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|
success | bool | True, если пользователи в группе были успешно заменены |
.Возможные ошибки
Тип | Описание |
---|
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>
<UpdateGroupMembersRequest>
<credentials>
<token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
</credentials>
<groupId>24d1abde-e063-11e9-b2cf-0a580af40a22</groupId>
<userIds>
<id>95385f4e-e031-11e9-a9da-0a580af40b0f</id>
<id>cfe9248a-deb4-11e9-979c-0a580af40764</id>
<id>d030ff3a-deb4-11e9-b26a-0a580af40764</id>
<id>d07ba5f8-deb4-11e9-a6de-0a580af40764</id>
<userIds>
</UpdateGroupMembersRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
...