Получение информации о пользователе

Вы можете получить информацию о пользователе с помощью метода getUserProfile.

Права пользователя для выполнения запроса: владелец аккаунта, администратор, администратор организации.

Параметры

Параметр	Тип	Описание
credentials (required)	credentials	Смотрите описание объекта Credentials.
userId (required)	string	ID пользователя, информацию о котором вы хотите получить.

Возвращаемые значения

После успешной обработки запроса система возвращает массив данных со следующими свойствами:

Параметр	Тип	Описание
userId	string	ID указанного пользователя.
status	int	Статус пользователя: 1 - активный, 2 - удален, 3 - неактивный.
organizationId	int	Организация, в которой состоит пользователь.
deactivationDate	date	Дата деактивации пользователя.
email	string	Email пользователя.
groups	string[]	ID групп, в которых состоит пользователь.
fields	string[][2]	Поля профиля пользователя (UserFields) - массив объектов со следующими свойствами: Id, value.

Возможные ошибки

Ошибки	Описание
Unknown user	Пользователь с указанным ID не найден
Permission denied	У пользователя недостаточно прав для получения информации о пользователе.

Пример запроса

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetUserProfileRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringonline.ru</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
      <userId>1</userId>
    </GetUserProfileRequest>
  </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:ns1="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <ns1:GetUserProfileResult>
      <ns1:userProfile>
        <ns1:userId>1</ns1:userId>
        <ns1:fields>
          <ns1:field>
            <ns1:Id>login</ns1:Id>
            <ns1:value>test</ns1:value>
          </ns1:field>
          <ns1:field>
            <ns1:Id>first_name</ns1:Id>
            <ns1:value/>
          </ns1:field>
          <ns1:field>
            <ns1:Id>last_name</ns1:Id>
            <ns1:value/>
          </ns1:field>
          <ns1:field>
            <ns1:Id>email</ns1:Id>
            <ns1:value>test@test.test</ns1:value>
          </ns1:field>
          <ns1:field>
            <ns1:Id>country_id</ns1:Id>
            <ns1:value/>
          </ns1:field>
          <ns1:field>
            <ns1:Id>customfield</ns1:Id>
            <ns1:value/>
          </ns1:field>
        <ns1:status>1</ns1:status>
        <ns1:organizationId>1</ns1:organizationId>
      </ns1:userProfile>
    </ns1:GetUserProfileResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Дерево страниц