Retrieve DVIRs

Retrieves a list of driver-vehicle inspection reports (DVIRs) including details on defects found and defects resolved.

SecuritybearerAuth

Request

query Parameters

reportIdentifiers	string ID(s) of the inspection report(s). Example: reportIdentifiers=9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd2,9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd3
groupIdentifier	string ID of the group. Example: groupIdentifier=9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd2
includeSubGroups	boolean If true, all subgroups under the specified group are included. Example: includeSubGroups=false
vehicleIdentifier	string ID of the vehicle. Example: vehicleIdentifier=9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd2
trailerIdentifier	number ID of the trailer. Example: trailerIdentifier=123
startDate	string <date-time> Filter for a specific date-time period.
endDate	string <date-time> Filter for a specific date-time period.
offset	integer or null Record to start with. Example: offset=1500
limit	integer or null Maximum number of records to return. Example: limit=100
sort	string or null Name of the property to sort on. Example: sort=VehicleName
order	string or null Sort direction. Example: order=asc

Responses

200

successful operation

get/v1/dvir

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"data": [{"id": 10,
"creationDate": "2024-01-19T00:00:00.000Z",
"certificationDate": "2024-01-19T00:00:00.000Z",
"location": "Washington DC",
"inspectionType": "pre-trip",
"vehicleId": "9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd2",
"vehicleGroupId": "9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd2",
"vehicleName": "Vehicle example name",
"trailerId": 123,
"trailerGroupId": "9a0c7e3f-b889-40ad-b4da-d9bb84fa8fd2",
"trailerName": "Trailer example name",
"driverName": "John",
"generalNote": "Note comments",
"duration": "0:03:09",
"odometer": 29.5,
"dvirStatus": "Safe",
"inspectionListId": 1,
"inspectionListName": "Some inspection list",
"defects": [{"id": 10,
"name": "inspection point name",
"severityLevel": "Major",
"status": "Resolved",
"notes": {"mobileNoteDescription": "This is a mobile note",
"webNote": {"id": 1,
"description": "This is a web note",
"creationDate": "2024-01-19T00:00:00.000Z",
"creatorName": "The author of the note"
}
},
"isSignedByMechanic": true
}
],
"mechanicSignature": {"vehicle": {"userId": 1,
"firstName": "John",
"lastName": "Lennon",
"userRole": "role"
},
"trailer": {"userId": 1,
"firstName": "John",
"lastName": "Lennon",
"userRole": "role"
}
},
"reviewerSignature": {"vehicle": {"userId": 1,
"firstName": "John",
"lastName": "Lennon",
"userRole": "role"
},
"trailer": {"userId": 1,
"firstName": "John",
"lastName": "Lennon",
"userRole": "role"
}
}
}
],
"metadata": {"count": "30",
"limit": "1",
"offset": "0",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}
}