Список ролей

GET /core/roles

Описание

Этот эндпоинт возвращает список ролей, доступных в системе. Каждая роль содержит информацию о своём названии, весе, статусе активности и других атрибутах. Используется для управления доступами и настройками прав пользователей.

Параметры запроса

Обязательные параметры:

Нет

Вспомогательные параметры:

sortBy — параметр для сортировки по указанному полю.
sortOrder — порядок сортировки: ASC (по возрастанию) или DESC (по убыванию).
limit — ограничение на количество записей, возвращаемых в одном запросе.
page — номер страницы для постраничного вывода данных.

Пример:

GET /core/roles/?sortBy=name&sortOrder=ASC&limit=10&page=1

Ответ

Возвращается в формате JSON и содержит следующую структуру данных:

id — Уникальный идентификатор роли.
name — Название роли.
weight — Вес роли (используется для сортировки или определения приоритетов).
active — Статус активности роли (true / false).
canDelete — Указывает, можно ли удалить роль (true / false).
createdAt — Дата и время создания роли.
updatedAt — Дата и время последнего обновления роли.
canEdit — Указывает, можно ли редактировать роль (true / false).

pagination — Информация о пагинации данных:
- limit — Лимит элементов на странице.
- offset — Смещение от начала списка.
- currentTotal — Количество элементов на текущей странице.
- total — Общее количество ролей.
- page — Номер текущей страницы.

GET

/core/roles

При успешном запросе, ответ будет выглядеть так:

1{
2  "status": "success",
3  "payload": [
4    {
5      "id": 1,
6      "name": "Admin",
7      "weight": 100,
8      "active": true,
9      "canDelete": false,
10      "createdAt": "2024-10-23T13:03:15.000Z",
11      "updatedAt": "2024-11-23T14:17:03.000Z",
12      "canEdit": false
13    },
14    {
15      "id": 2,
16      "name": "User",
17      "weight": 50,
18      "active": true,
19      "canDelete": true,
20      "createdAt": "2024-10-24T11:00:00.000Z",
21      "updatedAt": "2024-11-23T15:30:00.000Z",
22      "canEdit": true
23    }
24  ],
25  "pagination": {
26    "limit": 10,
27    "offset": 0,
28    "currentTotal": 2,
29    "total": 7,
30    "page": 1
31  }
32}