Skip to main content

Recalculate Trip

Contents

Trip Management’s Recalculate Trip API lets you recalculate the uncompleted portion of the trip. Based on the updated position and HOS, this API will return updated trip details and a revised ETA.

In order to provide the best available ETAs, the Trip Management service automatically recalculates:

  • Once a trip begins and the tripStatus changes to InProgress.
  • After a trip has been modified with the Modify Trip API, which is called if the back office adds or removes a stop, or if the driver adds a rest stop.
  • After an ETA event. If there has been some issue in the trip that has triggered a change of arrival time, a recalculation is automatically performed.

A Recalculate Trip API call is required when you want to update Hours of Service (HOS) information for the trip. We also recommend calling the Recalculate Trip API when there are other changes to the trip, including:

  • After an Arrived/Departed event. After arriving at and completing a stop, recalculation gets the latest ETA for that driver. Recalculation can help take into account deliveries or rest breaks that are shorter or longer than the allotted time.
  • After an out-of-corridor event when the driver leaves the route or returns to the route. If the driver has left or rejoined the planned route, the ETA will change and needs to be recalculated.

PUT /trip/recalculate

Resource URL

https://tripmanagement.alk.com/api/trip/recalculate

Request Fields

FieldDescriptionTypeRequired
tripIdThe alkTripId returned when you planned the trip.
Note: If no trip is found with the given alkTripId, then an error message will be returned. If the tmsTripId in your planning system is also supplied in the body of this request, then the alkTripId will be ignored irrespective of whether it is valid or not and the trip corresponding to the provided tmsTripId will be recalculated. In this case, if no trip is found with the given tmsTripId, then an error message will be returned.
integer
Yes if tmsTripId is not supplied.
tmsTripIdThe tmsTripId of your previously generated route.
Note: Even if tripId, which is the alkTripId, is also supplied with this request, it will be ignored and only trip corresponding to the given tmsTripId will be recalculated. If no trip is found with the given tmsTripId, then an error message will be returned.
string
Yes if tripId is not supplied.
currentLocationThe current location in latitude/longitude. This will be used as the starting location when recalculating the remainder of the tripCoords
object
No, default is the last gps point sent through the update position API if available, or the plannedStartLocation of the full trip
driverHoursOfServiceThe hours of service parameters, if using the Trimble MAPS HOS solution. This field is same as the driverHoursOfService in PlanTrip requestdriverHoursOfService
object
No.
driverHoursOfService > EnabledIf false, HOS rest stops will not be inserted in route.
boolean
No. Default is true
driverHoursOfService > HoSRuleTypeIndicates which hours of service rule type to follow
  • 0 or “USFed607LH”
  • 1 or “USFed708LH”
  • 2 or “CanadaCycle1”
  • 3 or “CanadaCycle2”
  • 4 or “California808”
  • 5 or “Texas707”
  • 6 or “USShortHaul”
  • 7 or “Europe”
Enum
No. Default is 1
driverHoursOfService > AlternateHoSRuleTypeIndicates an alternate hours of service rule type to follow whe making cross border moves between Canada and the United States.
  • 0 or “USFed607LH”
  • 1 or “USFed708LH”
  • 2 or “CanadaCycle1”
  • 3 or “CanadaCycle2”
  • 4 or “California808”
  • 5 or “Texas707”
  • 6 or “USShortHaul”
  • 7 or “Europe”
Enum
No. Default is null
driverHoursOfService > RemainingDriveTimeUntilBreakRemaining time in seconds until short break.
double
No. Default is full HOS.
driverHoursOfService > RemainingDriveTimeRemaining drive time in seconds for the day.
double
No. Default is full HOS.
driverHoursOfService > RemainingOnDutyTimeRemaining on duty time in seconds for the day.
For Canada HOS this is the remaining time in seconds for a work shift.
double
No. Default is full HOS.
driverHoursOfService > RemainingCycleDutyTimeRemaining time in seconds until cycle limit.
double
No. Default is full HOS.
driverHoursOfService > RemainingCanadaOnDutyTimeRemaining time in seconds for a day - applicable only for Canada HOS.
double
No. Default is full HOS.
driverHoursOfService > RemainingTimeUntilFullDayBreakRemaining time in seconds until full day break - applicable only for Canada Cycle Two HOS.
double
No. Default is full HOS.
driverHoursOfService > RemainingTimeUntilFullDayBreakDriver2Remaining time in seconds until full day break for driver 2- applicable only for Canada Cycle Two HOS.
double
No. Default is full HOS.
driverHoursOfService > CycleTimeGainsAn array of cycle time gains in seconds for the next 6 or 7 days.
Array <double>
No. Default is no cycle time gains.
driverHoursOfService > LastCycleResetDateTimeDate and time of end of last cycle reset - applicable only for Canada HOS
string
No.
driverHoursOfService > Last24HourBreakDateTimeDate and time of end of last 24 hour break - applicable only for Canada HOS
string
No.
driverHoursOfService > RemainingDriveTimeUntilBreakDriver2Remaining time in seconds until short break for Driver 2. Used only for Team Driving.
double
No. Default is full HOS.
driverHoursOfService > RemainingDriveTimeDriver2Remaining drive time in seconds for the day for Driver 2. Used only for Team Driving.
double
No. Default is full HOS.
driverHoursOfService > RemainingOnDutyTimeDriver2Remaining on duty time in seconds for the day for Driver 2. Used only for Team Driving. For Canada HOS this is the remaining time in seconds for a work shift.
double
No. Default is full HOS.
driverHoursOfService > RemainingCycleDutyTimeDriver2Remaining time in seconds until cycle limit for Driver 2. Used only for Team Driving.
double
No. Default is full HOS.
driverHoursOfService > RemainingCanadaOnDutyTimeDriver2Remaining time in seconds for a day for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
double
No. Default is full HOS.
driverHoursOfService > CycleTimeGainsDriver2An array of cycle time gains in seconds for the next 6 or 7 days for Driver 2. Used only for Team Driving.
Array <double>
No. Default is no cycle time gains.
driverHoursOfService > LastCycleResetDateTimeDriver2Date and time of end of last cycle reset for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
string
No.
driverHoursOfService > Last24HourBreakDateTimeDriver2Date and time of end of last 24 hour break for Driver 2. Used only for Team Driving. Applicable only for Canada HOS
string
No.
driverHoursOfService > RemainingOnDutyTimeInDayThe remaining on-duty time (in seconds) in a day until the driver must take a break. Only used for European HOS.
double
No. Default is full HOS. e
driverHoursOfService > RemainingDrivingTimeInWeekThe remaining driving time in seconds until the driver must take a weekly break. Only used for European HOS.
double
No. Default is full HOS.
driverHoursOfService > RemainingConsecutiveDrivingTimeThe remaining consecutive driving time (in seconds) in a day until the driver must take a break. Only used for European HOS.
double
No. Default is full HOS.
driverHoursOfService > RemainingFortnightlyTimeThe remaining fortnightly (bi-weekly) time (in seconds) until the drive must take a break. Only used for European HOS.
double
No. Default is full HOS.
driverHoursOfService > UseCycleResetIf true, a cycle reset break will be inserted in route.
boolean
true
driverHoursOfService > TerminalDayStartTimeStart of the 24-hour period for the driver for cycle time limit compliance
string
No. Default is midnight in the time zone of the trip origin
driverHoursOfService > UseCustomPlacesIf true, custom locations will be used where possible for HOS rest break.
boolean
No. Default is false
driverHoursOfService > teamDriving (U.S. and Canada Only)If set to true, team driving will be used and, whenever possible, the active driver will be switched instead of taking a rest break. A separate “driver swap” rest break is inserted when a driver’s time is up. The duration of that break is set using driverSwitchBreakDuration, with a default of 5 minutes if no value is entered.


activeDriver determines which driver starts the trip so that the Trip Management service knows whose clock to count down first.

boolean
No. Default is false
driverHoursOfService > activeDriverFor Team Driving, indicates which driver is active at the beginning of the trip.
integer
No. Default is 1
driverHoursOfService > CustomBreakDurationsLonger custom durations for rest stops will be used instead of mandated minimum durations by default.CustomBreakDurations
object
No.
driverHoursOfService > CustomBreakDurations > ShortBreakDurationCustom duration in seconds for short rest break instead of mandated minimum 30 minutes.
double
No.
driverHoursOfService > CustomBreakDurations > EndOfDutyBreakDurationCustom duration in seconds for end of duty break instead of mandated minimum 10 hours.
double
No.
driverHoursOfService > CustomBreakDurations > CycleResetBreakDurationCustom duration in seconds for cycle reset instead of mandated minimum 34 hours (US) and 36 hours (Canada).
double
No.
driverHoursOfService > CustomBreakDurations > DriverSwitchBreakDurationCustom duration in seconds for driver switch instead of default minimum of 5 minutes.
double
No.
driverHoursOfService > CustomBreakDurations > BorderCrossingWaitDurationCustom duration in seconds for border crossing instead of default minimum of 1 hour.
double
No.
driverHoursOfService > CustomBreakDurations > BreakTimeInDayDurationThe custom duration in seconds for reducing the daily rest period. Default daily rest is 11 hours. This can be reduced to 9 hours (32400 seconds) 3 times per week as allowed by Europe HOS.
integer
No - default is 11 hours
driverHoursOfService > CustomBreakDurations > BreakTimeInWeekDurationThe custom duration in seconds for reducing the weekly rest period. Default weekly rest is 45 hours. This can be reduced to 24 hours (86400 seconds) as allowed by Europe HOS.
integer
No - default is 45 hours
driverHoursOfService > MaxAlternateRestStopsThe maximum number of alternate rest stops that will be returned in the Hours of Service report.
boolean
No, default is 0.
driverHoursOfService > CurrentOffDutyTimeThe amount of off-duty time the driver has already accumulated at the time the trip was created. For example, if a driver is due for an end-of-day break, which is typically 10 hours, HOS logic will reduce that break duration by the amount of time entered in the “CurrentOffDutyTime” parameter.
  • The format is in seconds.
  • double
    No, default is 0.
    driverHoursOfService > CurrentOffDutyTimeDriver2The amount of off-duty time the driver has already accumulated at the time the trip was created. For example, if a driver is due for an end-of-day break, which is typically 10 hours, HOS logic will reduce that break duration by the amount of time entered in the “CurrentOffDutyTime” parameter.
  • The format is in seconds.
  • Used only for Team Driving.
  • double
    No, default is 0.
    driverHoursOfService > POIStopsReturnedSets whether rest stops are returned as actual stop locations (POIs) along the route or only as the latitude/longitude coordinates for the last point along the route that a rest stop must be taken before a violation occurs.


    When set to False, the lat/lon location will be set 30 minutes before the HOS violation line if HOSwindowStart and HOSwindowEnd are set to default values. If HOSwindowStart and HOSwindowEnd are NOT default, then the lat/lon location will be set at HOSwindowEnd.


    True = Use POIs
    False = Coordinates

    bool
    No - Default is True
    driverHoursOfService > HOSWindowStartSets the time in minutes prior to when an HOS break is required that the algorithm should start looking for a rest stop to insert in the trip. The value can be between 10 and 60 minutes. For example, if a break is required at 2 p.m., and HOSWindowStart is set to 30, the window for inserting a rest stop begins at 1:30 p.m.
    int
    No - Default is 60
    driverHoursOfService > HOSWindowEndSets the time in minutes prior to when an HOS break is required that the algorithm should finish looking for a rest stop to insert in the trip. The value can be between 10 and 60 minutes. For example, if a break is required at 2 p.m., and HOSWindowEnd is set to 10, the window for inserting a rest stop ends at 1:50 p.m. To maximize driving time, the algorithm will look for a stop as close as possible to the end of the window.
    int
    No - Default is 10

    Response Fields

    FieldDescriptionType
    alkTripIdThe unique identifier for the trip. This value will be used in subsequent calls to the service pertaining to this trip.
    integer
    nameA display name for this trip.
    string
    tmsTripIdThe trip ID in your planning system. This can be used to match a Trip Management trip with a trip in your database.
    string
    tripStatusThe current status of the trip. For the initial response, the value will be Planned. As the trip gets executed/modified, the values may change to
    • InProgress,
    • Canceled,
    • Completed, or
    • Declined.
    string
    actualStartDateThe date and time when the accepted the trip in CoPilot.
    date
    tripDistanceThe total mileage of the trip.
    double
    tripDurationThe total duration of the trip.
    double
    tripDriveDurationThe total duration of the trip which was spent driving.
    integer
    tripCostThe total cost value for the trip.
    integer
    tripTollsThe total tolls value for the trip.
    integer
    remainingLegDistanceThe remaining distance in miles or kilometers for the current in-progress leg of the trip. Tracked from the last received GPS ping to the next open stop in the trip
    integer
    remainingLegDurationThe remaining duration in minutes for the current in-progress leg of the trip. Tracked from the last received GPS ping to the next open stop in the trip
    integer
    regionIndicates which region was set to run the trip.
    Enum
    stopsThe stop array contains every customer stop in the trip plan as well as inserted fuel and rest stops.
    Array <Stop>
    stops > stopSequenceThe order in which the stops are to be executed. This includes inserted fuel and rest stops.
    integer
    stops > stopStatusStatus of the stop
    • Open,
    • Completed,
    • Canceled,
    • NotViable
    string
    stops > stopArrivalStatusStatus of the stop
    • OnTime,
    • AtRisk,
    • Late,
    • Early,
    • NotViable
    string
    stops > currentETAThe date and time predicted to arrive based on routing variables.
    date
    stops > actualArrivalTimeThe date and time when the driver reached this stop.
    date
    stops > actualDepartureTimeThe date and time when the driver left this stop.
    date
    stops > actualDurationThe number of minutes the driver spent at this stop.
    integer
    stops > stopTypeThe type of stop. Options are: Origin, Work, Waypoint, FuelStop, Destination, Delivery, Pickup, Break, RestStopShort, RestStopLong, RestStopCycleReset, RestStopFullDay, RestStopDriverSwitch, RestStopShortSplittable (EU ONLY), and RestStopLongSplittable (EU ONLY).
    string
    stops > amenitiesAn array containing the Amenities available as this rest stop.
    Array <string>
    stops > truckServicesIndicates whether this rest stop has Truck Services or not.
    boolean
    stops > activeDriverFor Team Driving, indicates which driver is actively driving starting at this stop.
    integer
    stops > locationEach stop array must have at least two location elements in it.
    Location object
    stops > location > addressAn address object representing the street address, city, state, and postal code of a stop.
    Address object
    stops > location > address > streetAddressThe street address of this trip stop.
    string
    stops > location > address > cityThe city of this trip stop.
    string
    stops > location > address > stateThe state of this trip stop.
    string
    stops > location > address > zipThe zip/postal code of this trip stop.
    string
    stops > location > address > countyThe county where this trip stop is located.
    string
    stops > location > coordsContains the latitude and longitude of the stop.
    coords object
    stops > location > coords > latThe latitude of the stop.
    string
    stops > location > coords > lonThe longitude of the stop.
    string
    stops > location > labelA display name for this trip stop.
    string
    stops > plannedETAEstimated date and time of arrival at the stop as of the initial trip plan when dispatched to the vehicle. The value is formatted in ISO-8601 format.
    date
    stops > plannedDurationThe estimated duration at stop in minutes.
    integer
    stops > saveRestStopIf true, this rest stop will be preserved when recalculating the route.
    boolean
    stops > legDistanceDistance to the next stop in miles.
    double
    stops > legDriveDurationDuration to the reach the next stop in minutes.
    double
    alternateRestStopsA list of alternate Hours of Service rest stops that may be used to replace the current rest stop
    Array <AlternateHosLocation>
    alternateRestStops > amenitiesAn array containing the Amenities available as this rest stop.
    Array <string>
    alternateRestStops > truckServicesIndicates whether this rest stop has Truck Services or not.
    boolean
    alternateRestStops > activeDriverFor Team Driving, indicates which driver is actively driving starting at this stop.
    integer
    alternateRestStops > locationThe location of the alternate rest stop.
    Location object
    alternateRestStops > location > addressAn address object representing the street address, city, state, and postal code of the alternate rest stop.
    Address object
    alternateRestStops > location > address > streetAddressThe street address of the alternate rest stop..
    string
    alternateRestStops > location > address > cityThe city of the alternate rest stop.
    string
    alternateRestStops > location > address > stateThe state of the alternate rest stop.
    string
    alternateRestStops > location > address > zipThe zip/postal code of the alternate rest stop.
    string
    alternateRestStops > location > address > countyThe county where the alternate rest stop. is located.
    string
    alternateRestStops > location > coordsContains the latitude and longitude of the alternate rest stop.
    coords object
    alternateRestStops > location > coords > latThe latitude of the alternate rest stop.
    string
    alternateRestStops > location > coords > lonThe longitude of the alternate rest stop.
    string
    alternateRestStops > location > labelA display name for the alternate rest stop.
    string
    hoursOfServiceRemainingRemaining HOS parameters at the end of the trip, if using the Trimble MAPS HOS solution.
    HoursOfServiceRemaining object
    hoursOfServiceRemaining > enabledIndicates whether the trip was run with HOS enabled allowing rest stops insertion.
    boolean
    hoursOfServiceRemaining > remainingDriveTimeUntilBreakRemaining time in seconds until short break at the end of the trip.
    double
    hoursOfServiceRemaining > remainingDriveTimeRemaining drive time in seconds for the day at the end of the trip.
    double
    hoursOfServiceRemaining > remainingOnDutyTimeRemaining on duty time in seconds for the day at the end of the trip. For Canada HOS this is the remaining time in seconds for a work shift.
    double
    hoursOfServiceRemaining > hoSRuleTypeIndicates which HOS Rule was used to run the trip.
    Enum
    hoursOfServiceRemaining > alternateHoSRuleTypeIndicates an alternate hours of service rule type to follow whe making cross border moves between Canada and the United States.
    Enum
    hoursOfServiceRemaining > remainingCycleDutyTimeRemaining time in seconds until cycle limit at the end of the trip.
    double
    hoursOfServiceRemaining > cycleTimeGainsAn array of cycle time gains in seconds for the next 6 or 7 days at the end of the trip.
    Array <double>
    hoursOfServiceRemaining > lastCycleResetDateTimeDate and time of end of last cycle reset at the end of the trip - applicable only for Canada HOS.
    string
    hoursOfServiceRemaining > last24HourBreakDateTimeDate and time of end of last 24 hour break at the end of the trip - applicable only for Canada HOS.
    string
    hoursOfServiceRemaining > remainingCanadaOnDutyTimeRemaining time in seconds for a day at the end of the trip - applicable only for Canada HOS.
    double
    hoursOfServiceRemaining > remainingDriveTimeUntilBreakDriver2Remaining time in seconds until short break at the end of the trip for Driver 2. Used only for Team Driving.
    double
    hoursOfServiceRemaining > remainingDriveTimeDriver2Remaining drive time in seconds for the day at the end of the trip for Driver 2. Used only for Team Driving.
    double
    hoursOfServiceRemaining > remainingOnDutyTimeDriver2Remaining on duty time in seconds for the day at the end of the trip for Driver 2. Used only for Team Driving. For Canada HOS this is the remaining time in seconds for a work shift.
    double
    hoursOfServiceRemaining > remainingCycleDutyTimeDriver2Remaining time in seconds until cycle limit at the end of the trip for Driver 2. Used only for Team Driving.
    double
    hoursOfServiceRemaining > cycleTimeGainsDriver2An array of cycle time gains in seconds for the next 6 or 7 days at the end of the trip for Driver 2. Used only for Team Driving.
    Array <double>
    hoursOfServiceRemaining > lastCycleResetDateTimeDriver2Date and time of end of last cycle reset at the end of the trip for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
    string
    hoursOfServiceRemaining > last24HourBreakDateTimeDriver2Date and time of end of last 24 hour break at the end of the trip for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
    string
    hoursOfServiceRemaining > remainingCanadaOnDutyTimeDriver2Remaining time in seconds for a day at the end of the trip for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
    double
    hoursOfServiceRemaining > RemainingOnDutyTimeInDayThe remaining on-duty time (in seconds) in a day until the driver must take a break. Only used for European HOS.
    double
    hoursOfServiceRemaining > RemainingDrivingTimeInWeekThe remaining driving time in seconds until the driver must take a weekly break. Only used for European HOS.
    double
    hoursOfServiceRemaining > RemainingConsecutiveDrivingTimeThe remaining consecutive driving time (in seconds) in a day until the driver must take a break. Only used for European HOS.
    double
    hoursOfServiceRemaining > RemainingFortnightlyTimeThe remaining fortnightly (bi-weekly) time (in seconds) until the drive must take a break. Only used for European HOS.
    double
    driverHoursOfServiceThe hours of service parameters, if using the Trimble MAPS HOS solution.
    driverHoursOfService object
    driverHoursOfService > useCycleResetIf true, a cycle reset break is inserted in route.
    boolean
    driverHoursOfService > enabledIf false, HOS rest stops are not inserted in route.
    boolean
    driverHoursOfService > terminalDayStartTimeStart of the 24-hour period for the driver for cycle time limit compliance.
    string
    driverHoursOfService > remainingDriveTimeUntilBreakRemaining time in seconds until short break at the end of the trip.
    double
    driverHoursOfService > useCustomPlacesIf true, custom locations are used where possible for HOS rest break.
    boolean
    driverHoursOfService > remainingDriveTimeRemaining drive time in seconds for the day at the end of the trip.
    double
    driverHoursOfService > teamDriving (U.S. and Canada Only)If set to true, team driving will be used and, whenever possible, the active driver will be switched instead of taking a rest break. A separate “driver swap” rest break is inserted when a driver’s time is up. The duration of that break is set using driverSwitchBreakDuration, with a default of 5 minutes if no value is entered.


    activeDriver determines which driver starts the trip so that the Trip Management service knows whose clock to count down first.

    boolean
    driverHoursOfService > remainingOnDutyTimeRemaining on duty time in seconds for the day at the end of the trip. For Canada HOS this is the remaining time in seconds for a work shift.
    double
    driverHoursOfService > customBreakDurationsLonger custom durations for rest stops are used instead of mandated minimum durations by default.
    CustomBreakDurations object
    driverHoursOfService > hoSRuleTypeIndicates which hours of service rule type was followed.
    Enum
    driverHoursOfService > alternateHoSRuleTypeIndicates an alternate hours of service rule type followed when making cross border moves between Canada and the United States.
    Enum
    driverHoursOfService > remainingCycleDutyTimeRemaining time in seconds until cycle limit at the end of the trip.
    double
    driverHoursOfService > maxAlternateRestStopsThe maximum number of alternate rest stops that will be returned in the Hours of Service report.
    integer
    driverHoursOfService > cycleTimeGainsAn array of cycle time gains in seconds for the next 6 or 7 days at the end of the trip.
    Array <double>
    driverHoursOfService > lastCycleResetDateTimeDate and time of end of last cycle reset at the end of the trip - applicable only for Canada HOS.
    string
    driverHoursOfService > last24HourBreakDateTimeDate and time of end of last 24 hour break at the end of the trip - applicable only for Canada HOS.
    string
    driverHoursOfService > remainingCanadaOnDutyTimeRemaining time in seconds for a day at the end of the trip - applicable only for Canada HOS.
    double
    driverHoursOfService > remainingDriveTimeUntilBreakDriver2Remaining time in seconds until short break at the end of the trip for Driver 2. Used only for Team Driving.
    double
    driverHoursOfService > remainingDriveTimeDriver2Remaining drive time in seconds for the day at the end of the trip for Driver 2. Used only for Team Driving.
    double
    driverHoursOfService > remainingOnDutyTimeDriver2Remaining on duty time in seconds for the day at the end of the trip for Driver 2. Used only for Team Driving. For Canada HOS this is the remaining time in seconds for a work shift.
    double
    driverHoursOfService > remainingCycleDutyTimeDriver2Remaining time in seconds until cycle limit at the end of the trip for Driver 2. Used only for Team Driving.
    double
    driverHoursOfService > cycleTimeGainsDriver2An array of cycle time gains in seconds for the next 6 or 7 days at the end of the trip for Driver 2. Used only for Team Driving.
    Array <double>
    driverHoursOfService > lastCycleResetDateTimeDriver2Date and time of end of last cycle reset at the end of the trip for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
    string
    driverHoursOfService > last24HourBreakDateTimeDriver2Date and time of end of last 24 hour break at the end of the trip for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
    string
    driverHoursOfService > remainingCanadaOnDutyTimeDriver2Remaining time in seconds for a day at the end of the trip for Driver 2. Used only for Team Driving. Applicable only for Canada HOS.
    double
    driverHoursOfService > RemainingOnDutyTimeInDayThe remaining on-duty time (in seconds) in a day until the driver must take a break. Only used for European HOS.
    double
    driverHoursOfService > RemainingDrivingTimeInWeekThe remaining driving time in seconds until the driver must take a weekly break. Only used for European HOS.
    double
    driverHoursOfService > RemainingConsecutiveDrivingTimeThe remaining consecutive driving time (in seconds) in a day until the driver must take a break. Only used for European HOS.
    double
    driverHoursOfService > RemainingFortnightlyTimeThe remaining fortnightly (bi-weekly) time (in seconds) until the drive must take a break. Only used for European HOS.
    double
    driverHoursOfService > CurrentOffDutyTimeThe amount of off-duty time the driver has already accumulated at the time the trip was created. For example, if a driver is due for an end-of-day break, which is typically 10 hours, HOS logic will reduce that break duration by the amount of time entered in the “CurrentOffDutyTime” parameter.
  • The format is in seconds.
  • double
    driverHoursOfService > CurrentOffDutyTimeDriver2The amount of off-duty time the driver has already accumulated at the time the trip was created. For example, if a driver is due for an end-of-day break, which is typically 10 hours, HOS logic will reduce that break duration by the amount of time entered in the “CurrentOffDutyTime” parameter.
  • The format is in seconds.
  • Used only for Team Driving.
  • double
    driverHoursOfService > RemainingOnDutyTimeInDayThe remaining on-duty time (in seconds) in a day until the driver must take a break. Only used for European HOS.
    double
    driverHoursOfService > RemainingDrivingTimeInWeekThe remaining driving time in seconds until the driver must take a weekly break. Only used for European HOS.
    double
    driverHoursOfService > RemainingConsecutiveDrivingTimeThe remaining consecutive driving time (in seconds) in a day until the driver must take a break. Only used for European HOS.
    double
    driverHoursOfService > RemainingFortnightlyTimeThe remaining fortnightly (bi-weekly) time (in seconds) until the drive must take a break. Only used for European HOS.
    double
    driverHoursOfService > POIStopsReturnedSets whether rest stops are returned as actual stop locations (POIs) along the route or only as the latitude/longitude coordinates for the last point along the route that a rest stop must be taken before a violation occurs.


    When set to False, the lat/lon location will be set 30 minutes before the HOS violation line if HOSwindowStart and HOSwindowEnd are set to default values. If HOSwindowStart and HOSwindowEnd are NOT default, then the lat/lon location will be set at HOSwindowEnd.


    True = Use POIs
    False = Coordinates

    bool
    driverHoursOfService > HOSWindowStartSets the time in minutes prior to when an HOS break is required that the algorithm should start looking for a rest stop to insert in the trip. The value can be between 10 and 60 minutes. For example, if a break is required at 2 p.m., and HOSWindowStart is set to 30, the window for inserting a rest stop begins at 1:30 p.m.
    int
    driverHoursOfService > HOSWindowEndSets the time in minutes prior to when an HOS break is required that the algorithm should finish looking for a rest stop to insert in the trip. The value can be between 10 and 60 minutes. For example, if a break is required at 2 p.m., and HOSWindowEnd is set to 10, the window for inserting a rest stop ends at 1:50 p.m. To maximize driving time, the algorithm will look for a stop as close as possible to the end of the window.
    int
    afSetIdsAvoid or favor set Ids are used for routing.
    Array <integer>
    afSetNamesAvoid or favor set names are used for routing.
    Array <string>

    Sample Request

    {
      "tripId": "136",
      "currentLocation": {
        "Coords": {
          "Lat": "42.346619",
          "Lon": "-71.096961"
        }
      },
      "driverHoursOfService": {
        "hosRuleType": "USFed607LH",
        "remainingDriveTime": 39600,
        "remainingOnDutyTime": 50400,
        "remainingDriveTimeUntilBreak": 28800,
        "remainingCycleDutyTime": 216000,
        "cycleTimeGains": [
          36000,
          21600,
          18000,
          46800,
          43740,
          33840
        ],
        "terminalDayStartTime": "12:00:00-4:00",
        "useCycleReset": false,
        "useCustomPlaces": true,
        "teamDriving": false,
        "activeDriver": 1,
        "customBreakDurations": {
          "shortBreakDuration": 3600,
          "endOfDutyBreakDuration": 43200,
          "cycleResetBreakDuration": 144000,
          "driverSwitchBreakDuration": 300,
          "borderCrossingWaitDuration": 7200
        },
        "maxAlternateRestStops": 0
      }
    }
    

    Sample Response

    (Same response as Plan Trip and Get Trip APIs)

    {
      "tripStatus": "Planned",
      "modifiedOn": "2019-01-22T18:08:46+00:00",
      "tripDistance": 3123.933,
      "tripDriveDuration": 3282,
      "tripDuration": 3282,
      "hoursOfServiceRemaining": null,
      "url": null,
      "tripCost": 6302.57,
      "tripTolls": 0,
      "tmsTripId": "ALK1234",
      "name": "Boston to San Diego",
      "stops": [
        {
          "plannedETA": "2017-09-21T10:20:53-04:00",
          "currentETA": "2017-09-21T10:20:53-04:00",
          "earliestArrivalTime": "2017-09-21T10:11:52-04:00",
          "latestArrivalTime": "2017-09-21T11:11:52-04:00",
          "plannedDuration": 0,
          "actualDuration": 0,
          "plannedDepartureTime": "2017-09-21T10:20:53-04:00",
          "stopStatus": "Open",
          "stopArrivalStatus": "OnTime",
          "atRiskThreshold": 15,
          "tooEarlyThreshold": null,
          "legDistance": 2.247,
          "legDriveDuration": 9,
          "metadata": null,
          "amenities": null,
          "truckServices": false,
          "alternateRestStops": null,
          "poiId": 0,
          "setId": 0,
          "persistentId": 0,
          "activeDriver": 1,
          "location": {
            "address": {
              "streetAddress": "4 Hawley Place",
              "city": "Boston",
              "state": "MA",
              "zip": "02110",
              "county": "Suffolk",
              "country": null,
              "stateName": null,
              "stateAbbreviation": null,
              "countryAbbreviation": null
            },
            "coords": {
              "lat": "42.356016",
              "lon": "-71.058228"
            },
            "label": "Fenway Park"
          },
          "stopSequence": 0,
          "stopType": "Origin"
        },
        {
          "plannedETA": "2017-09-22T08:44:46-05:00",
          "currentETA": "2017-09-22T08:44:46-05:00",
          "earliestArrivalTime": "2017-09-21T09:11:52-05:00",
          "latestArrivalTime": "2017-09-21T10:11:52-05:00",
          "plannedDuration": 0,
          "actualDuration": 0,
          "plannedDepartureTime": "2017-09-22T08:44:46-05:00",
          "stopStatus": "Open",
          "stopArrivalStatus": "Late",
          "atRiskThreshold": 30,
          "tooEarlyThreshold": null,
          "legDistance": 1310.714,
          "legDriveDuration": 1403,
          "metadata": null,
          "amenities": null,
          "truckServices": false,
          "alternateRestStops": null,
          "poiId": 0,
          "setId": 0,
          "persistentId": 0,
          "activeDriver": 1,
          "location": {
            "address": {
              "streetAddress": "200 Union Avenue",
              "city": "Memphis",
              "state": "TN",
              "zip": "38103",
              "county": "Shelby",
              "country": null,
              "stateName": null,
              "stateAbbreviation": null,
              "countryAbbreviation": null
            },
            "coords": {
              "lat": "35.142195",
              "lon": "-90.049621"
            },
            "label": "AutoZone Park"
          },
          "stopSequence": 1,
          "stopType": "Work"
        },
        {
          "plannedETA": "2017-09-22T17:03:13-05:00",
          "currentETA": "2017-09-22T17:03:13-05:00",
          "earliestArrivalTime": "2017-09-21T09:11:52-05:00",
          "latestArrivalTime": "2017-09-21T10:11:52-05:00",
          "plannedDuration": 0,
          "actualDuration": 0,
          "plannedDepartureTime": "2017-09-22T17:03:13-05:00",
          "stopStatus": "Open",
          "stopArrivalStatus": "Late",
          "atRiskThreshold": 30,
          "tooEarlyThreshold": null,
          "legDistance": 470,
          "legDriveDuration": 498,
          "metadata": null,
          "amenities": null,
          "truckServices": false,
          "alternateRestStops": null,
          "poiId": 0,
          "setId": 0,
          "persistentId": 0,
          "activeDriver": 1,
          "location": {
            "address": {
              "streetAddress": "1000 Ballpark Way",
              "city": "Arlington",
              "state": "TX",
              "zip": "76011",
              "county": "Tarrant",
              "country": null,
              "stateName": null,
              "stateAbbreviation": null,
              "countryAbbreviation": null
            },
            "coords": {
              "lat": "32.750284",
              "lon": "-97.08119"
            },
            "label": "Globe Life Park"
          },
          "stopSequence": 2,
          "stopType": "Work"
        },
        {
          "plannedETA": "2017-09-23T13:52:38-07:00",
          "currentETA": "2017-09-23T13:52:38-07:00",
          "earliestArrivalTime": "2017-09-21T07:11:52-07:00",
          "latestArrivalTime": "2017-09-21T08:11:52-07:00",
          "plannedDuration": 0,
          "actualDuration": 0,
          "plannedDepartureTime": "2017-09-23T13:52:38-07:00",
          "stopStatus": "Open",
          "stopArrivalStatus": "Late",
          "atRiskThreshold": 30,
          "tooEarlyThreshold": null,
          "legDistance": 1340.972,
          "legDriveDuration": 1369,
          "metadata": null,
          "amenities": null,
          "truckServices": false,
          "alternateRestStops": null,
          "poiId": 0,
          "setId": 0,
          "persistentId": 0,
          "activeDriver": 1,
          "location": {
            "address": {
              "streetAddress": "100 Park Boulevard",
              "city": "San Diego",
              "state": "CA",
              "zip": "92101",
              "county": "San Diego",
              "country": null,
              "stateName": null,
              "stateAbbreviation": null,
              "countryAbbreviation": null
            },
            "coords": {
              "lat": "32.708606",
              "lon": "-117.155498"
            },
            "label": "Petco Park"
          },
          "stopSequence": 3,
          "stopType": "Destination"
        }
      ],
      "tspDriverId": "fred",
      "vehicle": {
        "tspVehicleId": "111111",
        "fuelTankCapacity": 300,
        "fuelTankLevel": 250,
        "milesPerGallon": 5.5,
        "minFuelLevel": 50,
        "minEndingFuelLevel": 100,
        "minFuelPurchase": null,
        "fuelNetworkId": "P",
        "fuelPlanId": "545345",
        "isHighValue": false
      },
      "plannedStartTime": "2017-09-21T10:11:52-04:00",
      "plannedStartLocation": {
        "address": {
          "streetAddress": "22 Lansdowne Street",
          "city": "Boston",
          "state": "MA",
          "zip": "02215",
          "county": "Suffolk",
          "country": "United States",
          "stateName": null,
          "stateAbbreviation": null,
          "countryAbbreviation": null
        },
        "coords": {
          "lat": "42.346619",
          "lon": "-71.096961"
        },
        "label": null
      },
      "allowDriverToDeclineTrip": true,
      "oocThreshold": 1,
      "hosSolution": "ALK",
      "sendOptions": null,
      "driverHoursOfService": {
        "useCycleReset": false,
        "enabled": false,
        "terminalDayStartTime": "12:00:00-4:00",
        "remainingDriveTimeUntilBreak": 28800,
        "useCustomPlaces": true,
        "remainingDriveTime": 39600,
        "teamDriving": false,
        "remainingOnDutyTime": 50400,
        "customBreakDurations": {
          "shortBreakDuration": 3600,
          "endOfDutyBreakDuration": 43200,
          "cycleResetBreakDuration": 144000,
          "driverSwitchBreakDuration": 300,
          "borderCrossingWaitDuration": 7200
        },
        "hoSRuleType": "USFed607LH",
        "alternateHoSRuleType": null,
        "remainingCycleDutyTime": 216000,
        "maxAlternateRestStops": 0,
        "cycleTimeGains": [
          36000,
          21600,
          18000,
          46800,
          43740,
          33840
        ],
        "skipRestStopInsertion": null,
        "lastCycleResetDateTime": null,
        "activeDriver": 1,
        "last24HourBreakDateTime": null,
        "remainingCanadaOnDutyTime": null,
        "remainingDriveTimeUntilBreakDriver2": 28800,
        "remainingDriveTimeDriver2": 39600,
        "remainingOnDutyTimeDriver2": 50400,
        "remainingCycleDutyTimeDriver2": 216000,
        "cycleTimeGainsDriver2": [
          36000,
          21600,
          18000,
          46800,
          43740,
          33840
        ],
        "lastCycleResetDateTimeDriver2": null,
        "last24HourBreakDateTimeDriver2": null,
        "remainingCanadaOnDutyTimeDriver2": null
      },
      "afSetIds": null,
      "afSetNames": null,
      "alkTripId": 136
    }
    
    Last updated May 4, 2022.
    Contents