POpolymathrobotics
Route Management

Create a route

Changed on

Creates a new route. The route is validated and written as a single whole artifact.

post/v1/vehicles/{vehicleId}/routes/{name}

Request

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

Path parameters

vehicleIdstring required

Vehicle ID issued by Polymath

namestring required

Request body

Example request

{
  "nodes": [
    {
      "id": 0,
      "coordinate_system": 0,
      "wgs84_position": {
        "lat": 37.7749,
        "lon": -122.4194
      }
    },
    {
      "id": 1,
      "coordinate_system": 0,
      "wgs84_position": {
        "lat": 37.7752,
        "lon": -122.4189
      }
    }
  ],
  "edges": [
    {
      "from_node_id": 0,
      "to_node_id": 1,
      "id": 0,
      "cost": 1
    }
  ]
}

Response

Confirmation that the route was created or updated.

status'success' required

JSend status.

messagestring required

Human-readable message, propagated from the ROS service.

Example response

{
  "status": "success",
  "message": "string"
}

Changes