Submit route optimization
Submit a route for optimization. The request is processed asynchronously and returns HTTP 202 with identifiers to track the job.
Use the returned job_id to poll GET /planner/jobs/{job_id} for status. Once status is succeeded, retrieve the result via GET /planner/optimizations/{optimization_id}/result.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Search corridor width in meters around the route for finding charging stations.
1000 <= x <= 20000Tenant ID
Body
Top-level request body schema for the planner.
The unique identifier of the vehicle.
The starting battery level of the vehicle (from 0.1 to 1.0).
0.1 <= x <= 1A list of route sections to be processed.
Filter criteria for charging stations along the route.
The desired battery level at the end of the tour (from 0.1 to 0.8).
0.1 <= x <= 0.8Service time at departure in minutes. Added to total tour duration.
Start time of the tour in HH:MM:SS or ISO-8601 format.
When true, the response includes all charging stations along the corridor.
Response
Successful Response
Human-readable status message.
Tour identifier.
Optimization identifier. Use this to retrieve the result via GET /planner/optimizations/{optimization_id}/result.
Job identifier (UUID). Use this to poll for status via GET /planner/jobs/{job_id}.
Warnings about the request, if any.