Modify Scheduled Maintenance (PUT)
This API allows you to modify a scheduled maintenance item for a vehicle or several vehicles.
http://api2.carmd.com/v2.0/maint
Request Data
{
"vehicleID" :["54dd711d3c108152282c831c"],
"data": [{"maintID": "54ed65e93c108151ec26bf6a","name": "manual sm22", "mileageCompleted":"200","completed": "true", "cycle": "1000","notes":[{"note":"test notes3"}]}]
}
Field | Type | Notes |
vehicleID | list<string> | Required. Vehicles whose maintenance items are going to be modified. |
data | list<ModMaint> | Required. A list of ModMaint objects. These objects modify maintenance items for all vehicles in the list. |
ModMaint object
Field | Type | Notes |
maintID | string | Required. ID of maint item to modify. |
name | string | Optional. Name of the maintenance. |
mileageCompleted | integer | Required. This is the mileage in which this maint item was completed. If left blank and completed was toggled to ‘true’, this value defaults to the current mileage of the vehicle. |
completed | boolean | Optional. Toggle completed or uncompleted. |
cycle | integer | Optional. Modify the recurring cycle of this maintenance item. The next upcoming item will be impacted by this modification. |
notes | list<Note> | Optional. This appends a new note. |
Note object
Field | Type | Notes |
dateCreated | string | Optional. |
notes | string | Optional. |
Response
{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Modify Scheduled Maintenance",
"action": "PUT",
"counter": 236
},
"data": [
{
"vehicleID": "54dd711d3c108152282c831c",
"items": [
{
"name": "Change Brake Fluid",
"maintID": "000000000000000000000000",
"itemStatus": 0,
"category": "",
"cycle": 0,
"dateCreated": null,
"dateCompleted": null,
"mileageAssigned": 30000,
"mileageCompleted": 0,
"notes": null,
"isCustom": false,
"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
}
},
{
"name": "manual sm22",
"maintID": "54ed65e93c108151ec26bf6a",
"itemStatus": 0,
"category": "uncompleted",
"cycle": 1000,
"dateCreated": "2015-02-25T06:04:25.772Z",
"dateCompleted": "2015-03-09T08:22:47.458Z",
"mileageAssigned": 0,
"mileageCompleted": 200,
"notes": ",test notes2,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": "Change Engine Coolant",
"maintID": "000000000000000000000000",
"itemStatus": 0,
"category": "",
"cycle": 0,
"dateCreated": null,
"dateCompleted": null,
"mileageAssigned": 30000,
"mileageCompleted": 0,
"notes": null,
"isCustom": false,
"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
}
},
{
"name": "manual sm2",
"maintID": "54ee952f3c10814b14e60453",
"itemStatus": 0,
"category": "uncompleted",
"cycle": 10,
"dateCreated": "2015-02-26T03:38:23.73Z",
"dateCompleted": null,
"mileageAssigned": 0,
"mileageCompleted": 0,
"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 | |
data | list<VehicleMaint> |
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. |
VehicleMaint object
Field | Type | Notes |
vehicleID | string | The vehicleID these items belong to. |
items | list<Maintenance> | The list of maintenance items for this vehicle. |
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 – Maintenance item is overdue by 100 miles yellow – Maintenance item is within +-100 miles of due green – 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 |
Hnlich wie beim hauptdarsteller don vito corleone melden sich bei ihm essay-schreiben.de/ menschen, die seine hilfe brauchen