GPSGapReport v1

The GPS Gap report XML response is invoked by external calls for the GPSGapReport table.
This specific endpoint is activated by customer request only. Similar data can be retrieved using the GPS Gap Report in the TrackIt Web Console

This report allows you to identify instances of longer-than-usual gaps between GPS fixes received by TrackIt that might be caused by hardware failures or poor coverage.

Parameters

gpsGapReport

Parameter

Description

Type

Required

Notes

timeBetweenFixes

The minimum time between GPS fixes to query against. Any values above this amount will be included in the return.

Integer

Required

 Value measured in seconds.

dateRange

The day(s) desired for report data querying.

Date Range

Required

  

employeeNum

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

Integer

 

  

vehicleNum

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

Integer

 

  

typeID

The employee or vehicle type ID depending on which one the query is focused.

Integer

 

  

Parameter

Description

  

Notes

GPSGapParams

    

 

 

timeBetweenFixes

   

 

 

dateRange

   

 

 

   year

 

  

 

 

   month    

 

 

   day    

 

 

   hour    

 

 

   minute    

 

 

   second    

 

 

   timezone    

 

 

employeeNum

The identification numbers for the employee(s) queried.

  

 

 

 vehicleNum

The equipmentAll machines used as a means of production on a construction site or at a batch plant.'s identification number.

  

 

 

typeID

The employee or vehicle type ID depending on which one the query is focused.

  

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://v1.report.services.trakitgps.com/">

<soapenv:Header/>

<soapenv:Body>

<v1:GPSGapReport>

<!--Optional:-->

<webkey>{webkey}</webkey>

<!--Optional:-->

<GPSGapParams>

<timeBetweenFixes>{time in seconds}</timeBetweenFixes>

<dateRange>

<startDate>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<!--Optional:-->

<timeZone>{time zone}</timeZone>

</startDate>

<endDate>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<!--Optional:-->

<timeZone>{time zone}</timeZone>

</endDate>

</dateRange>

<!--Optional:-->

<employeeNum>{employee number}</employeeNum>

<!--Optional:-->

<vehicleNum>{vehicle number}</vehicleNum>

<!--Optional:-->

<typeID>{type id number}</typeID>

</GPSGapParams>

</v1:GPSGapReport>

</soapenv:Body>

</soapenv:Envelope>

Returns

gpsGapData
Parameter Description Notes

employeeNum

The employee's identification number.

  

vehicleNum

The equipment's identification number.

  

startStatusNum

The statusThe specific activity or task a driver is currently engaged in, typically as part of a process called a "status loop." number when the GPS fix gap first started.

  

endStatusNum

The status number when the next GPS fix was obtained.

  

dateRange

The date(s) the eventEngine data recorded by TrackIt that includes fault codes and driver behaviors like hard braking. spanned.

  

duration

The total span of time between GPS fixes, as measured in seconds.

  

durationMillis

The total span of time between GPS fixes, as measured in milliseconds.

  

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>

<ns2:GPSGapReportResponse xmlns:ns2="http://v1.report.services.trakitgps.com/">

<return>

<employeeNum>{employee number}</employeeNum>

<vehicleNum>{vehicle number}</vehicleNum>

<startStatusNum>{status number}</startStatusNum>

<endStatusNum>{status number}</endStatusNum>

<dateRange>

<startDate>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<timeZone>{time zone}</timeZone>

</startDate>

<endDate>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<timeZone>{time zone}</timeZone>

</endDate>

</dateRange>

<duration>{duration}</duration>

<durationMillis>{duration in milliseconds}</durationMillis>

</return>

<return>

<employeeNum>{employee number}</employeeNum>

<vehicleNum>{vehicle number}</vehicleNum>

<startStatusNum>{status number}</startStatusNum>

<endStatusNum>{status number}</endStatusNum>

<dateRange>

<startDate>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<timeZone>{time zone}</timeZone>

</startDate>

<endDate>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<timeZone>{time zone}</timeZone>

</endDate>

</dateRange>

<duration>{duration}</duration>

<durationMillis>{duration in milliseconds}</durationMillis>

</return>

</ns2:GPSGapReportResponse>

</S:Body>

</S:Envelope>