Включить страницу | ||||
---|---|---|---|---|
|
Метод: updateUserProfile
Параметры
Вы можете обновить информацию в профиле пользователя с помощью метода updateUserProfile.
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор, Администратор подразделения.
Администратор подразделения может изменить профиль пользователя только своего подразделения и вложенных в него подразделений.
...
запроса
Параметр | Тип | Описание |
---|
token (обязательный) |
string | Токен доступа. Вы можете получить токен с помощью запроса | |
userId (обязательный) | string | ID пользователя, чей профиль нужно обновить |
email (необязательный) | string | Email пользователя, профиль которого вы изменяете |
password (необязательный) | string | Пароль пользователя, профиль которого вы изменяете |
login (обязательный) | string | Логин нового пользователя |
departmentId (обязательный) | string | Подразделение, в которое будет перемещен пользователь |
role (необязательный) | string | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений:
Если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками, присвойте параметру role значение custom. Узнайте больше об использовании параметра role в разделе Важно |
roleId (обязательный, если в параметре role указано значение custom) | string | Параметр roleId используется, если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками. В этом случае присвойте параметру roleId ID нужной роли. Узнайте больше об использовании параметра roleId в разделе Важно |
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками |
groups (необязательный) | string[] | Список ID групп, в которые будет добавлен пользователь. |
roles (необязательный) | string[] | Массив данных, с помощью которого вы можете назначить пользователю роли. Присвойте параметру roleId внутри массива ID нужной роли. Если вы назначаете две роли, одна из них — Обучающийся, а вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками). Узнайте больше об использовании параметра roles в разделе Важно |
about_me (необязательный) | string | Информация о пользователе в поле «О себе» |
Информация | ||||||
---|---|---|---|---|---|---|
|
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут изменить профиль пользователя только своего подразделения и вложенных в него подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если профиль пользователя был обновлен. |
Возможные ошибки
Тип | Описание |
---|---|
Unknown User | Пользователь не найден. |
Permission denied | У пользователя недостаточно прав для обновления данных пользователя. |
WrongParametersWrong 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="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns="httphttps://new.webservice.namespace"> <SOAP-ENV:Body> <UpdateUserProfileRequest> <credentials> <accountUrl>http://myaccount.ispringlearn.ru</accountUrl> <email>email@email.com</email> <password>password</password><token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <userId>string</userId> <fields> <field> <name>LOGIN</name> <value>john@gmail<value>eivanova@ispring.com<ru</value> </field> <field> <name>PASSWORD</name> <value>1234<<value>123456</value> </field> <field> <name>EMAIL</name> <value>john@gmail<value>eivanova@ispring.com<ru</value> </field> <field> <name>FIRST_NAME</name> <value>John<<value>Екатерина</value> </field> <field> <name>LAST_NAME</name> <value>Smith<<value>Иванова</value> </field> <field> <name>COUNTRY</name> <value>1</value> </field> </fields> <groups> <id>string</id> <id>string</id> </groups> <role>publisher<<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> <about_me>Помогаю новичкам стартовать в продажах и быстро входить в ритм.</about_me> </UpdateUserProfileRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Пример ответа
Блок кода | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns="httphttps://new.webservice.namespace"> <SOAP-ENV:Body> <UpdateUserProfileResult> <success>true</success> </UpdateUserProfileResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...