GET api/2.0/people/simple/filter
Для этой функции требуется аутентификация.
Описание
Возвращает список пользователей, соответствующих параметрам, указанным в запросе.
Параметры
Название | Описание | Тип | Пример |
employeeStatus
sent in url
|
Статус пользователя
необязательно
|
ASC.Core.Users.EmployeeStatus | |
groupId
sent in url
|
Идентификатор группы
необязательно
|
guid | 9924256A-739C-462b-AF15-E652A3B1B6EB |
activationStatus
sent in url
|
Статус активации
необязательно
|
ASC.Core.Users.EmployeeActivationStatus | |
employeeType
sent in url
|
Тип пользователя
необязательно
|
ASC.Core.Users.EmployeeType | |
isAdministrator
sent in url
|
Указывает, является ли пользователь администратором или нет
необязательно
|
логический | true |
Пример
GET api/2.0/people/simple/filter Host: yourportal.r7-office.ru Content-Type: application/json Accept: application/json
Возвращает
Список пользователей
Пример ответа
application/json
{
"status": 0,
"response": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
}
]
}
text/xml
<result>
<status>0</status>
<response>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</response>
</result>