Get Fix Report (GET)
Get vehicle fix report(s).
Fix reports are a subitem within the diagnostic report. It is generated when a Check Engine Light is detected and there are known repairs for the issue. This report contains information including but not limited to how long the repair will take, the cost of the repair, and information on the part(s) needed.
http://api2.carmd.com/v2.0/report/fix?reportID=reportID1,reportID2
http://api2.carmd.com/v2.0/report/fix?uploadID=uploadID1,uploadID2
http://api2.carmd.com/v2.0/report/fix?vehicleID=vehicleID1,vehicleID2
http://api2.carmd.com/v2.0/report/fix?tag=tag1,tag2
http://api2.carmd.com/v2.0/report/fix?fleetID=fleetID1
http://api2.carmd.com/v2.0/report/fix?fleetID=fleetID&dateCreated=dateCreated
Example
http://api2.carmd.com/v2.0/report/fix?reportID=541655173c10813ac8a0f763
http://api2.carmd.com/v2.0/report/fix?uploadID=537c1d7f3c1081e3981b21e0
http://api2.carmd.com/v2.0/report/fix?vehicleID=541655333c10813ac8a0f766
http://api2.carmd.com/v2.0/report/fix?tag=Cars,Trucks
http://api2.carmd.com/v2.0/report/fix?fleetID=541655173c10813ac8a0f763
http://api2.carmd.com/v2.0/report/fix?fleetID=541655173c10813ac8a0f763&dateCreated={% createddate# %}
URL Parameters
Get fix report by reportID
Field | Type | Notes |
reportID | string | Required. Separate by commas. Retrieves fix report by reportID. |
dateCreated | string | Optional. A filter that excludes reports created before suggested date. |
Get fix report by uploadID
Field | Type | Notes |
uploadID | string | Required. Separate by commas. Retrieves fix report by uploadID. |
dateCreated | string | Optional. A filter that excludes reports created before suggested date. |
Get fix report(s) by vehicleID
Field | Type | Notes |
vehicleID | string | Required. Separate by commas. Retrieves the fix report history of vehicle(s). |
dateCreated | string | Optional. A filter that excludes reports created before suggested date. |
Get report(s) by tag
Field | Type | Notes |
tag | string | Required. Separate by commas. Retrieves the report history of vehicles with this tag. |
dateCreated | string | Optional. A filter that excludes reports created before suggested date. |
Get fix report by fleetID
Field | Type | Notes |
fleetID | string | Required. Retrieves fix reports by fleetID. |
dateCreated | string | Optional. A filter that excludes reports created before suggested date. |
Response
{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Get Fixe Report",
"action": "GET",
"counter": 242
},
"data": [
{
"fixes": [
{
"dateCreated": "0001-01-01T00:00:00",
"name": "Replace Fuel Pressure Regulator",
"desc": "",
"errCode": "P0171",
"errType": 0,
"fixRating": 2,
"laborCost": 238.392,
"laborHours": 2.2,
"laborRate": 108.36,
"partsCost": 123.68,
"additionalCost": 75,
"totalCost": 437.072,
"fixParts": [
{
"name": "Fuel Pressure Regulator",
"desc": "Fuel Pressure Regulator",
"manufacturer": "General Motors",
"partID": "89060422",
"price": 123.68,
"quantity": 1
}
]
},
{
"dateCreated": "0001-01-01T00:00:00",
"name": "Replace Intake Manifold Gasket(s)",
"desc": "",
"errCode": "P0171",
"errType": 0,
"fixRating": 3,
"laborCost": 520.128,
"laborHours": 4.8,
"laborRate": 108.36,
"partsCost": 55.42,
"additionalCost": 75,
"totalCost": 650.548,
"fixParts": [
{
"name": "Engine Intake Manifold Gasket",
"desc": "Engine Intake Manifold Gasket",
"manufacturer": "General Motors",
"partID": "89017866",
"price": 55.42,
"quantity": 1
}
]
}
],
"vehicle": {
"vehicleID": "54eebce83c10811a90a0e4be",
"fleetID": "54ed95a43c1081156ce39471",
"vehCustomID": null,
"vin": "1GNEL19W7YB116796",
"vehName": "2000 CHEVROLET ASTRO",
"year": 2000,
"make": "CHEVROLET",
"model": "ASTRO",
"engine": "W",
"mileage": 500,
"tag": "Cars,White",
"active": true
}
}
],
"pagination": {
"pageSize": 20,
"currentPage": 1,
"itemCount": 1,
"totalPage": 1
}
}
Field | Type | Notes |
message | Message | |
data | list<VehicleFix> | A list of vehicles and a list of fixes for each vehicle. |
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. |
VehicleFix object
Field | Type | Notes |
vehicle | Vehicle | The vehicle these fixes are for. |
fix | list<Fix> | The fixes needed for this vehicle. |
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. |
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. |