Skip to main content

POST - Создание новой точки

Метод POST /locations/points используется для создания новой точки в системе для указанного местоположения.

Детали запроса​

HTTP-метод: POST
Эндпоинт: /locations/points
Content-Type: application/json

Формат тела запроса:​

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

Параметры запроса:​

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

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

Код ответа: 201 Created
Тело ответа:

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

Описание: Ошибка возникает, если отсутствует обязательное поле или оно содержит некорректные данные (например, отсутствует поле type).

406 Неприемлемый запрос - несоответствие типа контента​

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

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

Описание: Ошибка возникает, если сервер не может обработать предоставленный формат данных. Убедитесь, что тело запроса имеет корректный формат (application/json).

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

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

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

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

Заключение​

Метод POST /locations/points позволяет создавать новые точки для конкретных местоположений с различными настраиваемыми параметрами. Убедитесь, что тело запроса соответствует требованиям API (например, обязательные поля не пусты, данные имеют корректный формат), чтобы избежать ошибок валидации.