Overview of /vehicle-inspection-reports
- SERVICE DESCRIPTION
This service enables connection through the GHUBEE interface, facilitating integration and providing vehicle inspection reports recorded on ELD devices, including inspection date and location, odometer, reported defects, inspected parts and the signatures of driver, mechanic and reviewer.
This service is currently available for the motive integration.
- INTEGRATION SPECIFICATION
- Service Details:
|
Service Name |
Vehicle inspection reports |
|
Context |
/ELD/vehicle-inspection-reports |
|
Description |
Query vehicle inspection report information on ELD devices |
|
Endpoint |
|
|
Environment Specifications |
https://app.ghubee.com/api |
|
Protocol/Transport |
HTTPS |
|
Method |
GET |
|
Representation format |
JSON |
|
Input/Output Interface or Both |
Both |
|
Data transformation |
Yes |
- 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 inspection reports API.
|
Field |
Description |
Format |
Size |
Required |
Remarks |
|
ELD_name |
ELD Name that appears in the URL |
Parameter |
- |
Yes |
Supported: motive |
|
Token_Ghubee |
Token that allows GHUBEE to access the ELD |
Authorization: Bearer token_ghubee |
- |
Yes |
No |
|
version |
Inspection reports version used at the ELD |
Filter |
- |
No |
Accepted: v1 and v2. Default: v1 |
|
driver_ids |
Driver ID filter |
Filter |
- |
No |
driver_ids[]=1&driver_ids[]=2 or driver_ids=1,2 |
|
vehicle_ids |
Vehicle ID filter |
Filter |
- |
No |
vehicle_ids[]=1&vehicle_ids[]=2 or vehicle_ids=1,2 |
|
asset_ids |
Asset ID filter |
Filter |
- |
No |
Only applied when version=v2 |
|
entity_type |
Entity type filter |
Filter |
- |
No |
Only applied when version=v2 |
|
status |
Inspection report status filter |
Filter |
- |
No |
Some values are exclusive to one version |
|
start_date |
Start date filter |
Filter |
- |
No |
Format: YYYY-MM-DD (e.g. 2026-07-10) |
|
end_date |
End date filter |
Filter |
- |
No |
Format: YYYY-MM-DD (e.g. 2026-07-15) |
|
updated_after |
Returns only reports updated after the informed date |
Filter |
- |
No |
Can be combined with start_date and end_date |
|
per_page |
Number of records per page |
Filter |
- |
No |
Default: 25 |
|
page_no |
Page number |
Filter |
- |
No |
Default: 1. The first page is 1 |
- Status values per version
Identification of the status values accepted by each version.
|
Status |
v1 |
v2 |
Remarks |
|
with_defects |
Yes |
Yes |
No |
|
unknown |
Yes |
No |
Exclusive to version v1 |
|
open, acceptable, resolved, satisfactory |
No |
Yes |
Exclusive to version v2 |
- Data input example:
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 |
|
motive |
access-token-motive |
Access token or API Key from your Motive account |
- Data output
Return of the vehicle inspection reports API output data.
|
Field |
Description |
Format |
Size |
Required |
Remarks |
|
version |
Version used in the request |
String |
- |
Yes |
No |
|
report_id |
Inspection report ID |
Biginterger |
- |
Yes |
No |
|
driver_log_id |
Driver log ID |
Biginterger |
- |
Yes |
No |
|
inspection_date |
Date of the inspection |
String |
- |
Yes |
No |
|
inspection_time |
Time of the inspection |
String |
- |
Yes |
No |
|
odometer |
Vehicle odometer at the inspection |
decimal |
- |
Yes |
Unit according to metric_units |
|
status |
Inspection report status |
String |
- |
Yes |
No |
|
location |
Location of the inspection |
String |
- |
Yes |
No |
|
mechanic_signed_at |
Date and time of the mechanic signature |
Timestamp |
- |
Yes |
No |
|
mechanic_signature_url |
Mechanic signature image URL |
String |
- |
Yes |
No |
|
driver_signed_at |
Date and time of the driver signature |
Timestamp |
- |
Yes |
No |
|
driver_signature_url |
Driver signature image URL |
String |
- |
Yes |
No |
|
reviewer_signed_at |
Date and time of the reviewer signature |
Timestamp |
- |
Yes |
No |
|
reviewer_signature_url |
Reviewer signature image URL |
String |
- |
Yes |
No |
|
external_ids |
External identifiers of the report |
Array |
- |
Yes |
Returned as provided by the ELD |
|
entries |
Inspection report entries |
Array |
- |
Yes |
Returned as provided by the ELD |
|
inspection_type |
Type of inspection |
String |
- |
Yes |
No |
|
declaration |
Declaration of the vehicle condition |
String |
- |
Yes |
No |
|
inspection_duration |
Duration of the inspection |
decimal |
- |
Yes |
No |
|
carrier_name |
Carrier name |
String |
- |
Yes |
Only for version v1 |
|
v_number |
Vehicle number |
String |
- |
Yes |
Only for version v1 |
|
trailer_numbers |
Trailer numbers |
Array |
- |
Yes |
Only for version v1 |
|
city |
City of the inspection |
String |
- |
Yes |
Only for version v1 |
|
state |
State of the inspection |
String |
- |
Yes |
Only for version v1 |
|
defects |
Defects reported in the inspection |
Array with defect information |
- |
Yes |
Only for version v1 |
|
id |
Defect ID |
Biginterger |
- |
Yes |
No |
|
category |
Defect category |
String |
- |
Yes |
No |
|
notes |
Defect notes |
String |
- |
Yes |
No |
|
type |
Defect type |
String |
- |
Yes |
No |
|
picture_url |
Defect picture URL |
String |
- |
Yes |
No |
|
area |
Area of the defect |
String |
- |
Yes |
No |
|
entity_num |
Entity number |
String |
- |
Yes |
Only for version v2 |
|
entity_type |
Entity type |
String |
- |
Yes |
Only for version v2 |
|
is_rejected |
Identify whether the inspection was rejected |
Boolean |
- |
Yes |
Only for version v2 |
|
not_inspected_parts |
Parts that were not inspected |
Array |
- |
Yes |
Only for version v2 |
|
asset |
Asset associated with the inspection |
Array with asset information |
- |
Yes |
Only for version v2 |
|
inspected_parts |
Inspected parts |
Array with part information |
- |
Yes |
Only for version v2 |
|
id |
Part ID |
Biginterger |
- |
Yes |
No |
|
category |
Part category |
String |
- |
Yes |
No |
|
notes |
Part notes |
String |
- |
Yes |
No |
|
type |
Part type |
String |
- |
Yes |
No |
|
picture_url |
Part picture URL |
String |
- |
Yes |
No |
|
status |
Part status |
String |
- |
Yes |
No |
|
defects |
Defects found in the part |
Array |
- |
Yes |
Returned as provided by the ELD |
|
mechanic_details |
Mechanic details of the part |
Array |
- |
Yes |
Returned as provided by the ELD |
|
vehicle |
Vehicle information |
Array with vehicle information |
- |
Yes |
No |
|
id |
Vehicle ID |
Biginterger |
- |
Yes |
No |
|
number |
Vehicle number |
String |
- |
Yes |
No |
|
year |
Year of the vehicle |
String |
- |
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_units |
Unit of measurement (kilometer or mile) |
Boolean |
- |
Yes |
No |
|
mechanic |
Mechanic information |
Array with mechanic information |
- |
Yes |
No |
|
id |
Mechanic 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 address |
String |
- |
Yes |
No |
|
driver_company_id |
Company ID |
String |
- |
Yes |
No |
|
status |
Activity status |
String |
- |
Yes |
No |
|
role |
Role |
String |
- |
Yes |
No |
|
driver |
Driver information |
Array with driver information |
- |
Yes |
Same fields as mechanic |
|
reviewer |
Reviewer information |
Array with reviewer information |
- |
Yes |
Same fields as mechanic |
|
pagination |
Pagination information |
Array |
- |
Yes |
No |
|
per_page |
Number of records per page |
Biginterger |
- |
Yes |
No |
|
page_no |
Page number |
Biginterger |
- |
Yes |
No |
|
total |
Total number of records |
Biginterger |
- |
Yes |
No |
All fields are always returned. When the ELD does not provide the information, the field is returned with a null or empty value.
- Error messages
Identification and description of error message types.
|
Situation |
Message Code |
Message description |
|
Unauthenticated |
{ |
Authentication error with GHUBEE. |
|
The user is not enabled. Please enable the integration through the web panel |
{ |
Authentication error with the ELD. |
|
Integration not found |
{ |
Some data was entered incorrectly |
|
Motive not found |
{ |
The ELD integration was not located for the user. |
|
The token reset was not completed |
{ |
The ELD access token could not be renewed. |
|
Status not available for the selected version |
{ |
The status filter is exclusive to another version and no records were found. |
|
Provider error |
{ |
Error returned by the ELD, such as invalid credentials or invalid parameters. |
|
Communication error |
{ |
Communication failure with the ELD. |
|
Too many requests |
{ |
The limit of 200 requests per minute was exceeded. |
