Schedule exceptions are temporary schedule overrides that are applied to drivers’ schedules within a specific period. After that period passes, the driver’s schedule will follow the default setup..
reference - text value which can be used to query a schedule exception.
driver -
id - driver ID which can be found on the driver's profile.
uid - This is a unique code that eLogii assigns each driver upon creation and can be found on the driver's profile.
reference- The driver reference also available on the driver's profile.
dateRange - The span over which the exception takes effect. Required field.
startDate - required field. Marks the start date of the exception. Format YYYYMMDD
endDate - required field. Marks the end date of the exception. Format YYYYMMDD
description - Information about what the exception is for.
dayOff - Whether the exceštion means the driver won’t be working. Default: false. if true, the driver will be temporarily disabled from optimization.
overrides - Specific overrides which will temporarily be applied.
schedule - Schedule overrides
timeWindows
start -Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880
breaks
timeWindow
start - Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880
offset - Break offset from route start.
start - Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880
duration - The duration of the break. (in minutes)
skills - Temporary override of the skills the driver possesses.
maxMultiDayRouteDays - The maximum number of days the driver can be on the road when doing multiday routes.
startLocation - Contains fields used to specify the start location of the driver, i.e. the starting point of their route.
type - Enum indicating the type of task location:
0
1
2
3
Predefined depot, used in conjunction with uid field for depot UID.
uid - Required for types 0 and 1 – unique identifier of the depot or customer location
address - Contains the address of the location
addressLine2 - Contains the 2nd address of the location
postCode - Contains the location post code
city - Contains the location city
country - Contains the country of the location
what3words - Contains the what3words location coordinates of the location
coordinates - Contains the location coordinates. Format: [longitude, latitude]
contactName - Stores the contact name
contactPhone - Stores the contact phone number
contactEmail - stores the contact email address
setupDuration - Setup and service duration define the time needed to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Setup duration only applies to the first task at a location. Any value set here overrides the default set in Configuration → Optimization.
serviceDuration - Setup and service duration define how long it takes to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Service duration is always added to the total stop time, even if other tasks exist at the same location. Any value set here overrides the default set in Configuration → Optimization.
customerId - contains the customer id
customerUID - contains the customer UID
meta - Contains metadata.
comments
userId
text
timestamp
originalCoordinates Format [longitude, latitude]
overriden
endLocation - Contains fields used to specify the end location of the driver, i.e., the starting point of their route.
type - Enum indicating the type of task location:
0
1
2
3
Predefined depot, used in conjunction with uid field for depot UID.
uid - Required for types 0 and 1 – unique identifier of the depot or customer location.
name - Shows the displayed name of the location.
address - Contains the address of the location.
addressLine2 - Contains the 2nd address of the location.
postCode - Contains the location post code.
city - Contains the location city
country - Contains the country of the location
what3words - Contains the what3words location coordinates of the location
coordinates - Contains the location coordinates. Format: [longitude, latitude]
contactName - Stores the contact name
contactPhone - Stores the contact phone number
contactEmail - stores the contact email address
setupDuration - Setup and service duration define the time needed to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Setup duration only applies to the first task at a location. Any value set here overrides the default set in Configuration → Optimization.
serviceDuration - Setup and service duration define how long it takes to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Service duration is always added to the total stop time, even if other tasks exist at the same location. Any value set here overrides the default set in Configuration → Optimization.
