Skip to main content

PUT - Обновление точки

Метод PUT /locations/points/{id} обновляет данные о конкретной точке, идентифицируемой по уникальному UUID.


Тело запроса

ПолеТипОбязательноОписание
locationIdstring (UUID)ДаУникальный идентификатор местоположения.
namestringДаНазвание точки.
typestringДаТип точки (например, VIRTUAL).
latitudefloat/nullНетШирота точки.
longitudefloat/nullНетДолгота точки.
graphicPlansarrayНетСписок связанных графических планов.
rfidCodestring/nullНетRFID-код точки.
qrCodestring/nullНетQR-код точки.
tagsarrayНетСписок тегов, связанных с точкой.

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

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

Тело запроса:

{
"locationId": "12a8af51-52f6-409b-82c2-08bbd5df18c2",
"name": "P002",
"type": "VIRTUAL",
"latitude": null,
"longitude": null,
"graphicPlans": [],
"rfidCode": null,
"qrCode": null,
"tags": ["tag1"]
}

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

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

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

Возможные ошибки

400 Ошибка валидации

Код ответа: 400 Bad Request
Тело ответа:

{
"message": "validation failed",
"code": "validation.failed",
"timestamp": "2023-03-07T05:57:59.315Z",
"details": [
{
"message": "must not be null",
"code": "validation.notnull.failed",
"identifier": "type"
}
]
}

Описание: Возникает, если обязательные поля отсутствуют, имеют значение null или содержат некорректные данные.


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

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

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

Описание: Ресурс с указанным id не найден.


406 Несоответствие типа контента

Код ответа: 406 Not Acceptable
Тело ответа:

{
"message": "mismatch in the types of content",
"code": "not.acceptable",
"timestamp": "2023-03-07T05:57:59.315Z"
}

Описание: Формат содержимого запроса не соответствует ожидаемому.


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

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

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

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


Итог

Метод PUT /locations/points/{id} позволяет обновлять существующую точку, передавая ее уникальный id и корректные данные в теле запроса.

Советы для успешного использования:

  1. Проверяйте входные данные: Убедитесь, что все обязательные поля присутствуют и корректно заполнены.
  2. Проверяйте ID: Убедитесь, что параметр id соответствует существующей точке.
  3. Соответствие формату: Убедитесь, что заголовок Content-Type установлен правильно.