1.0.30

Zync SDK/zync.api.route.models/Route

Route

data class Route(val routeUid: String, val routeName: String, val isOptimized: Boolean = false, val transportMode: RouteTransportMode? = null, val routeColor: String? = null, val departureDateTime: String? = null, val isRecurring: Boolean = false, val recurrencePattern: RouteRecurrencePattern? = null, val totalDistance: Int = 0, val totalTime: Int = 0, val totalJobs: Int = 0, val routeStatus: RouteStatus = RouteStatus.PLANNED, val createdByUid: String? = null, val createdBy: User? = null, val startLocation: RouteLocation? = null, val endLocation: RouteLocation? = null, val polylineCoordinates: List<RoutePolylinePoint> = emptyList(), val routeConfig: RouteConfiguration? = null, val optimizationSettings: RouteOptimizationSettings? = null, val assignments: List<RouteAssignment> = emptyList(), val statusHistory: List<RouteStatusHistory> = emptyList(), val routeJobs: List<RouteJob> = emptyList(), val optimizations: List<RouteOptimization> = emptyList(), val attachments: List<String> = emptyList(), val createdAt: String, val updatedAt: String? = null, val syncedAt: String? = null, val cacheExpiresAt: String? = null, val isFromArchive: Boolean = false)

Domain model representing a Route in the Zuper system.

Routes are comprehensive navigation containers that organize jobs, stops, and optimize field service technician movements for efficient service delivery.

Constructors

constructor(routeUid: String, routeName: String, isOptimized: Boolean = false, transportMode: RouteTransportMode? = null, routeColor: String? = null, departureDateTime: String? = null, isRecurring: Boolean = false, recurrencePattern: RouteRecurrencePattern? = null, totalDistance: Int = 0, totalTime: Int = 0, totalJobs: Int = 0, routeStatus: RouteStatus = RouteStatus.PLANNED, createdByUid: String? = null, createdBy: User? = null, startLocation: RouteLocation? = null, endLocation: RouteLocation? = null, polylineCoordinates: List<RoutePolylinePoint> = emptyList(), routeConfig: RouteConfiguration? = null, optimizationSettings: RouteOptimizationSettings? = null, assignments: List<RouteAssignment> = emptyList(), statusHistory: List<RouteStatusHistory> = emptyList(), routeJobs: List<RouteJob> = emptyList(), optimizations: List<RouteOptimization> = emptyList(), attachments: List<String> = emptyList(), createdAt: String, updatedAt: String? = null, syncedAt: String? = null, cacheExpiresAt: String? = null, isFromArchive: Boolean = false)

Properties

val actualDuration: Int?

Get actual duration (for completed routes).

val assignments: List<RouteAssignment>

val attachments: List<String>

val cacheExpiresAt: String? = null

completionPercentage

val completionPercentage: Int

Get route completion percentage.

val createdAt: String

val createdBy: User? = null

val createdByUid: String? = null

currentAssignees

val currentAssignees: List<RouteAssignment>

Get current assignees (users and teams).

val currentStop: RouteJob?

Get current stop (in progress).

departureDateTime

val departureDateTime: String? = null

val displayName: String

Get route display name with fallback.

driverAssignment

val driverAssignment: RouteAssignment?

Get primary driver assignment.

efficiencyMetrics

val efficiencyMetrics: RouteEfficiencyMetrics

Get route efficiency metrics.

val endLocation: RouteLocation? = null

estimatedDuration

val estimatedDuration: Int

Get route duration estimation.

formattedDistance

val formattedDistance: String

Get formatted total distance.

val formattedTime: String

Get formatted total time.

val hasGpsTracking: Boolean

Check if route has GPS tracking data.

val isCancelled: Boolean

Check if route is cancelled.

val isCompleted: Boolean

Check if route is completed.

val isFromArchive: Boolean = false

val isInProgress: Boolean

Check if route is in progress.

val isOptimized: Boolean = false

val isRecurring: Boolean = false

latestOptimization

val latestOptimization: RouteOptimization?

Get latest optimization.

latestStatusChange

val latestStatusChange: RouteStatusHistory?

Get latest status change.

needsOptimization

val needsOptimization: Boolean

Check if route needs optimization.

val nextStop: RouteJob?

Get next pending stop.

val optimizations: List<RouteOptimization>

optimizationSettings

val optimizationSettings: RouteOptimizationSettings? = null

polylineCoordinates

val polylineCoordinates: List<RoutePolylinePoint>

recurrencePattern

val recurrencePattern: RouteRecurrencePattern? = null

val routeColor: String? = null

val routeConfig: RouteConfiguration? = null

val routeJobs: List<RouteJob>

val routeName: String

val routeStatus: RouteStatus

val routeUid: String

val startLocation: RouteLocation? = null

val statusColor: String

Get route status color for UI display.

val statusHistory: List<RouteStatusHistory>

val syncedAt: String? = null

val totalDistance: Int = 0

val totalJobs: Int = 0

val totalTime: Int = 0

val transportMode: RouteTransportMode? = null

transportModeDisplayName

val transportModeDisplayName: String

Get transport mode display name.

val updatedAt: String? = null

Functions

isAssignedToTeam

fun isAssignedToTeam(teamUid: String): Boolean

Check if route is assigned to a specific team.

isAssignedToUser

fun isAssignedToUser(userUid: String): Boolean

Check if route is assigned to a specific user.