Skip to main content

GET - Детали пользователя по ID

Эндпоинт: GET /users/{id}
Этот эндпоинт позволяет получить подробную информацию о пользователе, идентифицированном по уникальному ID.

Авторизация​

Этот эндпоинт требует Bearer Token в заголовке Authorization.
Формат:

Authorization: Bearer <token>

Параметры пути​

НазваниеТипОписаниеПример
idStringУникальный идентификатор пользователя.be63c536-6cf3-4866-8970-37a956e3f403

Успешный ответ​

Код состояния: 200 OK
Тело ответа:

{
  "id": "be63c536-6cf3-4866-8970-37a956e3f403",
  "firstName": "John",
  "middleName": "Lee",
  "lastName": "Fox",
  "employeeNo": "1234",
  "employeePin": "4321",
  "email": "[email protected]",
  "phone": "80291110099",
  "language": "en",
  "role": "ADMIN",
  "status": "ACTIVE",
  "photoId": "a7c6f740-2a42-449c-a03b-b8d36aa4709a",
  "locationIds": [
    "99b770c0-2396-43d3-b109-85a9d73df7b1",
    "e1dfeaba-4318-4411-be91-f8af5214dd02"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "userLinked": true
}

Ошибки​

  1. Неверные входные данные

    • Код состояния: 400 Bad Request
    • Описание: Предоставленные данные не соответствуют требуемому формату или типу.
    • Пример ответа: 
      {
        "message": "invalid input data",
        "code": "input.data.invalid",
        "timestamp": "2023-03-07T05:57:59.315Z",
        "details": [
          {
            "message": "invalid data type",
            "code": "data.type.invalid",
            "identifier": "id",
            "args": [
              "[UUID]"
            ]
          }
        ]
      }

  2. Ресурс не найден

    • Код состояния: 404 Not Found
    • Описание: Пользователь с указанным ID не существует.
    • Пример ответа: 
      {
        "message": "resource wasn't found",
        "code": "not.found",
        "timestamp": "2023-03-07T05:57:59.315Z"
      }

  3. Внутренняя ошибка сервера

    • Код состояния: 500 Internal Server Error
    • Описание: Произошла ошибка на стороне сервера при обработке запроса.
    • Пример ответа: 
      {
        "message": "internal server error",
        "code": "internal.server.error",
        "timestamp": "2023-03-07T05:57:59.315Z"
      }

Примечания​

  • Убедитесь, что параметр ID находится в формате UUID.
  • Токен Authorization должен быть действительным и активным.
  • Для устранения проблем используйте сообщение об ошибке и код, возвращённые в ответе.