Get Predicted Repair (GET)

Get predicted repair reports.
Predicted repair reports are reports of possible upcoming issues for that vehicle. The report contains the likelyhood needing that repair occurring within the next 12 months.

http://api2.carmd.com/v2.0/report/predicted?vehicleID=vehicleID1,vehicleID2
http://api2.carmd.com/v2.0/report/predicted?tag=tag1,tag2
http://api2.carmd.com/v2.0/report/predicted?fleetID=fleetID1

Example

http://api2.carmd.com/v2.0/report/predicted?vehicleID=55278bbd41020e10d03b239d
http://api2.carmd.com/v2.0/report/predicted?tag=Cars,Trucks
http://api2.carmd.com/v2.0/report/predicted?fleetID=541655173c10813ac8a0f763

URL Parameters

Get fix report(s) by vehicleID

Field Type Notes
vehicleID string Required. Separate by commas. Retrieves the predicted issue report vehicle(s).

Get report(s) by tag

Field Type Notes
tag string Required. Separate by commas. Retrieves the predicted issue report of vehicles within this tag.

Get fix report by fleetID

Field Type Notes
fleetID string Required. Retrieves predicted issues by fleetID.

Response


{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Premium",
"method": "Get Predicted Repair",
"action": "GET",
"counter": 2
},
"data": [
{
"vehicle": {
"vehicleID": "55278bbd41020e10d03b239d",
"fleetID": "5527867341020e10d03b2370",
"vehCustomID": "CHEVROLET TRAILBLAZER",
"vin": "1GNDT13S322254943",
"vehName": "2002 Chevrolet TRAILBLAZER",
"year": 2002,
"make": "CHEVROLET",
"model": "TRAILBLAZER",
"engine": "L6, 4.2L; DOHC; SEFI",
"mileage": 5000,
"tag": "car, white",
"fuelMpgCombined": "18.00",
"fuelMpgCity": "15.50",
"fuelMpgHighway": "21.50",
"active": true
},
"mileageStart": 0,
"mileageEnd": 45000,
"predictedFixes": [
{
"dateCreated": "0001-01-01T00:00:00",
"name": "Repair Faulty Engine Control Module (ECM) Wiring",
"desc": "Repair Faulty Engine Control Module (ECM) Wiring",
"errCode": "",
"errType": 0,
"fixRating": 2,
"laborCost": 108.36,
"laborHours": 1,
"laborRate": 108.36,
"partsCost": 0,
"additionalCost": 25,
"totalCost": 133.36,
"predictivePercent": 0.14705882352941177,
"predictiveCount": 10,
"fixParts": null
},
{
"dateCreated": "0001-01-01T00:00:00",
"name": "Replace ABS Wheel Speed Sensor",
"desc": "Replace ABS Wheel Speed Sensor",
"errCode": "",
"errType": 0,
"fixRating": 2,
"laborCost": 108.36,
"laborHours": 1,
"laborRate": 108.36,
"partsCost": 82.91888888888889,
"additionalCost": 25,
"totalCost": 216.2788888888889,
"predictivePercent": 0.1323529411764706,
"predictiveCount": 9,
"fixParts": null
},
..........
] }
],
"pagination": {
"pageSize": 0,
"currentPage": 1,
"itemCount": 1,
"totalPage": 1
}
}
Field Type Notes
message Message
data list<PredictedData>

Message object

Field Type Notes
code string Message code.
message string Ok or Failed.
credentials string Valid or Invalid.
version string v2.0.0
account string Free or Premium
method string Name of the API called
action string returns a GET, POST, PUT, DELETE
counter integer Counter for this request. Increments by one for every request made. This is only important for free users who have a limited number of API requests.

PredictedData object

Field Type Notes
vehicle Vehicle Mileage range start of this predicted issue.
mileageStart integer Mileage range start of this predicted issue.
mileageEnd string Mileage range end of this predicted issue.
predictedFixes PredictedRepair Mileage range end of this predicted issue.

Vehicle object

Field Type Notes
vehName string Name of this vehicle.
mileage integer Number of miles this vehicle has travelled.
vin string Vehicle Identification Number.
year string Year this vehicle was manufactured.
make string Make of this vehicle.
model string Model of this vehicle.
engine string Engine type of this vehicle.
vehicleID string CarMD’s generated ID for this vehicle. This ID will always be unique to this fleet.
fleetID string CarMD’s fleet ID for this vehicle.
tag list<string> Tags applied to this vehicle.
vehCustomID string Null or returns the vehCustomID of this vehicle.
active boolean True or False. True if services are available for this vehicle.

Fix object

Field Type Notes
name string Name of the fix.
desc string Description of the fix.
dateCreated string The date when this fix was generated.
errCode string
errType integer
{% fixrating %} integer
laborHours decimal Roughly how long it will take a mechanic to make the repair.
laborRate decimal Roughly how much a mechanic costs per hour.
laborCost decimal Roughly how much it the service of the repair will cost in labor.
partCost decimal Roughly how much the part will cost.
additionalCost decimal Additional costs for misc, such as taxes.
totalCost decimal Roughly the total cost of the repair.
predictivePercent decimal Predictive percent mileage.
predictiveCount int Predictive count.
fixParts FixPart The parts needed for the repair.

FixPart object

Field Type Notes
name string Name of the part that will fix the issue.
desc string Description of the part.
manufacturer string Manufacturer of the part.
partID string ASIC part number of the part.
price decimal The cost of the part.
quantity integer The number of parts needed for the repair.
vinhnGet Predicted Repair