Status Operational Status

JBus Events (Fault Codes)

  • Last edited on

Returns fault codes reported by an asset's JBus network in a given period of time.

Request Data

Required Information
Name Description
action showopen
operation jbusevents
format xml
start epoch timestamp for start of reporting period
end epoch timestamp for end of reporting period
version
  • 2 - use for logvers 1, 2, and 3
  • 4 - use for logvers 4
Optional Information
logvers
  • 1 - Default output
  • 2 - Format <timestamp> field as epoch.
  • 3 - Allows for no target to be passed. XML reformatted as well.
  • 4 - Includes diagnostic trouble codes (DTCs).

If no value is passed, 1 is assumed. Logvers 4 recommended for most current functionality.
target Specific asset to report data for. Must specify reqtype as well.
reqtype Flag to identify the key being used to query. Acceptable values:
  • tag Key is a Zonar RFID tag number. In version 2 a type must also be specified.
  • exsid Key is the external system id.
  • vin Key is the Vehicle Identification Number (VIN).
  • dbid Key is the internal id number. This is the most reliable key to use.
  • fleet Key is the asset fleet number. In version 2 a type must also be specified.
type When using reqtype of tag or fleet this must also be specified in version 2. In version 1.x type Standard (0) is assumed. Acceptable values are:
  • Standard
  • TRAILER
  • DOLLY
  • Unknown

These values are case-sensitive and must be passed exactly as shown.
engine_only Boolean flag to determine specify if you only want engine code events returned, or all jbus events.
Acceptable values are :
  • true
  • false

If no value is passed, false will be assumed.
mil MIL lamp flag, acceptable values are:
  • 1 - Show only active MIL events
  • 0 - Show all MIL events

If no value is passed, 1 will be assumed.
faultStatus flag for which faults to include, acceptable values are:
  • 1 - Include only active faults
  • 2 - Include only inactive faults
  • 3 - Include all faults

If no value is passed, 3 will be assumed.

The camelCase capitalization is necessary for this flag to operate correctly.
chkeng Check Engine flag, acceptable values are:
  • 1 - Show only active Check Engine events
  • 0 - Show all Check Engine events

If no value is passed, 1 will be assumed.
stpeng Stop Engine flag, acceptable values are:
  • 1 - Show only active Stop Engine events
  • 0 - Show all Stop Engine events

If no value is passed, 1 will be assumed.

Log Versions 1 and 2 (logvers=1 and logvers=2)

Example Request

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=password&action=showopen&operation=jbusevents&version=2&format=xml&start=1556175600&end=1556218800&logvers=1&target=643&reqtype=fleet&type=Standard

Example Reply

<JBUS_EVENTS class="mozwebext">
 <ASSET>
  <FLEET>643</FLEET>
  <ASSETID>62</ASSETID>
  <VIN>YE2XC82B6H3049576</VIN>
 </ASSET>
 <FAULT>
  <CODE/>
  <SUBCODE/>
  <SUBCODETYPE/>
  <DESC>Tire Pressure // Data Valid But Below Normal Operational Range - Most Severe Level</DESC>
  <FMI>1</FMI>
  <FMIDESC/>
  <STATUS/>
  <ODOMETER>119697125000.0</ODOMETER>
  <OCCURRENCE>127</OCCURRENCE>
  <PROTOCOL>1939</PROTOCOL>
  <TIMESTAMP>2019-04-25 03:12:44-07</TIMESTAMP>
  <LAT>31.8537026</LAT>
  <LONG>-106.4360673</LONG>
 </FAULT>
</JBUS_EVENTS>

Returned XML DTD

<!ELEMENT JBUS_EVENTS (ASSET, FAULT*)>
<!ELEMENT ASSET (FLEET, ASSETID, VIN)>
<!ELEMENT ASSETID (#PCDATA)>
<!ELEMENT FLEET (#PCDATA>
<!ELEMENT VIN (#PCDATA)>
<!ELEMENT FAULT (CODE, SUBCODE, SUBCODETYPE, DESC, FMI, FMIDESC, STATUS, OCCURRENCE, PROTOCOL, TIMESTAMP, LAT, LONG)>
<!ELEMENT CODE (#PCDATA)>
<!ELEMENT SUBCODE (#PCDATA)>
<!ELEMENT SUBCODETYPE (#PCDATA)>
<!ELEMENT DESC (#PCDATA)>
<!ELEMENT FMI (#PCDATA)>
<!ELEMENT FMIDESC (#PCDATA)>
<!ELEMENT STATUS (#PCDATA)>
<!ELEMENT OCCURRENCE (#PCDATA)>
<!ELEMENT PROTOCOL (#PCDATA)>
<!ELEMENT TIMESTAMP (#PCDATA)>
<!ELEMENT LAT (#PCDATA)>
<!ELEMENT LONG (#PCDATA)>
Reply Data
Name Description
ASSETID The database ID for the asset.
FLEET Fleet number. An arbitrary text string of up to 20 characters in length.
VIN The VIN assigned to the asset.
CODE The engine source address for the code
SUBCODE The SPN (J1939) or PID/SID(J1587).
SUBCODETYPE Identifies whether subcode is PID or SID in J1587 protocol, blank in J1939.
DESC Customer assigned description of the event.
FMI The FMI for the event.
FMIDESC Customer assigned description of the FMI.
STATUS Status of the event. Examples are FAULT, FLT_OFF
OCCURRENCE The occurrence count for the event.
PROTOCOL The protocol the event was sent across, either 1939 or 1587.
LAT Latitude recorded for the event.
LONG Longitude recorded for the event.

Log Version 3 (logvers=3)

Example Request

https://omi.zonarsystems.net/interface.php?action=showopen&operation=jbusevents&version=2&format=xml&start=1556175600&end=1556218800&logvers=3

Example Reply

<JBUS_EVENTS class="mozwebext">
 <ASSET id="62" fleet="643" tagid="788900026" vin="YE2XC82B6H3049576">
  <EVENT>
   <TIMESTAMP>1556187164</TIMESTAMP>
   <INSERTTIMESTAMP>1556187210</INSERTTIMESTAMP>
   <PROTOCOL>1939</PROTOCOL>
   <SA>51</SA>
   <FMI>1</FMI>
   <SPN>241</SPN>
   <MID/>
   <PIDSID/>
   <ISPID/>
   <DESC>Tire Pressure // Data Valid But Below Normal Operational Range - Most Severe Level</DESC>
   <ODOMETER>119697125</ODOMETER>
   <ENGINEHOURS/>
   <COOLANTTEMP>34</COOLANTTEMP>
   <OILPRESSURE>4</OILPRESSURE>
   <LAT>31.8537026</LAT>
   <LON>-106.4360673</LON>
   <OC>127</OC>
   <MIL>n/a</MIL>
   <CHKENG>off</CHKENG>
   <STPENG>on</STPENG>
  </EVENT>
 </ASSET>
</JBUS_EVENTS>

Returned XML DTD

<!ELEMENT JBUS_EVENTS (ASSET*)>
<!ELEMENT ASSET (EVENT*)>
<!ATTLIST ASSET id CDATA>
<!ATTLIST ASSET fleet CDATA>
<!ATTLIST ASSET tagid CDATA>
<!ATTLIST ASSET vin CDATA>
<!ELEMENT EVENT(TIMESTAMP, INSERTTIMESTAMP, PROTOCOL, SA, FMI, SPN, MID, PIDSID, ISPID, DESC, ODOMETER, ENGINEHOURS, COOLANTTEMP, OILPRESSURE, LAT, LON, OC, MIL, CHKENG, STPENG) >
<!ELEMENT TIMESTAMP (#PCDATA)>
<!ELEMENT INSERTTIMESTAMP (#PCDATA)>
<!ELEMENT PROTOCOL (#PCDATA)>
<!ELEMENT SA (#PCDATA)>
<!ELEMENT FMI (#PCDATA)>
<!ELEMENT SPN (#PCDATA)>
<!ELEMENT MID (#PCDATA)>
<!ELEMENT PIDSID (#PCDATA)>
<!ELEMENT ISPID (#PCDATA)>
<!ELEMENT DESC (#PCDATA)>
<!ELEMENT ODOMETER (#PCDATA)>
<!ELEMENT ENGINEHOURS (#PCDATA)>
<!ELEMENT COOLANTTEMP (#PCDATA)>
<!ELEMENT OILPRESSURE (#PCDATA)>
<!ELEMENT LAT (#PCDATA)>
<!ELEMENT LON (#PCDATA)>
<!ELEMENT OC (#PCDATA)>
<!ELEMENT MIL (#PCDATA)>
<!ELEMENT CHKENG (#PCDATA)>
<!ELEMENT STPENG (#PCDATA)>
Reply Data for logvers=3
Name Description
ASSET id The database ID for the asset.
ASSET fleet Fleet number. An arbitrary text string of up to 20 characters in length.
ASSET tagid The RFID tag assigned to the asset.
ASSET vin The vin for the asset.
TIMESTAMP The epoch timestamp that the event occurred at.
INSERTTIMESTAMP The epoch timestamp that the event was inserted into the database.
PROTOCOL The protocol the event was reported on.
SA The source address for the event.
FMI The failure mode identifier for the event.
SPN The suspect parameter number for the event
MID The message identification count for the event.
PIDSID The parameter identification or subsystem identification depending on value of ISPID.
ISPID If true then PIDSID is a parameter identifier, if false then PIDSID is a subsystem identifier.
DESC The description of the event.
ODOMETER The odometer value reported at the time of the event in kilometers.
ENGINEHOURS The engine hours reported at the time of the event.
COOLANTTEMP The engine coolant temperature at the time of the event in degrees Celsius.
OILPRESSURE The oil pressure at the time of the event in kilopascals.
LAT The latitude of the vehicle at the time of the event.
LON The longitude of the vehicle at the time of the event.
OC The occurrence count of the event.
MIL The status of the malfunction indicator lamp at the time of the event.
CHKENG The status of the check engine lamp at the time of the event.
STPENG The status of the stop engine lamp at the time of the event.

Log Version 4 (logvers=4)

Example Request

https://omi.zonarsystems.net/interface.php?action=showopen&operation=jbusevents&version=4&format=xml&start=1667260800&end=1668713139&logvers=4

Example Reply

<JBUS_EVENTS class="mozwebext">
 <ASSET id="166" fleet="John-9108 6" tagid="" vin="JohnOld">
  <EVENT>
   <TIMESTAMP>1667334245</TIMESTAMP>
   <INSERTTIMESTAMP>1667334319</INSERTTIMESTAMP>
   <PROTOCOL>2012</PROTOCOL>
   <DTC>B2303</DTC>
   <SA/>
   <FMI/>
   <SPN/>
   <MID/>
   <PIDSID/>
   <ISPID/>
   <DESC>Wiper Park Switch Input</DESC>
   <ODOMETER>212677750</ODOMETER>
   <ENGINEHOURS/>
   <COOLANTTEMP/>
   <OILPRESSURE/>
   <LAT>46.8230285</LAT>
   <LON>-100.7948074</LON>
   <OC/>
   <MIL>off</MIL>
   <CHKENG>off</CHKENG>
   <STPENG>off</STPENG>
  </EVENT>
 </ASSET>
</JBUS_EVENTS>

Returned XML DTD

<!ELEMENT JBUS_EVENTS (ASSET*)>
<!ELEMENT ASSET (EVENT*)>
<!ATTLIST ASSET id CDATA>
<!ATTLIST ASSET fleet CDATA>
<!ATTLIST ASSET tagid CDATA>
<!ATTLIST ASSET vin CDATA>
<!ELEMENT EVENT(TIMESTAMP, INSERTTIMESTAMP, PROTOCOL, SA, FMI, SPN, MID, PIDSID, ISPID, DESC, ODOMETER, ENGINEHOURS, COOLANTTEMP, OILPRESSURE, LAT, LON, OC, MIL, CHKENG, STPENG) >
<!ELEMENT TIMESTAMP (#PCDATA)>
<!ELEMENT INSERTTIMESTAMP (#PCDATA)>
<!ELEMENT PROTOCOL (#PCDATA)>
<!ELEMENT DTC (#PCDATA)>
<!ELEMENT SA (#PCDATA)>
<!ELEMENT FMI (#PCDATA)>
<!ELEMENT SPN (#PCDATA)>
<!ELEMENT MID (#PCDATA)>
<!ELEMENT PIDSID (#PCDATA)>
<!ELEMENT ISPID (#PCDATA)>
<!ELEMENT DESC (#PCDATA)>
<!ELEMENT ODOMETER (#PCDATA)>
<!ELEMENT ENGINEHOURS (#PCDATA)>
<!ELEMENT COOLANTTEMP (#PCDATA)>
<!ELEMENT OILPRESSURE (#PCDATA)>
<!ELEMENT LAT (#PCDATA)>
<!ELEMENT LON (#PCDATA)>
<!ELEMENT OC (#PCDATA)>
<!ELEMENT MIL (#PCDATA)>
<!ELEMENT CHKENG (#PCDATA)>
<!ELEMENT STPENG (#PCDATA)>
Reply Data for logvers=3
Name Description
ASSET id The database ID for the asset.
ASSET fleet Fleet number. An arbitrary text string of up to 20 characters in length.
ASSET tagid The RFID tag assigned to the asset.
ASSET vin The vin for the asset.
TIMESTAMP The epoch timestamp that the event occurred at.
INSERTTIMESTAMP The epoch timestamp that the event was inserted into the database.
PROTOCOL The protocol the event was reported on.
DTC The diagnostic trouble code reported by the event.
SA The source address for the event.
FMI The failure mode identifier for the event.
SPN The suspect parameter number for the event
MID The message identification count for the event.
PIDSID The parameter identification or subsystem identification depending on value of ISPID.
ISPID If true then PIDSID is a parameter identifier, if false then PIDSID is a subsystem identifier.
DESC The description of the event.
ODOMETER The odometer value reported at the time of the event in kilometers.
ENGINEHOURS The engine hours reported at the time of the event.
COOLANTTEMP The engine coolant temperature at the time of the event in degrees Celsius.
OILPRESSURE The oil pressure at the time of the event in kilopascals.
LAT The latitude of the vehicle at the time of the event.
LON The longitude of the vehicle at the time of the event.
OC The occurrence count of the event.
MIL The status of the malfunction indicator lamp at the time of the event.
CHKENG The status of the check engine lamp at the time of the event.
STPENG The status of the stop engine lamp at the time of the event.

Asset Management

See more