Список разделов страниц

GET /core/pages/sections

Описание

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

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

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

Нет

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

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

Пример:

Ответ

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

• id — Уникальный идентификатор раздела.
• name — Название раздела.
• url — URL раздела.
• description — Описание раздела.
• active — Статус активности раздела (true / false).
• sort — Сортировка.
• parentId — Идентификатор родительского раздела, если есть.
• hits — Количество просмотров раздела.
• createdAt — Дата и время создания раздела.
• updatedAt — Дата и время последнего обновления раздела.

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

1{
2  "status": "success",
3  "payload": [
4    {
5      "id": 5,
6      "name": "TestSection",
7      "url": "test_section",
8      "description": "Описание раздела",
9      "active": true,
10      "sort": 500,
11      "parentId": null,
12      "hits": 10,
13      "createdAt": "2024-11-12T11:42:44.000Z",
14      "updatedAt": "2024-11-12T11:42:44.000Z",
15      "items": []
16    },
17    {
18      "id": 4,
19      "name": "TestSection2",
20      "url": "test_section2",
21      "description": null,
22      "active": false,
23      "sort": 500,
24      "parentId": null,
25      "hits": 5,
26      "createdAt": "2024-11-11T17:57:32.000Z",
27      "updatedAt": "2024-11-11T17:57:32.000Z",
28      "items": [
29        {
30          "id": 366,
31          "name": "TestPage",
32          "active": false
33        }
34      ]
35    }
36  ],
37  "pagination": {
38    "limit": 20,
39    "offset": 0,
40    "currentTotal": 2,
41    "total": 2,
42    "page": 0
43  }
44}

Интерфейс

1interface IPagesSection {
2  id: number;
3  name: string;
4  description: string;
5  url: string;
6  hits: number;
7  parentId ? : number;
8  sort: number;
9  active: boolean;
10}