RESTful APIs

Trip Management Release Notes

Contents

Sept. 1, 2022

  • IMPROVED Traffic incidents were added to the Notifications Service. Incidents include construction, road closures, congestion, accidents, and other events that may cause traffic delays.

July 26, 2022

  • NEW A new Notifications Service allows you to register your integration to receive real-time notifications as they become available for the following events during a trip: ETA, Stop status, Weather, Out-of-corridor (OoC), Out-of-route (OoR). This push notifications service replaces the legacy polling service , which required repeated API calls to pull new notifications.

June 6, 2022

  • FIXED Fixed an issue that caused the Modify Trip API to return an error if hosSolution is set to 0.
  • FIXED Fixed an issue that caused a “String reference” error when calling Update StopStatus .
  • FIXED Removed an unnecessary HTML line break that appeared in Next Stop field on Trip Viewer pages.

April 7, 2022

  • IMPROVED Added Label information to the Get Trip Notifications API response.

  • IMPROVED Improved response times for Plan Trip API calls. The average response time is now nearly 20 percent faster.

  • IMPROVED Improved storage and performance of GPS ping caching.

  • FIXED Fixed an issue where GET Trip calls using tmsTripId as the trip identifier were sometimes returning this 400 error: [“ArgumentException”,“description”:“Cannot find a trip that matches the supplied trip id.”]

  • FIXED On Tuesday, April 5, from 8 to 8:30 a.m. and 10 to 10:30 a.m. EDT, the service experienced temporary outages due to external factors. This could affect any trips created during that time.

March 15, 2022

  • FIXED Fixed an issue with Weather Alerts timing out and not showing alert details. (See example weather alert below.)

Example alert 

"weatherAlert":{
   "id":"https://alerts.weather.gov/cap/wwacapget.php?x=PA1263E875BD78.WinterStormWarning.1263E892D840PA.CTPWSWCTP.f76d1398bcf5cdabf05a02c1c36d8026",
   "dispUpdated":"2022-03-11T04:26:00-05:00",
   "dispPublished":"2022-03-11T04:26:00-05:00",
   "title":"Winter Storm Warning issued March 11 at 4:26AM EST until March 12 at 7:00PM EST by NWS",
   "summary":"...WINTER STORM WARNING IN EFFECT FROM 4 AM TO 7 PM EST SATURDAY... * WHAT...Heavy snow expected. Total snow accumulations of 5 to 7 inches. Winds gusting as high as 45 mph. * WHERE...Portions of central Pennsylvania. * WHEN...From 4 AM to 7 PM EST Saturday.",
   "alertEvent":"Winter Storm Warning",
   "dispEffective":"2022-03-11T04:26:00-05:00",
   "dispExpires":"2022-03-12T19:00:00-05:00",
   "status":"Actual",
   "category":"Met",
   "urgency":"Expected",
   "severity":"Moderate",
   "certainty":"Likely",
   "areaDesc":"Blair; Columbia; Huntingdon; Juniata; Mifflin; Montour; Northumberland; Schuylkill; Snyder; Southern Centre; Southern Clinton; Southern Lycoming; Union",
   "countryCode":"US"
},
"publishedOn":"2022-03-11T15:51:34+00:00"
},
"notificationType":"\"Weather"

March 3, 2022

  • FIXED Fixed an issue where rest stops would repeat if recalculate was called twice in under 500 milliseconds.

Feb. 8, 2022

  • FIXED Fixed an that caused oocThreshold to return as “null” after Modify or Recalculate Trip API calls. The “Out of Corridor” or OoC threshold is the distance a vehicle or GPS ping departs from the planned route at which the Trip Management service generates an OoC event notification.

Jan. 5, 2022

  • IMPROVED The device time of an alert (DeviceDT) was added to ETA Alerts .
  • FIXED Fixed an issue where HOS stops were immediately flagged as “At Risk.”

Oct. 7, 2021

  • IMPROVED Two new, optional parameters give Hours of Service (HOS) users in Europe the ability to reduce break time in day and break time in week durations based on what is allowed by European HOS rules:
    • BreakTimeInDayDuration - The 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), three times per week, as allowed by Europe HOS.
    • BreakTimeInWeekDuration - The 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.

Aug. 2, 2021

  • IMPROVED The logic used to insert Hours of Service (HOS) rest stops in a route has been enhanced to better maximize drive time. Rest stops will now be inserted closer to the time when an HOS violation would occur if a rest stop were not taken. Three new settings are available to customize when and how rest stops are inserted:
    • POIStopsReturned - Sets whether rest stops are returned as actual stop locations (POIs) along the route or only as the latitude/longitude coordinates for where the rest stop should be taken to avoid an HOS violation.
    • HOSWindowStart- Sets 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.
    • HOSWindowEnd - Sets 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.

June 11, 2021

  • IMPROVED The range of values that can be entered when setting a truck’s totalLength, totalWeight, maxHeight, and maxWidth has been updated . These values are entered when truckDimensions is set to Custom. You can also now enter values in inches or meters, depending on whether the unitsOfMeasure parameter is set to English or Metric.

  • NEW Two new fields have been added to the trip response:

    • remainingLegDistance returns the mileage from the last GPS ping to the next open stop on a trip.

    • remainingLegDuration returns the duration from the last GPS ping to the next open stop on a trip.

March 11, 2021

  • NEW New settings were added to accurately calculate toll costs and greenhouse gas (GHG) emissions when planning a trip in Europe.

Feb. 18, 2021

  • IMPROVED Out of Corridor events are now returned with the timestamp of the GPS ping that triggered the event. The date and time are returned in the DeviceDT field.

Jan. 20, 2021

  • IMPROVED You can now edit via API key the radius around your stops that will automatically trigger an ArrivedAtStop or a DepartedStop event and update the stop status in the trip. The default radius is 0.5 miles. Contact to edit that radius.

Jan. 11, 2021

  • IMPROVED A time window will be assigned to any HOS stop automatically added by the Trip Management service so you can get ETA event notifications to let you know whether a driver may be late to a rest stop. The time window will automatically set the fields earliestArrivalTime and latestArrivalTime to 15 minutes before and 15 minutes after the HOS stop’s planned ETA.

  • IMPROVED The Get Trip Notifications API can now return stop event updates from a trip. A stop event notification is created whenever there is an update of a stop status to “Arrived” or “Departed,” whether or not the stop status change is automatic or manual.

Dec. 16, 2020

  • NEW A new Trip Settings API allows you to get or set specific values, such as event notification thresholds, for an individual trip. For the specified trip, these settings override the default API key settings that were selected at the time the API key was created.

Oct. 21, 2020

  • IMPROVED For rest stops, the EarliestArrivalTime is now set by default to 1 hour before the CurrentETA, and LatestArrivalTime is set to 1 later than the CurrentETA.

  • FIXED Fixed an issue that could cause ETAs to be re-calculated using old GPS pings.

  • FIXED Fixed an issue that was preventing earliest and latest arrival times from being retained when the Modify Trip API is called.

Oct. 7, 2020

  • IMPROVED If a vehicle is “Arrived” at a stop, the Recalculate Trip API will use the most recent time available to recalculate the trip’s ETA—whether it’s the actualArrivalTime, plannedDepartureTime, or a GPS ping timestamp.

  • FIXED Fixed a bug in which GPS pings weren’t being considered in ETA calculation if they were reported and the Recalculate Trip API was called in direct succession (less than 5 milliseconds).

April 8, 2020

  • IMPROVED Trips will not include HOS rest stops in the U.S. that are known to be closed due to COVID-19.

January 13, 2020

  • NEW A new externalOrderIds field has been added, allowing you to include a list of orders associated with a trip.

  • IMPROVED The tripStatus field is now marked as InProgress once the first GPS position is received for the trip.

  • IMPROVED The Get Route Path API can now be used for trips with the initial tripStatus of Planned, in addition to trips that are InProgress or Completed.

October 28, 2019

  • NEW A new Auto-Arrive/Depart feature will automatically mark stops in a trip as “Arrived” or “Departed” by comparing a vehicle’s GPS position with either:

    • A Site perimeter polygon, if one exists for that stop. That includes polygons created by Trimble Maps for truck stops, distribution centers, etc., as well as Custom Place Site polygons that you have created in ContentTools.

    • An air distance of 0.5 miles from a stop. Within that distance a stop will be marked as “Arrived.” Outside of that distance it will be marked as “Departed.”

In the past, users had to enter these stop status changes manually. A notification will also be created for every stop status change. The Auto-Arrive/Depart feature and related notifications are on by default and can be turned off by request.

October 10, 2019

  • IMPROVED New API endpoints have been added that allow you to call or modify trip information using either the ALK Trip ID returned when you planned the trip or the TMS Trip ID in your planning system.

July 16, 2019

  • IMPROVED The Hours of Service (HOS) features for our Trip Management APIs have been updated to now take into account:

    • HOS rules in the U.S. and Canada during trips that cross the border.

    • HOS compliance when team driving with two drivers.

Last updated January 9, 2023.
Contents