v2.0.0
Summary
v2.0.0 introduces a zone-based path plan architecture. Path plans organize data hierarchically - each field part becomes a zone with its own guidance settings, geometry, and routes. New endpoints support bulk operations, equipment scenario analysis, slope generation, and shared plan access.
New Endpoints
Path Plans
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/path-plans/{pathPlanId} |
Get path plan with full zone hierarchy |
| GET | /api/path-plans/{pathPlanId}/preview |
Get lightweight preview with simplified geometry |
| POST | /api/path-plan-zones/{pathPlanZoneId}/geometry-groups/{geometryGroupId}/set-active |
Set a geometry group as active within its zone |
Guidance
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/pathplan/{pathPlanId}/slopes |
Generate DEM-based slope analysis for a path plan |
Bulk Guidance
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/bulk-guidance |
Bulk guidance generation across multiple plans |
| GET | /api/bulk-guidance/jobs/{jobId} |
Get bulk guidance job status |
Equipment Scenarios
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/equipment-scenarios |
Generate an equipment explorer scenario |
| GET | /api/equipment-scenarios/jobs/{jobId} |
Get equipment scenario job status |
Routing
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/routes |
Generate routes for a path plan |
Sharing
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/shares/{shareCode}/path-plans/{pathPlanId} |
Get a shared path plan (anonymous access) |
New Features
1. Hierarchical Zone-Based Architecture
New data model with hierarchical structure: **PathPlan -> Zones -> GeometryGroups -> GeometryParts**. Each field part becomes a separate zone with its own guidance settings, geometry, and statistics.
Properties
| Property | Type | Description |
|---|---|---|
PathPlanModel |
model | Top-level container with zones, statistics, and metadata |
PathPlanZoneModel |
model | Represents a single zone (typically one part-field) |
GeometryGroupModel |
model | Contains a complete guidance result (tracks + headlands + route) |
GeometryPartModel |
model | Individual geometry element (track, headland, turn, route segment) |
2. Geometry Group Activation
Support for multiple guidance variants per zone. Use `POST /api/path-plan-zones/{pathPlanZoneId}/geometry-groups/{geometryGroupId}/set-active` to switch between different guidance configurations within a zone.
3. Lightweight Preview Endpoint
New `GET /api/path-plans/{pathPlanId}/preview` endpoint returns simplified geometries for fast map rendering and reduced bandwidth.
4. Slope Analysis
New `POST /api/pathplan/{pathPlanId}/slopes` endpoint generates DEM-based slope data for a path plan, enriching zones with terrain information.
New Schemas
| Schema | Description |
|---|---|
PathPlanModel |
Top-level path plan container with zones and aggregate statistics |
PathPlanZoneModel |
Zone model representing a part-field with geometry groups |
GeometryGroupModel |
Guidance variant containing tracks, headlands, and route |
GeometryPartModel |
Individual geometry element with type-specific details |
GeometryPartTrackDetail |
Track-specific metadata (bearing, width, etc.) |
GeometryPartHeadlandDetail |
Headland-specific metadata (pass number, direction) |
GeometryPartSlopeDetail |
DEM slope analysis data |
RouteZoneRequest |
Request model for zone-aware routing |
RouteJobResultViewModel |
Job result for routing |
Questions?
For questions about these API changes, please contact [email protected] or refer to the API documentation.