Данные пользователя

GET /core/users/:id

Описание

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

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

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

  • id — уникальный идентификатор пользователя (например, 1).

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

Нет

Пример:
GET /core/users/101

Ответ

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

  • id — Уникальный идентификатор пользователя.
  • name — Имя пользователя.
  • surname — Фамилия пользователя.
  • email — Email-адрес пользователя.
  • image — URL аватара пользователя.
  • active — Статус активности пользователя (true / false).
  • roleId — Идентификатор роли пользователя.
  • role — Данные о роли пользователя (включая id и name).
  • createdAt — Дата и время создания пользователя.
  • updatedAt — Дата и время последнего обновления данных.
GET
/core/users/101

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

1{
2  "status": "success",
3  "payload": {
4    "id": 101,
5    "name": "Иван",
6    "surname": "Иванов",
7    "image": "/images/avatar.jpg",
8    "email": "ivanov@example.com",
9    "active": true,
10    "roleId": 3,
11    "createdAt": "2024-11-23T09:15:00.000Z",
12    "updatedAt": "2024-11-23T09:15:00.000Z",
13    "role": {
14      "id": 3,
15      "name": "Менеджер"
16    },
17    "canEdit": true
18  }
19}