Skip to main content

GET - Детали точки по ID

Эндпоинт GET /locations/points/{id} используется для получения подробной информации о конкретной точке, идентифицируемой по её уникальному UUID.

Параметры​

ПараметрТипМестоположениеОписание
idstringПутьУникальный идентификатор точки (UUID).

Пример запроса​

URL:

GET /locations/points/497f6eca-6276-4993-bfeb-53cbbbba6f08

Пример успешного ответа​

Код ответа: 200 OK
Тело ответа:

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "locationId": "12a8af51-52f6-409b-82c2-08bbd5df18c2",
  "name": "P001",
  "type": "VIRTUAL",
  "latitude": null,
  "longitude": null,
  "graphicPlans": [],
  "rfidCode": null,
  "qrCode": null,
  "tags": [
    "tag1"
  ]
}

Описание полей ответа:​

  • id: Уникальный идентификатор точки.
  • locationId: Идентификатор связанной локации.
  • name: Имя точки.
  • type: Тип точки (например, VIRTUAL).
  • latitude / longitude: Географические координаты точки (если применимо).
  • graphicPlans: Список графических планов, связанных с точкой.
  • rfidCode / qrCode: RFID или QR код (если применимо).
  • tags: Теги, связанные с точкой.

Ошибки​

400 Неверные данные ввода​

Код ответа: 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]"
      ]
    }
  ]
}

Описание: Эта ошибка возникает, если параметр id не соответствует правильному формату UUID.

404 Ресурс не найден​

Код ответа: 404 Not Found
Тело ответа:

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Описание: Эта ошибка означает, что точка с указанным id не существует.

500 Внутренняя ошибка сервера​

Код ответа: 500 Internal Server Error
Тело ответа:

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Описание: Произошла неожиданная ошибка на сервере. Попробуйте повторить запрос позже или свяжитесь с поддержкой.

Резюме​

Эндпоинт GET /locations/points/{id} позволяет получить подробную информацию о конкретной точке по её уникальному UUID. Для успешного выполнения запроса:

  • Убедитесь, что параметр id соответствует правильному формату UUID.
  • Убедитесь, что указанная точка существует в системе.