Retrieve DVIR report details

GET/app/v1/dvir/{id}/

Authorization

X-API-KEYstring · headerrequired

Your company's API key.

Path parameters

idintegerrequired

A unique integer value identifying this DVIR — Inspection.

Query parameters

defect_statusstring

No Defect, Corrected or Not Corrected.

driver_idinteger

Filter by driver id.

end_datestring

Only records on or before this date (YYYY-MM-DD).

has_defectsboolean

true for reports with at least one defect, false for clean ones.

progress_statusstring

In Progress or Completed.

safety_statusstring

Driver's verdict: Safe, Unsafe or Resolved.

start_datestring

Only records on or after this date (YYYY-MM-DD).

statusstring

Office review state: New, Reviewed, Closed.

typestring

Filter by equipment type: Vehicle or Trailer.

unit_nostring

Filter by equipment unit number. Comma separated for more than one (e.g. 101,102).

Response

200The record
idinteger
form_namestring

Name of the form used, frozen onto the report when it was started — editing or deleting the form never changes a filed report.

unitobject
Show fields
idinteger
unit_nostring
typeenum

One of: Vehicle Trailer

driverobject
Show fields
idinteger
namestring
divisionobject
Show fields
idinteger
namestring
divisionstring
odometerstring
locationstring
latitudestring (decimal)
longitudestring (decimal)
inspected_atstring (date-time)
durationstring
safety_statusenum

The driver's go/no-go call: Safe, Unsafe or Resolved.

One of: Safe Unsafe Resolved

defect_statusenum

No Defect, Corrected or Not Corrected.

One of: No Defect Corrected Not Corrected

progress_statusenum

In Progress while the driver is filling it in, then Completed.

One of: In Progress Completed

total_itemsinteger
ok_countinteger
defect_countinteger
fixed_countinteger
statusenum

Office review state: New, Reviewed or Closed.

One of: New Reviewed Closed

reviewed_byobject
Show fields
idinteger
namestring
reviewed_atstring (date-time)
completed_atstring (date-time)
added_by_driverboolean
created_byobject
Show fields
idinteger
namestring
created_atstring (date-time)
updated_atstring (date-time)
checklistany

The checklist items as they were when the report was started.

answersany

Everything the driver submitted: answers, photos and signatures.

notesstring
mediaarray of object
Show fields
idinteger
filestring (uri)
media_typeenum

image, video or signature.

One of: image video signature

item_refstring

Which checklist item the file belongs to. Blank for header photos and signatures.

item_namestring
uploaded_byobject
created_atstring (date-time)