Метод: addGroup
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
name (обязательный) | string | Название новой группы. |
userId (необязательный) | string | 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> <AddGroupRequest> <credentials> <accountUrl>https://myaccount.ispringlearn.ru</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> <name>NEW_GROUP</name> <userIds> <id>cfe9248a-deb4-11e9-979c-0a580af40764</id> <id>d030ff3a-deb4-11e9-b26a-0a580af40764</id> <id>d07ba5f8-deb4-11e9-a6de-0a580af40764</id> </userIds> </AddGroupRequest> </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> <AddGroupResult> <groupId>string</groupId> </AddGroupResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>