Статті на: Документація з API

QUINCE API. Відповідальні (Користувачі)

Список методів



/user/listОтримання списку користувачів


Отримання списку користувачів



Назва методу: /user/list

Повертає список відповідальних (користувачів). Для навігації використовується номер сторінки (page).
Розмір сторінки фіксований і дорівнює 100 елементам.

Параметри запиту:



filter Тип: object (необов'язковий)Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
Id - ідентифікатор користувача. Необов'язковий параметр
Archive - Ознака того, що треба повертати архівні елементи
page Тип: integer (необов'язковий)Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.


Результат запиту:



Якщо в запиті фільтр відсутній, то повертається список користувачів у порядку зростання Id.

Поля користувачів , що повертаються методом:

IdІдентифікатор користувача
LoginЛогін користувача (string)
NameНазва користувача (string)


Приклад:



Запит:

{

     "filter": {
        "Id": 213
    },
    "page": 1
}


Результат:

{

    "success": true,
    "data": [
        {
            "Id": 213,
            "Login": "user2@user.com",
            "Name": "Localhost Admin"
        }
    ]
}

Оновлено: 06/06/2024

Чи була ця стаття корисною?

Поділіться своїм відгуком

Скасувати

Дякуємо!