DistanceFuelByRegionBreakdown

The Distance & Fuel by Region Breakdown report XML response is invoked by external calls for the DistanceFuelByRegionBreakdown table.

This report allows you to view regional activity in greater depth by separating a driver or equipmentAll machines used as a means of production on a construction site or at a batch plant.'s activities into individual trips in each regionLarge-scale hotspots used to track fleet activity, such as at the state/province/city level..

Measurements for distance and fuel are based on your company's Site Settings.

Parameters

distanceFuelByRegionParams

Parameter

Description

Type

Required

Notes

dateRange

The day(s) desired for report data querying.

Date Range

Required

 

employeeNums

The identification numbers for the employeeUser accounts for drivers, dispatchers, and other staff to perform varying functions in TrackIt.(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

employeeTypeIDs

The identification numbers for the employee type(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

vehicleNums

The identifying numbers for the vehicleAll machines used as a means of production on a construction site or at a batch plant.(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

vehicleTypeIDs

The identification numbers for the vehicle type(s) queried.

String

   Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

plantNums

The identifying numbers for the plantA production plant or material storage location.(s) queried.

String

Required

 Required: Separate multiple entries with a comma.

Wildcard: Use -1 to query all data of this type.

regionIDs

The identification numbers associated with the region(s) queried.

String

  

Required: Separate multiple entries with a comma.

allRegions

Forces all regions to be queried for the report.

Boolean

  

Options:

  • True queries all regions in TrackIt.
  • False queries only the region IDs provided.

sortByRegion

Groups all matching records by region.

Boolean

  

Options:

  • True sorts all entries by region.
  • False sorts all regions by the default method.

Returns

distanceFuelByRegionBreakdownData

Multiple occurrences may be returned based on the provided value for dateRange.

Parameter Description Notes

enterTime

The timestamp for when the vehicle entered the region.

  

exitTime

The timestamp for when the vehicle exited the region.