Overview

Overview of /vehicle-history-positions

  •  SERVICE DESCRIPTION

This service enables connection through the GHUBEE interface, facilitating integration and providing vehicle tracking information, allowing for efficient route planning.

 

  • INTEGRATION SPECIFICATION
  • Service Details:

Service Name

Vehicle history position

Context

/ELD/vehicle-history-positions

Description

Query vehicle history position information on ELD devices

Endpoint

https://ghubee.com/api/{eld}/vehicle-history-positions

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 history position 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

The Vehicle ID

Parameter

-

No

No

start_date

Start date filter

Filter

-

No

Yes

end_date

End date filter

Filter

-

No

Yes

 

  • Data input example:

Access URL: https://ghubee.com/api/{eld}/vehicle-history-positions?start_date&end_date

Headers - Information that standardizes the submissions

Content-Type: application/json

Accept: application/json

Authorization: Bearer token_ghubee

 

  • ELD-Specific Credentials

Depending on the chosen ELD, you must provide the corresponding credentials as headers:

ELD

Required Headers

Description

truckspy

client-id
client-secret

OAuth credentials from your Truckspy account

multiportal

username
password
appid

MultiPortal login credentials + application ID

geotab

username
password
database

Geotab login credentials + database name

motive

access-token-motive
OR
api-key-eld

Access token or API Key from your Motive account

sandbox

-

No additional credentials required

 

  • Data output

Return of the vehicle history position API output data.

Field

Description

Format

Size

Required

Remarks

vehicle

Vehicle model

String

-

Yes

No

current_driver

Is the current driver of the vehicle

string

-

Yes

No

coordinates_(latitude / longitude)

Coordinate referring to the vehicle's position

Coordinates (format Array) and latitude/longitude (format decimal)

-

Yes

No

adress

Address referring to the location of the vehicle

string

-

Yes

No

odometer

Vehicle odometer

Biginterger

-

Yes

No

timezone

Time and date referring to the vehicle's position

Timestamp

-

Yes

No

batery_voltage

Vehicle battery voltage

string

-

Yes

No

vehicle_status

Identify whether the vehicle is stationary or in motion

string

-

Yes

No

velocity

Returns the vehicle's speed

decimal

-

Yes

No

motor_hour

Number of hours the engine has been running

decimal

-

Yes

No

fuel

fuel identification

decimal

-

Yes

No

primary_fuel_percentage

Percentage of primary fuel in the vehicle

decimal

-

Yes

No

secondary_available_fuel_percentage

Percentage of secondary fuel in the vehicle

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