Trackunit Developer Hub

Developer Hub

Welcome to our Developer hub.

Here You'll find comprehensive documentation to help you start working with the API's as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Unit Active Faults

Provides a report of any active faults recorded by the CAN bus system.

URL Structure is:
https://api.trackunit.com/public/Report/UnitActiveFaults

GetUnitActiveFaults

Note

Active faults are only recorded on units transmitting extended information.

Parameters

Name
Data type
Unit of measurement
Note

id *

String

N/A

Id of unit to display active faults for.

from *

DateTime

UTC

The start date.

to *

DateTime

UTC

The end date.

Columns

Refer to the following table for description of columns:

Name
Data type
Unit of measurement
Nullability
Note

time

DateTime

UTC

FALSE

Timestamp of the fault occurence.

spn

INT

N/A

FALSE

A 19 bit number defined by the SAE J1939 standard, with a range going from 0 to 524287.

fmi

INT

N/A

FALSE

The failure mode identifier value.

occurrenceCount

INT

N/A

FALSE

The number of times the fault has been detected.

name

String

N/A

TRUE

The name of the fault.

description

String

N/A

TRUE

A short description of the fault.

Request (example)

{
   "id": "46208",
   "from": "2015-11-01T00:00:00.0000000",
   "to": "2015-11-12T00:00:00.0000000"
}

Response

{
            "list": [
            {
                "time": "2015-11-02T06:54:45.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 17,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T06:56:45.0000000Z",
                "spn": 524285,
                "fmi": 10,
                "occurrenceCount": 42,
                "name": "Manufacturer Assignable SPN"
            },
            {
                "time": "2015-11-02T07:00:42.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 18,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:02:42.0000000Z",
                "spn": 393215,
                "fmi": 4,
                "occurrenceCount": 12
            },
            {
                "time": "2015-11-02T07:08:38.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 19,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:10:36.0000000Z",
                "spn": 393215,
                "fmi": 4,
                "occurrenceCount": 9
            },
            {
                "time": "2015-11-02T07:14:35.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 26,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:19:04.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 27,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:24:12.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 27,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:24:12.0000000Z",
                "spn": 1109,
                "fmi": 2,
                "occurrenceCount": 27,
                "name": "Engine Protection System Approaching Shutdown",
                "description": "Status signal which indicates that engine shutdown is imminent.  This engine protection signal can be a result of different systems failing, i.e., engine overheating. See Figure SPN1107_A.\r\n\r\n00 - Not approaching\r\n01 - Approaching\r\n10 - Error\r\n11 - Not available"
            },
            {
                "time": "2015-11-02T07:26:12.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 27,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:26:12.0000000Z",
                "spn": 1109,
                "fmi": 2,
                "occurrenceCount": 27,
                "name": "Engine Protection System Approaching Shutdown",
                "description": "Status signal which indicates that engine shutdown is imminent.  This engine protection signal can be a result of different systems failing, i.e., engine overheating. See Figure SPN1107_A.\r\n\r\n00 - Not approaching\r\n01 - Approaching\r\n10 - Error\r\n11 - Not available"
            },
            {
                "time": "2015-11-02T07:28:10.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 27,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:28:10.0000000Z",
                "spn": 1109,
                "fmi": 2,
                "occurrenceCount": 27,
                "name": "Engine Protection System Approaching Shutdown",
                "description": "Status signal which indicates that engine shutdown is imminent.  This engine protection signal can be a result of different systems failing, i.e., engine overheating. See Figure SPN1107_A.\r\n\r\n00 - Not approaching\r\n01 - Approaching\r\n10 - Error\r\n11 - Not available"
            },
            {
                "time": "2015-11-02T07:30:11.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 27,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:30:11.0000000Z",
                "spn": 1109,
                "fmi": 2,
                "occurrenceCount": 27,
                "name": "Engine Protection System Approaching Shutdown",
                "description": "Status signal which indicates that engine shutdown is imminent.  This engine protection signal can be a result of different systems failing, i.e., engine overheating. See Figure SPN1107_A.\r\n\r\n00 - Not approaching\r\n01 - Approaching\r\n10 - Error\r\n11 - Not available"
            },
            {
                "time": "2015-11-02T07:32:10.0000000Z",
                "spn": 111,
                "fmi": 1,
                "occurrenceCount": 28,
                "name": "Engine Coolant Level 1",
                "description": "Ratio of volume of liquid found in engine cooling system to total cooling system volume.  Typical monitoring location is in the coolant expansion tank."
            },
            {
                "time": "2015-11-02T07:32:10.0000000Z",
                "spn": 393215,
                "fmi": 4,
                "occurrenceCount": 9
            },
            {
                "time": "2015-11-05T07:51:45.0000000Z",
                "spn": 898,
                "fmi": 9,
                "occurrenceCount": 1,
                "name": "Engine Requested Speed/Speed Limit",
                "description": "Parameter provided to the engine from external sources in the torque/speed control message.  This is the engine speed which the engine is expected to operate at if the speed control mode is active or the engine speed which the engine is not expected to exceed if the speed limit mode is active."
            },
            {
                "time": "2015-11-05T07:53:58.0000000Z",
                "spn": 523776,
                "fmi": 9,
                "occurrenceCount": 1,
                "name": "Manufacturer Assignable SPN"
            },
            {
                "time": "2015-11-05T07:53:58.0000000Z",
                "spn": 393215,
                "fmi": 4,
                "occurrenceCount": 8
            },
            {
                "time": "2015-11-05T07:56:54.0000000Z",
                "spn": 523776,
                "fmi": 9,
                "occurrenceCount": 1,
                "name": "Manufacturer Assignable SPN"
            }
            ]
}

Updated about 8 hours ago

Unit Active Faults


Provides a report of any active faults recorded by the CAN bus system.

URL Structure is:
https://api.trackunit.com/public/Report/UnitActiveFaults

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.