Status Operational Status

HOS Summary ELD

  • Last edited on

This API call is used to return a summary of ELD driver logs and the time left on each clock.

The requested driver's HOS summary includes the current day as well as the previous 7 days. Any driver in the account can be targeted, one at a time.

Required Information
Name Description
action adminhos
operation eldhossummary
format xml
version API protocol version - version 2 only
target Driver database identifier (ID)

Must be used in conjunction with reqtype to specify type of ID.
reqtype A value used to interpret the target value. Valid options are:
    • dbid - The Zonar database id for the driver.
    • tagid - The tagid assigned to the driver.
    • exsid - The exsid assigned to the driver.

Example Request

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=adminhos&operation=eldhossummary&target=70&customer=abc1234&version=2&reqtype=dbid&format=xml

Returned Information

Name Description 
hossummary
 Root element of response 
driver 
 Root element for list of entries for a driver 
entry 
 Root element of individual entry values 
start_epoch 
 Start time, as an epoch, for the day 
end_epoch 
 End time, as an epoch, for the day 
cycle_available 
 Cycle available duration in seconds 
driving_available 
 Driving time duration in seconds 
last_update 
 Last update time as an epoch 
miles 
 Distance traveled in meters 
on_duty_available 
 On duty available duration in seconds 
off_duty_hours 
 Off duty hours in seconds 
on_duty_driving_used
 On duty driving used in seconds 
on_duty_not_driving_used 
 On duty not driving used in seconds 
sleeper
 Sleeper time in seconds

Example Reply XML

<hossummary>
 <driver empnum="" exsid="" id="70" tagid="133382184">
  <entry>
   <start_epoch>1551070800</start_epoch>
   <end_epoch>1551122615</end_epoch>
   <cycle_available>216000</cycle_available>
   <driving_available>39600</driving_available>
   <last_update>1551122615</last_update>
   <miles>0</miles>
   <on_duty_available>43200</on_duty_available>
   <off_duty_hours>51815</off_duty_hours>
   <on_duty_driving_used>0</on_duty_driving_used>
   <on_duty_not_driving_used>0</on_duty_not_driving_used>
   <sleeper>0</sleeper>
  </entry>
 </driver>
</hossummary>

 

 

ELD