Skip to main content

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

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

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

Если локация существует, а запрос корректен, сервер ответит с кодом состояния 200 OK и вернёт данные о локации.

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

Код ответа: 200 OK
Тип содержимого: application/json

{
  "id": "638b90c5-7965-49ae-a02b-1b190cb216db",
  "name": "W001",
  "address": "Walmart 11,197",
  "latitude": 51.0966229,
  "longitude": -138.491986,
  "tags": [
    "tag1"
  ],
  "graphicPlanIds": [
    "3a1da1c9-0873-4bdc-b1f1-7343b29fdc27",
    "14b8ec6b-8ee2-4533-aedd-b82691f19af2"
  ]
}

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

  • id: Уникальный идентификатор локации.
  • name: Название локации (например, "W001").
  • address: Адрес локации (например, "Walmart 11,197").
  • latitude: Географическая широта локации (например, 51.0966229).
  • longitude: Географическая долгота локации (например, -138.491986).
  • tags: Список тегов, ассоциированных с локацией (например, ["tag1"]).
  • graphicPlanIds: Массив ID графических планов, связанных с локацией.

Ошибки​

400 Неверные данные запроса​

Если переданный id в запросе имеет неверный формат (например, неправильно отформатированный UUID), сервер вернёт код состояния 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: Предоставленный ID имеет неверный формат. Убедитесь, что идентификатор является действительным UUID.

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

Если локация с указанным id не существует в базе данных, сервер вернёт код состояния 404 Not Found.

Тело ответа:​

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

Пояснение:​

  • Локация с указанным id не найдена. Проверьте правильность id и убедитесь, что он соответствует существующей локации.

500 Ошибка на сервере​

В случае непредвиденной ошибки на сервере вернётся код состояния 500 Internal Server Error.

Тело ответа:​

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

Пояснение:​

  • Эта ошибка указывает на проблему на стороне сервера. Ошибка может быть временной, и повторный запрос или обращение в поддержку могут помочь.

Резюме​

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