Вы можете обновить информацию в профиле пользователя с помощью метода updateUserProfile.
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор, Администратор подразделения.
Администратор подразделения может изменить профиль пользователя только своего подразделения и вложенных в него подразделений.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
userId (обязательный) | string | ID пользователя, чей профиль нужно обновить. |
email (необязательный) | string | Email пользователя, профиль которого вы изменяете. |
password (необязательный) | string | Пароль пользователя, профиль которого вы изменяете. |
login (обязательный) | string | Логин нового пользователя. |
departmentId (обязательный) | string | Подразделение, в которое будет перемещен пользователь. |
role (обязательный) | string | Роль пользователя, профиль которого вы изменяете. |
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>john@gmail.com</value> </field> <field> <name>PASSWORD</name> <value>1234</value> </field> <field> <name>EMAIL</name> <value>john@gmail.com</value> </field> <field> <name>FIRST_NAME</name> <value>John</value> </field> <field> <name>LAST_NAME</name> <value>Smith</value> </field> <field> <name>COUNTRY</name> <value>1</value> </field> </fields> <groups> <id>string</id> <id>string</id> </groups> <role>publisher</role> <departmentId>string</departmentId> <manageableDepartmentIds> <id>string</id> <id>string</id> </manageableDepartmentIds> </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>