Routes

This interface is included in the Core module.

Description

Implemented by all route designs.

Properties

This interface has the following properties.

Property	Value
Name	Routes
Code	designInterfaces_routes
Type	Interface
Context	Core
AI agent enabled	true
AI agent description	Shared interface implemented by all route designs, providing navigation and distance fields.
Icon	icon-route
Colour	#690095
Title	{{attributes_routesName}}
Subtitle	-

Implements

This interface doesn't implement any other interfaces.

Attributes

This interface has the following attributes.

Name

The name identifying this route.

Property	Value
Name	Name
Code	attributes_routesName
Type	String
Required	true
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 128 }

Waypoints

Route waypoints either generated by the routing service or user specified.

Property	Value
Name	Waypoints
Code	attributes_routesWaypoints
Type	Link
Required	true
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	Links to: Ordered collection of waypoints defining the stops on this route.
Links to	Waypoints
Options	{ "code": "designInterfaces_waypoints", "graph": "Route" }

Distance (m)

Optional distance traveled by the route, in float meters (returned by the routing service).

Property	Value
Name	Distance (m)
Code	attributes_routesDistance
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	The total distance of this route in metres.
Options	{ "decimalPlaces": 2 }

Duration (s)

Optional estimated travel time, in float number of seconds (returned by the routing service).

Property	Value
Name	Duration (s)
Code	attributes_routesDuration
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	The estimated travel time for this route in seconds.
Options	{ "decimalPlaces": 2 }

Current Route Type

The current route representation. Can be either 'Fastest' or 'Shortest'.

Property	Value
Name	Current Route Type
Code	attributes_routesCurrentRouteType
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	Indicates whether the route is managed (system-optimised) or manual (user-defined).
Options	{ "max": 128 }

Shortest Route

Optional trip (shortest route) geometry, as generated by OSRM trip service.

Property	Value
Name	Shortest Route
Code	attributes_routesShortestRoute
Type	GeoJson
Required	false
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	Reference to the shortest alternative route calculated for this journey.
Options	{ "allows": [ "Linestring" ] }

Shortest Route Distance

Trip (shortest route) distance traveled in float meters (returned by the routing service).

Property	Value
Name	Shortest Route Distance
Code	attributes_routesShortestRouteDistance
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	The distance of the shortest route in metres.
Options	{ "decimalPlaces": 2 }

Shortest Route Duration

Trip (shortest route) estimated travel time in float number of seconds (returned by the routing service).

Property	Value
Name	Shortest Route Duration
Code	attributes_routesShortestRouteDuration
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
AI agent description	The estimated travel time of the shortest route in seconds.
Options	{ "decimalPlaces": 2 }

Standard paths

This interface doesn't have any standard paths of its own.

Permissions

This interface defines the following permissions.

User group	Allowed
Project Viewers	Read
Project Managers	Read, Create, Edit, Delete

Default attribute permissions

This interface applies the following default permissions to all attributes for the following user groups.

Allowed	User group	Code
ReadOnly	Project Viewers	userGroups_projectViewers
ReadWrite	Project Managers	userGroups_projectManagers