Вы можете обновить информацию в профиле пользователя с помощью метода updateUserProfile.
Заголовки запроса
| Параметр | Тип | Описание |
|---|
| credentials (required) | credentials | Смотрите описание объекта Credentials. |
| userId (required) | string | ID пользователя, чей профиль нужно обновить. |
| fields (required) | array | Массив объектов со следующими свойствами: name, value. |
| organizationId (optional) | int | Организация, в которую будет перемещен пользователь. |
| groups (optional) | string[] | Список ID групп, в которые будет добавлен пользователь. |
| Информация |
|---|
Если в аккаунте есть обязательные поля пользовательского профиля (за исключением полей со значениями типа 'Cписок' и 'Cтрана'), то их обязательно указывать в запросе. |
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
| Параметр | Тип | Описание |
|---|
| success | bool | True, если профиль пользователя был обновлен. |
Возможные ошибки
| Тип | Описание |
|---|
| Unknown User | Пользователь не найден. |
| Permission denied | У пользователя недостаточно прав для обновления данных пользователя. |
| WrongParameters | Один из указанных параметров задан неверно. |
| 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.ispringonline.ru</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<userId>4</userId>
<organizationId>1</organizationId>
<fields>
<field>
<name>first_name</name>
<value>John</value>
</field>
<field>
<name>email</name>
<value>john@gmail.com</value>
</field>
<field>
<name>last_name</name>
<value>Smith</value>
</field>
<field>
<name>phone</name>
<value>1233123</value>
</field>
<field>
<name>state</name>
<value>Texas</value>
</field>
<field>
<name>country_id</name>
<value>1</value>
</field>
<field>
<name>password</name>
<value>1234</value>
</field>
</fields>
<groups/>
</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> |