POpolymathrobotics
Site Management

Stage a site for activation

Changed on

Stages the named site for activation. The activation will take effect the next time the vehicle starts. Optionally, a route and zone set can be provided, which will be loaded everytime the vehicle starts while this site remains active.

post/v1/vehicles/{vehicleId}/sites/{name}/activate

Request

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

Path parameters

vehicleIdstring required

Vehicle ID issued by Polymath

namestring required

Request body

routestring

Optional route to load every time the vehicle starts while operating with this site as active.

zone_setstring

Optional zone set to load every time the vehicle starts while operating with this site as active.

Example request

{
  "route": "",
  "zone_set": ""
}

Response

Successful Response

status'success'

JSend status.

messagestring required

Human-readable message, propagated from the ROS service.

Example response

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

Changes