v1
latestOpenAPI 3.1.02026-07-2617501.1 MBFetch a report by an external ID (v2)
get/v2/inspection_reports/lookup_by_external_id
Query parameters
external_idstring required
Specify the external ID to look up the corresponding inspection report.
integration_namestring required
Specify the integration to which the external ID is associated with.
timestring date
Specify time when the inspection report was recorded.
Headers
X-Time-Zonestring
Specify the timezone for formatting the timestamps.
X-Metric-Unitsboolean
Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units
X-User-Idinteger
Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.
Response
200
Example response
{
"inspection_report": {
"id": 9,
"log_id": 1,
"date": "2016-07-22",
"time": "2016-07-22T14:00:00Z",
"carrier_name": "Demo Carrier",
"vehicle_number": "Demo Vehicle",
"trailer_nums": [
"17"
],
"location": "Omaha, NE",
"city": "Omaha",
"state": "NE",
"status": "corrected",
"mechanic_signed_at": "2016-07-22T14:00:00Z",
"mechanic_signature_url": "https://keep-truckin-development.s3.amazonaws.com/uploads/inspection_report/mechanic_signature_upload/9/open-uri20160712-30633-thc30n?AWSAccessKeyId=AKIAJH12345&Expires=1481274629&Signature=Qi1mXnl0ylJ5tCuds789Ocq44L4%3D",
"driver_signed_at": "2016-07-22T14:00:00Z",
"driver_signature_url": "https://keep-truckin-development.s3.amazonaws.com/uploads/inspection_report/driver_signature_upload/9/open-uri20160729-30645-1jeoj77?AWSAccessKeyId=AKIAJH12345&Expires=1481274629&Signature=Qi1mXnl0ylJ5tCuds789Ocq44L4%3D",
"reviewer_signed_at": "2016-07-22T14:00:00Z",
"reviewer_signature_url": "https://keep-truckin-development.s3.amazonaws.com/uploads/inspection_report/reviewer_signature_upload/9/open-uri20160729-30645-1jeoj77?AWSAccessKeyId=AKIAJH12345&Expires=1481274629&Signature=Qi1mXnl0ylJ5tCuds789Ocq44L4%3D",
"defects": [
{
"defect": {
"id": 5,
"area": "tractor",
"category": "Mirrors"
}
}
],
"vehicle": {
"id": 4,
"number": "Demo Vehicle",
"year": "2016",
"make": "Demo",
"model": "Vehicle",
"vin": "WP0AB2966NS458669"
},
"mechanic": {
"id": 12,
"first_name": "Joe",
"last_name": "Williams",
"email": "joe@example.com",
"status": "active",
"role": "admin"
},
"driver": {
"id": 11,
"first_name": "Demo",
"last_name": "Driver",
"username": "demo_driver",
"status": "active",
"role": "driver"
},
"reviewer": {
"id": 13,
"first_name": "John",
"last_name": "Williams",
"email": "john@example.com",
"status": "active",
"role": "driver"
},
"external_ids": [
{
"external_id": "201",
"integration_name": "generic_tms"
}
],
"entries": [
{
"name": "Tractor Plate #",
"value": "2743186",
"position": 1
}
]
}
}