Метод: updateUserProfile
Параметры запроса
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
userId (обязательный) | string | ID пользователя, чей профиль нужно обновить. |
email (необязательный) | string | Email пользователя, профиль которого вы изменяете. |
password (необязательный) | string | Пароль пользователя, профиль которого вы изменяете. |
login (обязательный) | string | Логин нового пользователя. |
departmentId (обязательный) | string | Подразделение, в которое будет перемещен пользователь. |
role (обязательный) | string | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений: - learner
- department_administrator
- administrator
Если вы назначаете пользователю одну из ролей с индивидуальными настройками, присвойте параметру role значение custom. |
roleId (обязательный, если роль пользователя — publisher или роль с индивидуальными настройками) | string | Параметр roleId используется, если вы назначаете пользователю одну из ролей с индивидуальными настройками или роль Автора. |
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками. |
groups (необязательный) | string[] | Список ID групп, в которые будет добавлен пользователь. |
Информация |
---|
Если в аккаунте есть обязательные поля пользовательского профиля (за исключением полей типа 'Cтрана'), их обязательно нужно указать в запросе. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут изменить профиль пользователя только своего подразделения и вложенных в него подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|
success | bool | True, если профиль пользователя был обновлен. |
Возможные ошибки
Тип | Описание |
---|
Unknown User | Пользователь не найден. |
Permission denied | У пользователя недостаточно прав для обновления данных пользователя. |
Wrong Parameters | Один из указанных параметров задан неверно. |
Invalid value <field_value>. Field <field_name> must be unique. | Ошибка в случае редактирования user_field, которое должно быть уникальным (например, login/email). |
Пример запроса
Блок кода |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://new.webservice.namespace">
<SOAP-ENV:Body>
<UpdateUserProfileRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.ru</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<userId>string</userId>
<fields>
<field>
<name>LOGIN</name>
<value>eivanova@ispring.ru</value>
</field>
<field>
<name>PASSWORD</name>
<value>123456</value>
</field>
<field>
<name>EMAIL</name>
<value>eivanova@ispring.ru</value>
</field>
<field>
<name>FIRST_NAME</name>
<value>Екатерина</value>
</field>
<field>
<name>LAST_NAME</name>
<value>Иванова</value>
</field>
<field>
<name>COUNTRY</name>
<value>1</value>
</field>
</fields>
<groups>
<id>string</id>
<id>string</id>
</groups>
<role>department_administrator</role>
<departmentId>string</departmentId>
<manageableDepartmentIds>
<id>string</id>
<id>string</id>
</manageableDepartmentIds>
<roles>
<userRole>
<roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</soap:roleId>
</userRole>
<userRole>
<roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId>
<manageableDepartmentIds>
<id>8da0a5a4-b2a3-11e9-b20c-0a580af402f4</id>
</manageableDepartmentIds>
</userRole>
</roles>
</UpdateUserProfileRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
Пример ответа
Блок кода |
---|
|
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://new.webservice.namespace">
<SOAP-ENV:Body>
<UpdateUserProfileResult>
<success>true</success>
</UpdateUserProfileResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |