Overview

SERVICE DESCRIPTION

This service provides access to information related to vehicle and driver usage through the GHUBEE interface. It allows for monitoring and analyzing non-standard driving behaviors such as acceleration, braking, sharp turns, and distractions like cellphone use or eating while driving.

INTEGRATION SPECIFICATION
Service Details

Service Name	Vehicle Utilizations, Driver Utilizations, Idle Events
Context	/ELD/{eld}/vehicle-utilizations, /ELD/{eld}/driver-utilizations, /ELD/{eld}/idle-events
Description	Retrieves information about vehicle utilizations, driver utilizations, and idle events from ELD devices.
Endpoint	https://hml.ghubee.com/api/{eld}/vehicle-utilizations https://hml.ghubee.com/api/{eld}/driver-utilizations https://hml.ghubee.com/api/{eld}/idle-events
Environment Specifications	https://ghubee.com/api
Protocol/Transport	HTTPS
Method	GET
Representation format	JSON
Input/Output Interface or Both	Both
Data transformation	No

Assumption

The service must be invoked with the mandatory fields filled in.

If the request includes data filters, the relevant filter fields must be correctly provided.

Authentication is required to access services within GHUBEE.

Data input

Identification of the input data for the vehicle utilizations API.

Field	Description	Format	Size	Required	Remarks
ELD_name	ELD Name that appears in the URL	Parameter	-	Yes	No
Token_Ghubee	Token that allows GHUBEE to access the ELD	Authorization: Bearer token_ghubee	-	Yes	No
vehicle_id	Vehicle ID	Parameter	-	No	Yes

Identification of the input data for the driver utilizations API.

Field	Description	Format	Size	Required	Remarks
ELD_name	ELD Name that appears in the URL	Parameter	-	Yes	No
Token_Ghubee	Token that allows GHUBEE to access the ELD	Authorization: Bearer token_ghubee	-	Yes	No
driver_id	Driver ID	Parameter	-	No	Yes

Identification of the input data for the idle evnets API.

Field	Description	Format	Size	Required	Remarks
ELD_name	ELD Name that appears in the URL	Parameter	-	Yes	No
Token_Ghubee	Token that allows GHUBEE to access the ELD	Authorization: Bearer token_ghubee	-	Yes	No
driver_id	Driver ID	Parameter	-	No	Yes
vehicle_id	Vehicle ID	Parameter	-	No	Yes
start_date	Start date for utilization records	Parameter	-	No	Yes
end_date	End date for utilization records	Parameter		No	Yes

Data input example

Access URL:

https://hml.ghubee.com/api/{eld}/vehicle-utilizations?vehicle_ids

https://hml.ghubee.com/api/{eld}/driver-utilizations?driver_ids

https://hml.ghubee.com/api/{eld}/idle-events?driver_ids&vehicle_ids&start_date&end_date

Headers - Information that standardizes the submissions

Content-Type: application/json

Accept: application/json

Authorization: Bearer token_ghubee

Data output

Return of the utilizations API output data.

Field	Description	Format	Size	Required	Remarks
id	ID	Biginterger	-	Yes	No
start_time	Start Time	Timestamp	-	Yes	No
end_time	End time	Timestamp	-	Yes	No
veh_fuel_start	Initial Fuel	Decimal	-	Yes	No
veh_fuel_end	End Fuel	Decimal	-	Yes	No
lat	Latitude	Decimal	-	Yes	No
lon	Longitude	Decimal	-	Yes	No
city	City	String	-	Yes	No
state	State	String	-	Yes	No
rg_brg	Rg Brg	Decimal	-	Yes	No
rg_km	Rg Km	Decimal	-	Yes	No
rg_match	Rg Match	Decimal	-	Yes	No
end_type	End Type	String	-	Yes	No
driver	Driver	Array with driver information	-	Yes	No
id	Driver ID	Biginterger	-	Yes	No
first_name	First Name	String	-	Yes	No
last_name	Last Name	String	-	Yes	No
username	User Name	String	-	Yes	No
email	Email	email	-	Yes	No
driver_company_id	Driver Company ID	Biginterger	-	Yes	No
status	Status	String	-	Yes	No
role	Role	String	-	Yes	No
username	driver's username	String	-	Yes	No
vehicle	Vehicle	Array with driver information	-	Yes	No
id	Vehicle ID	Biginterger	-	Yes	No
number	Vehicle number	String	-	Yes	No
year	Year of the vehicle	Biginterger	-	Yes	No
make	Make of the vehicle	String	-	Yes	No
model	Model of the vehicle	String	-	Yes	No
vin	Vehicle identification number	String	-	Yes	No
metric_unit	unit of measurement (kilometer or mile)	Boolean	-	Yes	No
eld_device	ELD device information	Array with ELD device information	-	Yes	No
id	ELD ID	Biginterger	-	Yes	No
identifier	ELD identifier	String	-	Yes	No
model	ELD device model	String	-	Yes	No
location	Location	String	-	Yes	No
utilization	Utilization	Decimal	-	Yes	No
idle_time	Idle Time	Biginterger	-	Yes	No
idle_fuel	Idle Fuel	Decimal	-	Yes	No
driving_time	Driving Time	Biginterger	-	Yes	No
driving_fuel	Driving Fuel	Decimal	-	Yes	No

Error messages

Identification and description of error message types.

Situation	Message Code	Message description
Unauthenticated	{ "status": "Error", "message": "Unauthenticated", "data": null }	Authentication error with GHUBEE.
The user is not enabled. Please enable the integration through the web panel	{ "status": "Error", "message": "The user is not enabled. Please enable the integration through the web panel.", "data": null }	Authentication error with the ELD.
Vehicle not found	{ "status": "Error", "message": "vehicle not found", "data": null }	The vehicle ID was not identified.
Integration not found	{ "status": "Error", "message": "Integration not found", "data": null }	Some data was entered incorrectly