| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия |
| product:api:list:getperson [15.07.2019 06:09] – ↷ Страница перемещена из product:api:getperson в product:api:list:getperson mayn | product:api:list:getperson [13.10.2024 06:56] (текущий) – [Возвращаемые параметры] ekaterina.menkhuzina |
|---|
| Метод: **GetPerson** | Метод: **GetPerson** |
| |
| | Пользователю, инициирующему сессию с ASPNETSessionId, не обязательно иметь лицензию «Администратор», достаточно обладать правом «Просмотр пользователей». |
| | |
| | Пользователь, инициирующий сессию с ASPNETSessionId для просмотра своего профиля, может это сделать без указанного выше права, в том числе параметры LicenseType и ExpireDate. |
| =====Передаваемые параметры===== | =====Передаваемые параметры===== |
| |
| |URL|Ссылка на пользователя| | |URL|Ссылка на пользователя| |
| |LinkToAD|Привязка пользователю к Active Directory| | |LinkToAD|Привязка пользователю к Active Directory| |
| | |LicenseType%%**%%|Тип лицензии. Возможные значения: Administrator (Администратор), Director (Директор), Supervisor (Руководитель), Executor (Исполнитель), Resource (Ресурс), NOT_SET (Не выбрано).| |
| | |ExpireDate%%**%%|Дата окончания действия учетной записи (в формате ГГГГ-ММ-ДД). Если учетная запись бессрочная, то возвращается «NOT_SET»| |
| | |PersonsGroupsWrapper%%*%%|Список с группами пользователей Системы, где состоит пользователь| |
| | |PersonsGroupId|Идентификатор группы| |
| | |questionsToEmail|''(с версии 3.27)'' Значение опции «Отправлять запросы на E-mail» карточки пользователя. \\ Доступные значения: \\ • **Always** – Всегда. \\ • **Never** – Никогда. \\ • **WhenOffline** – Только когда я не в системе | |
| | |messagesToEmail|''(с версии 3.27)'' Значение опции «Отправлять события на E-mail» карточки пользователя. \\ Доступные значения: \\ • **Always** – Всегда. \\ • **Never** – Никогда . \\• **WhenOffline** – Только когда я не в системе | |
| | |notifyToAltEmail|''(с версии 3.27)'' Значение опции «Дублировать на дополнительный E-mail» карточки пользователя. \\ Доступные значения: \\ • **True** – Да. \\ • **False** – Нет | |
| | |LinksToOpenIdConnect|''(с версии 3.29)'' Содержит в себе массив <OpenIdConnectPersonLink>, то есть массив идентификаторов пользователей в сервисе (NameIdentifier) и идентификаторы провайдера авторизации (AuthenticationType)| |
| | %%*%% -- в списке групп всегда отображается системная группа «Все пользователи». \\ |
| | %%**%% -- значения этих параметров возвращают только Администратору. \\ |
| |
| <code xml> | <code xml> |
| <URL>string</URL> | <URL>string</URL> |
| <LinkToAD>string</LinkToAD> | <LinkToAD>string</LinkToAD> |
| | <ChangedAt>dateTime</ChangedAt> |
| | <LicenseType>string</LicenseType> |
| | <ExpireDate>string</ExpireDate> |
| | <Groups xsi:nil="true" /> |
| | </SlPerson> |
| | <SlPerson> |
| | <UID>string</UID> |
| | <FullName>string</FullName> |
| | <EMail>string</EMail> |
| | <URL>string</URL> |
| | <LinkToAD>string</LinkToAD> |
| | <ChangedAt>dateTime</ChangedAt> |
| | <LicenseType>string</LicenseType> |
| | <ExpireDate>string</ExpireDate> |
| | <Groups xsi:nil="true" /> |
| </SlPerson> | </SlPerson> |
| </Persons> | </Persons> |
| </soap:Body> | </soap:Body> |
| </soap:Envelope> | </soap:Envelope> |
| | </code> |
| | |
| | Пример запроса с добавленным в ''версии системы 3.29'' параметром ''LinksToOpenIdConnect'': |
| | |
| | <code xml> |
| | <?xml version="1.0" encoding="utf-8"?> |
| | <PersonQueryResult xmlns="http://streamline/"> |
| | <Persons> |
| | <SlPerson> |
| | <UID>string</UID> |
| | <FullName>string</FullName> |
| | <EMail>string</EMail> |
| | <URL>string</URL> |
| | <LinkToAD>string</LinkToAD> |
| | <LinksToOpenIdConnect> |
| | <OpenIdConnectPersonLink d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | <OpenIdConnectPersonLink d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | </LinksToOpenIdConnect> |
| | <ChangedAt>dateTime</ChangedAt> |
| | <LicenseType>string</LicenseType> |
| | <ExpireDate>string</ExpireDate> |
| | <QuestionsToEmail>string</QuestionsToEmail> |
| | <MessagesToEmail>string</MessagesToEmail> |
| | <NotifyToAltEmail>string</NotifyToAltEmail> |
| | <Groups> |
| | <GroupWrapper d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | <GroupWrapper d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | </Groups> |
| | </SlPerson> |
| | <SlPerson> |
| | <UID>string</UID> |
| | <FullName>string</FullName> |
| | <EMail>string</EMail> |
| | <URL>string</URL> |
| | <LinkToAD>string</LinkToAD> |
| | <LinksToOpenIdConnect> |
| | <OpenIdConnectPersonLink d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | <OpenIdConnectPersonLink d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | </LinksToOpenIdConnect> |
| | <ChangedAt>dateTime</ChangedAt> |
| | <LicenseType>string</LicenseType> |
| | <ExpireDate>string</ExpireDate> |
| | <QuestionsToEmail>string</QuestionsToEmail> |
| | <MessagesToEmail>string</MessagesToEmail> |
| | <NotifyToAltEmail>string</NotifyToAltEmail> |
| | <Groups> |
| | <GroupWrapper d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | <GroupWrapper d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> |
| | </Groups> |
| | </SlPerson> |
| | </Persons> |
| | </PersonQueryResult> |
| </code> | </code> |