StatusBreakdownReportUsingStatusNum v1

The Status Breakdown report XML response is invoked by external calls for the StatusBreakdownReportUsingStatusNum table.

This report gathers the statusThe specific activity or task a driver is currently engaged in, typically as part of a process called a "status loop." history of employees and equipmentAll machines used as a means of production on a construction site or at a batch plant., breaks the data down into individual records, and indicates durations and the type of change triggering the status. Unlike the StatusBreakdownReport web service, this report queries and groups data by status number.

Parameters

statusBreakdownParams
Parameter Description Type Required Notes

statusNums

The status's corresponding identification number(s).

Integer

Required

For multiple status entries, repeat statusNums parameter.

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

 

This is either the Equipment Type ID or the Employee Type ID depending on whether employeeNum or vehicleNum is the query emphasis.

statusTypeId

The status type's identification number.

Integer

Required

This ID can be retrieved using getAllStatusesForStatusType.

showMiles

Indicates whether statuses should include mileage traveled and fuel used while in the status.

Boolean

 

The values provided will always be in miles and gallons.

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

<soapenv:Header/>

<soapenv:Body>

<v1:StatusBreakdownReportUsingStatusNum>

<!--Optional:-->

<webkey>{webkey}</webkey>

<!--Optional:-->

<StatusBreakdownParams>

<!--1 or more repetitions:-->

<statusNums>{status number}</statusNums>

<statusNums>{status number}</statusNums>

<statusNums>{status number}</statusNums>

<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}</typeID>

<!--Optional:-->

<statusTypeId>{status type ID}</statusTypeId>

<showMiles>{true or false}</showMiles>

</StatusBreakdownParams>

</v1:StatusBreakdownReportUsingStatusNum>

</soapenv:Body>

</soapenv:Envelope>

Returns

statusBreakdownData
Parameter Description Notes

distance

 The distance the vehicle has traveled during the status.

Always measured in miles.

employeeNum

The employee's identification number.

 

fueldUsed

How much fuel the vehicle has used.

Always measured in gallons.

hotspotID

The hotspotGeographic areas marked on a map that act as destinations for driver navigation or triggers for automated behaviors in TrackIt.'s identification number.

 

latitude

The north/south coordinates for the GPS fixCoordinates for a vehicle's location. These are fetched by TrackIt at regular intervals to map equipment routes over the course of a day. received.

 

longitude

The west/east coordinates for the GPS fix received.

 

plantNum

The plantA production plant or material storage location. number associated with the employee and/or equipment.

 

startTime

The time stamp associated with the status when the status first became active.

 

statusChangeType

The action that caused the status change, such as a user- or system-triggered response.

Values:

0 UNKNOWN unknown
1 STATUSCHANGE status_change
2 DISPATCH dispatch
3 INTERFACE interface
4 INTERFACEDIVERTED interface_diverted

statusNum

The status's corresponding identification number.

 

timeSpent

The total time spent in a status before a change is triggered.

Measured in minutes.

timeSpentMillis

The total time spent in a status before a change is triggered.

Measured in milliseconds.

vehicleNum

The equipment's identification number.

 

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

<S:Body>

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

<return>

<distance>{distance}</distance>

<employeeNum>{employee number}</employeeNum>

<fuelUsed>{fuel used}</fuelUsed>

<hotspotID>{hotspot id}</hotspotID>

<latitude>{latitude}</latitude>

<longitude>{longitude}</longitude>

<plantNum>{plant number}</plantNum>

<startTime>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<timeZone>{time zone}</timeZone>

</startTime>

<statusChangeType>{status change type}</statusChangeType>

<statusNum>{status number}</statusNum>

<timeSpent>{time spent in status}</timeSpent>

<timeSpentMillis>{time spent in milliseconds}</timeSpentMillis>

<vehicleNum>{vehicle number}</vehicleNum>

</return>

<return>

<distance>{distance}</distance>

<employeeNum>{employee number}</employeeNum>

<fuelUsed>{fuel used}</fuelUsed>

<hotspotID>{hotspot id}</hotspotID>

<latitude>{latitude}</latitude>

<longitude>{longitude}</longitude>

<plantNum>{plant number}</plantNum>

<startTime>

<year>{year}</year>

<month>{month}</month>

<day>{day}</day>

<hour>{hour}</hour>

<minute>{minute}</minute>

<second>{second}</second>

<timeZone>{time zone}</timeZone>

</startTime>

<statusChangeType>{status change type}</statusChangeType>

<statusNum>{status number}</statusNum>

<timeSpent>{time spent in status}</timeSpent>

<timeSpentMillis>{time spent in milliseconds}</timeSpentMillis>

<vehicleNum>{vehicle number}</vehicleNum>

</return>

</ns2:StatusBreakdownReportUsingStatusNumResponse>

</S:Body>

</S:Envelope>