Detailed Report
Contents
The Detailed Report provides a comprehensive report for each leg of the route.
Parameters
With your API key, you can try a Detailed Report request using the form below. The required parameters are marked with an asterisk. You can enter values for any of the optional parameters by first checking the box next to them. Scroll down the page to submit your request.
Detailed Report Response
| Name | Description | Data Type | Value/Example | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| type | Describes the type of report and what it does. |
string | DetailReport | ||||||||||||||||||||||||||||
| RouteID | The route identification key(Can be null) |
Int | |||||||||||||||||||||||||||||
| Origin | Where the route started from |
Complex |
| ||||||||||||||||||||||||||||
| Destination | Where the route ends at. |
Complex | See Origin row above | ||||||||||||||||||||||||||||
| ReportLegs | Turn by turn directions from origin. |
Complex |
| ||||||||||||||||||||||||||||
| SlackTime | The time in hours for how early you are expected to arrive at the stop, based on its time window. It is only returned if your request specifies a time window for each stop using the EarliestArrivalTime and LatestArrivalTime parameters. It assumes a departure time of right now unless you specify a departure day and time using the EstimatedTimeOptions object.
|
Complex | 2.7625 |
Address
The fields below are returned as part of an Address object, which describes a location on your route. Not all fields will be populated in the response. Some fields depend on settings in the report request.
| Name | Description | Data Type | Value/Example |
|---|---|---|---|
TimeZone
| The location’s time zone. |
Enum | See a full list of supported time zones. |
SPLC
| The location’s nine-digit Standard Point Location Code (SPLC), if one exists, to use in place of street/city/state/zip. SPLCs are maintained by the National Motor Freight Traffic Association Inc. and require special licensing for use in Trimble Maps data. |
String | 171735301 |
CountryPostalFilter
| The postal code filter, which is used to filter ZIP codes by country. |
Enum | 0 - US 1 - Mexico 2 - Both |
AbbreviationFormat
| The abbreviation format for the country code. See the country code table. Also applies to states in Mexico. |
Enum | 0 - FIPS 1 - ISO2 2 - ISO3 3 - GENC2 4 - GENC3 |
ReportLines
The fields below are returned as part of a ReportLines object and provide detailed information about each leg of a route, including time, mileage, and direction of travel. A “leg” is a section of route between a pair of stops. (For example, for a two-stop route, there will be one leg between origin and destination. For a three-stop route, there will be two legs—one from the origin to stop 1 and then one from stop 1 to the destination.)
In a detailed report, a leg may have multiple ReportLines—one for each turn instruction within that leg.
Not all fields will be populated in the response. Some fields depend on settings in the report request.
| Name | Description | Data Type |
|---|---|---|
Warn
| A message string detailing any warnings related to that section (report line) of the route. |
String |
ARState
| The arrival state information such as “Arrive Loaded.” |
String |
Stop
| A message string detailing stop information. Stops are identified as “Origin” (first stop); “Dest” (last stop); or numbered intermediate stops, (Stop 1, Stop 2, etc.). |
String |
State
| The two-letter state abbreviation. |
String |
Direction
| The driving direction for that section (report line) of the route. |
String |
Miles
| The driving miles for that section (report line) of the route. |
String |
Time
| The driving time for that section (report line) of the route. |
String |
InterCh
| A message string detailing exit or interchange information for that section (report line) of the route. |
String |
LMiles
| The total driving miles for that leg at that point in the route. |
String |
LTime
| The total time elapsed for that leg at that point in the route. |
String |
TMiles
| The total driving miles for the entire trip at that point in the route. |
String |
TTime
| The total time elapsed for the entire trip at that point in the route. |
String |
LToll
| The toll cost for that leg at that point in the route. |
String |
TToll
| The total toll cost for the entire trip at that point in the route. |
String |
TollPlazaAbbr
| An abbreviation for the toll plaza. |
String |
TollPlazaName
| The full name of the toll plaza. |
String |
EtaEtd
| Estimated time of arrival or departure for that leg of the route. This field is only returned if estimated time options are included in the detailed report request. |
String |
Info
| Break and border wait information. |
String |
Restriction
| Hazmat restriction information. |
String |
StartCoordinate
| The beginning GPS coordinates for that leg of the route. |
String |
EndCoordinate
| The end GPS coordinates for that leg of the route. |
String |