Get Scheduled Maintenance (GET)

Get a vehicle’s scheduled maintenance items at a mileage or retrieve a list of all scheduled maintenance items for a vehicle.

http://api2.carmd.com/v2.0/maint?vehicleID=vehicleID
http://api2.carmd.com/v2.0/maint?vehicleID=vehicleID&completionStatus=completionStatus
http://api2.carmd.com/v2.0/maint?vehicleID=vehicleID&minMileage=minMileage&maxMileage=maxMileage

Example

http://api2.carmd.com/v2.0/maint?vehicleID=541655333c10813ac8a0f766
http://api2.carmd.com/v2.0/maint?vehicleID=vehicleID&completionStatus=1
http://api2.carmd.com/v2.0/maint?vehicleID=541655333c10813ac8a0f766&minMileage=1000&maxMileage=5000

URL Parameters

Field Type Notes
vehicleID string Required. The vehicle to provide scheduled maintenance items for.
completionStatus integer Optional. A filter that only includes maintenance items of selected status:
1 – (default) Incomplete
2 – Completed
3 – All
minMileage integer Optional. A filter that only includes maintenance items above a minimum mileageAssigned.
maxMileage integer Optional. A filter that only includes maintenance items below a maximum mileageAssigned

Response


{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Get Scheduled Maintenance",
"action": "GET",
"counter": 234
},
"data": [
{
"name": "manual sm22",
"maintID": "54ed65e93c108151ec26bf6a",
"itemStatus": 0,
"category": "uncompleted",
"cycle": 1000,
"dateCreated": "2015-02-25T06:04:25.772Z",
"dateCompleted": "2015-03-03T04:19:16.337Z",
"mileageAssigned": 0,
"mileageCompleted": 200,
"notes": ",test notes2,test notes3,test notes3",
"isCustom": true,
"completionStatus": true,
"fix": {
"dateCreated": "0001-01-01T00:00:00",
"name": null,
"desc": null,
"errCode": null,
"errType": 0,
"fixRating": 0,
"laborCost": 0,
"laborHours": 0,
"laborRate": 0,
"partsCost": 0,
"additionalCost": 0,
"totalCost": 0,
"fixParts": null
}
},
{
"name": "manual sm1",
"maintID": "54ee952f3c10814b14e60452",
"itemStatus": 0,
"category": "completed",
"cycle": 500,
"dateCreated": "2015-02-26T03:38:23.73Z",
"dateCompleted": null,
"mileageAssigned": 0,
"mileageCompleted": 500,
"notes": null,
"isCustom": true,
"completionStatus": false,
"fix": {
"dateCreated": "0001-01-01T00:00:00",
"name": null,
"desc": null,
"errCode": null,
"errType": 0,
"fixRating": 0,
"laborCost": 0,
"laborHours": 0,
"laborRate": 0,
"partsCost": 0,
"additionalCost": 0,
"totalCost": 0,
"fixParts": null
}
}........
] }
Field Type Notes
message Message
vehicleID string The ID of the vehicle these maintenance items belong to.
data list<Maintenance> A list of maintenance items.

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.

Maintenance object

Field Type Notes
name string Name of the maintenance needed.
maintID string Unique ID of this maint item.
itemStatus integer The status of this maint item as defined by the user. By default, status is:
red=3 – Maintenance item is overdue by 100 miles
yellow=2 – Maintenance item is within +-100 miles of due
green=1 – Maintenance item is +100 miles of being due
category string Category this maintenance item belongs to.
cycle integer The recurring cycle of this maintenance item. On items that are not cyclical, it will return 0(zero), otherwise it will return the number in miles.
Some CarMD maintenance items are not based on constant cyclical rate, in those cases it will return the mileage between the last and next occurrance of this item.
completionStatus boolean If true, then this maintenance was completed.
dateCreated string Date this maintenance item was visible
dateCompleted string Date this maintenance item was last completed.
mileageAssigned integer The original due mileage for this maintenance item.
mileageCompleted integer If the maintenance is not yet completed, it will return [what?]. If the maintenance has been completed, it will return the mileage it was completed at.
notes string Custom notes user can add to this maintenance item
isCustom boolean Indicates if this is a custom maintenance or not
True – Is custom maintenance
False – Is not custom maintenance.
fix list<Fix> [verify, fix seems more applicable to dtc issues, not maint issues]

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.

Note object

Field Type Notes
dateCreated string
notes string

vinhnAPI Get Vehicle Scheduled Maintenance