POpolymathrobotics
Zone Set Management

Create a zone set

Changed on

Creates a new zone set. Validated and written as a single whole artifact.

post/v1/vehicles/{vehicleId}/zone-sets/{name}

Request

  • Base URL
    https://api.polymathrobotics.dev
  • URL
    https://api.polymathrobotics.dev/v1/vehicles/{vehicleId}/zone-sets/{name}
  • Auth
    HTTP bearer

Path parameters

vehicleIdstring required

Vehicle ID issued by Polymath

namestring required

Request body

Example request

{
  "zones": [
    {
      "name": "slowdown_zone",
      "type": "speed_limit",
      "enabled": true,
      "coordinate_system": 0,
      "wgs84_polygon": [
        {
          "latitude": 37.828258,
          "longitude": -122.425726
        },
        {
          "latitude": 37.828385,
          "longitude": -122.420642
        },
        {
          "latitude": 37.825124,
          "longitude": -122.420416
        },
        {
          "latitude": 37.825183,
          "longitude": -122.425443
        }
      ],
      "condition": {
        "type": 0,
        "params": []
      },
      "params": [
        {
          "key": "speed_limit_m_s",
          "value": 5
        }
      ]
    }
  ]
}

Response

Successful Response

status'success' required

JSend status.

messagestring required

Human-readable message, propagated from the ROS service.

Changes

  • 3b5ff2f21338Revision changes
    • info

      added the new flag_zone enum value to the request property ///

  • ef34405d1b54Revision changes
    • info

      added the new stop_zone enum value to the request property ///