• Post category:Поиск
  • Запись изменена:03.11.2022

GET api/2.0/people/filter

Для этой функции требуется аутентификация.

Описание
Возвращает список пользователей с полной информацией о них, соответствующих параметрам, указанным в запросе.

Параметры

НазваниеОписаниеТипПример
employeeStatus

sent in url
Статус пользователя

необязательно
ASC.Core.Users.EmployeeStatus
groupId

sent in url
ID группы

необязательно
guid9924256A-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/filter
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

Возвращает
Список пользователей с их информацией

Пример ответа

application/json

{
  "status": 0,
  "response": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "userName": "Mike.Zanyatski",
      "isVisitor": false,
      "firstName": "Mike",
      "lastName": "Zanyatski",
      "email": "my@domain.com",
      "birthday": "2022-10-12T08:51:51.7351988Z",
      "sex": "male",
      "status": 1,
      "activationStatus": 0,
      "terminated": null,
      "department": "Marketing",
      "workFrom": "2022-10-12T08:51:51.7351988Z",
      "location": "Palo Alto",
      "notes": "Notes to worker",
      "displayName": null,
      "title": "Manager",
      "contacts": [
        {
          "type": "GTalk",
          "value": "my@gmail.com"
        }
      ],
      "groups": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Group Name",
          "manager": "Jake.Zazhitski"
        }
      ],
      "avatarMedium": "url to medium avatar",
      "avatar": "url to big avatar",
      "isAdmin": false,
      "isLDAP": false,
      "listAdminModules": [
        "projects",
        "crm"
      ],
      "isOwner": false,
      "cultureName": "en-EN",
      "isSSO": false,
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>00000000-0000-0000-0000-000000000000</id>
    <userName>Mike.Zanyatski</userName>
    <isVisitor>false</isVisitor>
    <firstName>Mike</firstName>
    <lastName>Zanyatski</lastName>
    <email>my@domain.com</email>
    <birthday>2022-10-12T08:51:51.7351988Z</birthday>
    <sex>male</sex>
    <status>1</status>
    <activationStatus>0</activationStatus>
    <terminated />
    <department>Marketing</department>
    <workFrom>2022-10-12T08:51:51.7351988Z</workFrom>
    <location>Palo Alto</location>
    <notes>Notes to worker</notes>
    <displayName />
    <title>Manager</title>
    <contacts>
      <type>GTalk</type>
      <value>my@gmail.com</value>
    </contacts>
    <groups>
      <id>00000000-0000-0000-0000-000000000000</id>
      <name>Group Name</name>
      <manager>Jake.Zazhitski</manager>
    </groups>
    <avatarMedium>url to medium avatar</avatarMedium>
    <avatar>url to big avatar</avatar>
    <isAdmin>false</isAdmin>
    <isLDAP>false</isLDAP>
    <listAdminModules>projects</listAdminModules>
    <listAdminModules>crm</listAdminModules>
    <isOwner>false</isOwner>
    <cultureName>en-EN</cultureName>
    <isSSO>false</isSSO>
    <avatarSmall>url to small avatar</avatarSmall>
    <profileUrl></profileUrl>
  </response>
</result>