Skip to main content

PATCH - Частичное обновление точки

Метод PATCH /locations/points/{id} используется для частичного обновления данных точки, идентифицируемой уникальным ID.

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

Поля​

ПолеТипОбязательноеОписание
namestringНетНазвание точки.

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

{
  "name": "P002"
}

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

Код ответа​

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": "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]"
      ]
    }
  ]
}

Описание​

Предоставленные данные не соответствуют ожидаемому формату (например, неверный тип данных или отсутствуют обязательные параметры).

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"
}

Описание​

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

Резюме​

Метод PATCH /locations/points/{id} позволяет обновить определённые данные точки, например, её название. Убедитесь, что ID соответствует существующему ресурсу, а предоставленные данные имеют правильный формат, чтобы избежать ошибок.