Calculate Route
calculate_routeSequences and drives a set of stops, e.g. a technician from home to the depot, then the day's calls, and back home: returns the order, road distance, drive time, per-leg timings, and geometry from TomTom or Azure Maps, and draws the path with numbered stops on the open map (map_session_id). Creates no territory and changes no assignment. route_type is the user's choice: circuit (returns to start), tour (ends at the required end stop), or open_tour (one way). stop_sets are visited in the order given and no stop moves between sets; order is optimize or as_given; group_by_field adds priority bands. Stops are inline coordinates or point-layer references (e.g. source.filter.territory_id); point_ids and stop_id are point_id values (visits: <account_id>#). A new route_id adds a second route; recalculating an existing route_id replaces it, e.g. to drop a stop. dwell_time is stored for analyze_routes. Route drive time is a different measure from territory workload. No provider key returns ROUTING_NOT_CONFIGURED; past the monthly quota, PROVIDER_QUOTA_EXCEEDED. Returns a task.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | ||
| start | Yes | ||
| route_id | No | ||
| depart_at | No | ||
| stop_sets | Yes | ||
| ts_handle | No | ||
| dwell_time | No | ||
| route_type | Yes | ||
| route_label | No | ||
| travel_mode | No | car | |
| map_session_id | No | ||
| include_geometry | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||