Методы

  • GET — Получение списка пользователей
  • POST — Получение списка пользователей

Ресурс

{
    "error": "string",
    "result": {
        "result": [
            {
                "__createdAt": "date-time",
                "__createdBy": "uuid",
                "__deletedAt": "date-time",
                "__id": "uuid",
                "__name": "string",
                "__updatedAt": "date-time",
                "__updatedBy": "uuid",
                "additionalData": "string",
                "avatar": [
                    "uuid"
                ],
                "birthDate": "date-time",
                "displayedPosition": "string",
                "email": "string",
                "fullname": {
                    "firstname": "string",
                    "lastname": "string",
                    "middlename": "string"
                },
                "groupIds": [
                    "uuid"
                ],
                "hireDate": "date-time",
                "login": "string",
                "mobilePhone": [
                    {
                        "context": "string",
                        "ext": "string",
                        "tel": "string",
                        "type": "string"
                    }
                ],
                "osIds": [
                    "uuid"
                ],
                "owner": "boolean",
                "timezone": "string",
                "workPhone": [
                    {
                        "context": "string",
                        "ext": "string",
                        "tel": "string",
                        "type": "string"
                    }
                ]
            }
        ],
        "total": "int64"
    },
    "success": "boolean"
}

Свойства

Имя Тип Описание Дополнительно
error string

Текст ошибки, если success == false

Опциональное
result object Опциональное
result.result[] array

Найденные элементы

Опциональное
result.result[].__createdAt date-time

Дата создания элемента

Опциональное
result.result[].__createdBy uuid

Уникальный идентификатор пользователя, который создал текущий элемент

Опциональное
result.result[].__deletedAt date-time

Дата удаления элемента

Опциональное
result.result[].__id uuid

Уникальный идентификатор

Опциональное
result.result[].__name string

Имя

Опциональное
result.result[].__updatedAt date-time

Дата последнего изменения данных

Опциональное
result.result[].__updatedBy uuid

Уникальный идентификатор пользователя, который внес изменения в текущий элемент

Опциональное
result.result[].additionalData string

Дополнительные данные

Опциональное
result.result[].avatar[] array of uuid

Список уникальных идентификаторов файлов аватаров пользователя

Опциональное
result.result[].birthDate date-time

Дата рождения

Опциональное
result.result[].displayedPosition string

Отображаемая должность

Опциональное
result.result[].email string

Электронная почта

Опциональное
result.result[].fullname object

Информация о полном имени

Опциональное
result.result[].fullname.firstname string

Имя

Опциональное
result.result[].fullname.lastname string

Фамилия

Опциональное
result.result[].fullname.middlename string

Отчество

Опциональное
result.result[].groupIds[] array of uuid

Уникальные идентификаторы групп, в которых состоит пользователь

Опциональное
result.result[].hireDate date-time

Дата приема на работу

Опциональное
result.result[].login string

Логин

Опциональное
result.result[].mobilePhone[] array

Информация о номерах телефонов

Опциональное
result.result[].mobilePhone[].context string

Глобальная часть, например код страны или домен (для SIP)

Опциональное
result.result[].mobilePhone[].ext string

Добавочный номер

Опциональное
result.result[].mobilePhone[].tel string

Локальная часть, действует в пределах страны

Опциональное
result.result[].mobilePhone[].type string

Тип номера (например домашний или мобильный)

Опциональное
result.result[].osIds[] array of uuid

Уникальные идентификаторы занимаемых должностей

Опциональное
result.result[].owner boolean

Признак владельца компании

Опциональное
result.result[].timezone string

Временная зона

Опциональное
result.result[].workPhone[] array

Информация о номерах телефонов

Опциональное
result.result[].workPhone[].context string

Глобальная часть, например код страны или домен (для SIP)

Опциональное
result.result[].workPhone[].ext string

Добавочный номер

Опциональное
result.result[].workPhone[].tel string

Локальная часть, действует в пределах страны

Опциональное
result.result[].workPhone[].type string

Тип номера (например домашний или мобильный)

Опциональное
result.total int64

Всего элементов

Опциональное
success boolean

Признак успешного запроса

Опциональное