Метод: getUserProfile
При запросе getUserProfile вы получите одинаковый статус для уволенных и заблокированных — 3.
Чтобы различать статусы сотрудников, используйте запрос getUserProfileV2. Так, в параметре status заблокированные сотрудники будут обозначаться статусом 3, уволенные — 5.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
userId (обязательный) | string | ID пользователя, информацию о котором вы хотите получить |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут получать информацию о пользователях только своего подразделения и вложенных в него подразделений.
Возвращаемые значения
После успешной обработки запроса система возвращает массив данных со следующими свойствами:
Параметр | Тип | Описание | |
---|---|---|---|
userId | string | ID пользователя | |
status | int | Статус пользователя: 1 — активный, 3 — неактивный, 5 — уволенный | |
departmentId | string | Подразделение, в котором состоит пользователь | |
string | Email пользователя | ||
groups | string[] | ID групп, в которых состоит пользователь | |
fields | string[][2] | Поля профиля пользователя (UserFields) — массив объектов со следующими свойствами: Id, value | |
addedDate | date | Дата добавления пользователя | |
lastLoginDate | date | Дата последнего входа пользователя в аккаунт | |
manageableDepartmentIds | string[] | ID подразделений, которыми управляет пользователь, если его роль — администратор подразделения или автор | |
role | string | Роль пользователя | |
subordination (необязательный) | array | Объект с данными о типе подчинения линейного руководителя | |
coSubordination (необязательный) | array | Объект с данными о типе подчинения функционального руководителя | |
subordinationType (обязательный) | string | Тип подчинения линейного и функционального руководителя. Возможные значения:
| |
supervisorId (необязательный) | string | ID руководителя | Указываете, если subordinationType = manual |
- | Если subordinationType = inherit, no_supervisor, указывать не нужно |
Возможные ошибки
Ошибки | Описание |
---|---|
Unknown user | Пользователь с указанным ID не найден |
Permission denied | У пользователя недостаточно прав для получения информации |
Пример запроса
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <GetUserProfileRequest> <credentials> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <userId>string</userId> </GetUserProfileRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ns1:GetUserProfileResult> <ns1:userProfile> <ns1:userId>string</ns1:userId> <ns1:fields> <ns1:field> <ns1:Id>FIRST_NAME</ns1:Id> <ns1:value>Елена</ns1:value> </ns1:field> <ns1:field> <ns1:Id>LAST_NAME</ns1:Id> <ns1:value>Иванова</ns1:value> </ns1:field> <ns1:field> <ns1:Id>EMAIL</ns1:Id> <ns1:value>elena@ispring.ru</ns1:value> </ns1:field> <ns1:field> <ns1:Id>JOB_TITLE</ns1:Id> <ns1:value>Менеджер по продажам</ns1:value> </ns1:field> <ns1:field> <ns1:Id>COUNTRY</ns1:Id> <ns1:value>5</ns1:value> </ns1:field> <ns1:field> <ns1:Id>USER_DEFINED_FIELD3</ns1:Id> <ns1:value>Высшее</ns1:value> </ns1:field> <ns1:groups> <ns1:id>string</ns1:id> <ns1:id>string</ns1:id> </ns1:groups> <ns1:status>1</ns1:status> <ns1:role>department_administrator</ns1:role> <ns1:departmentId>string</ns1:departmentId> <ns1:addedDate>2019-03-26</ns1:addedDate> <ns1:lastLoginDate>2019-04-06</ns1:lastLoginDate> <ns1:manageableDepartmentIds> <ns1:id>string</ns1:id> <ns1:id>string</ns1:id> </ns1:manageableDepartmentIds> <ns1:userRoles> <ns1:userRole> <ns1:roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</ns1:roleId> <ns1:roleType>department_administrator</ns1:roleType> <ns1:manageableDepartmentIds> <ns1:id>f9de0c52-6f59-11ea-b88f-cee299842653</ns1:id> <ns1:id>f9d9f306-6f59-11ea-ad9a-cee299842653</ns1:id> </ns1:manageableDepartmentIds> </ns1:userRole> </ns1:userRoles> </ns1:userProfile> </ns1:GetUserProfileResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>