Modify Vehicle (PUT)
Modify the information of an existing vehicle.
http://api2.carmd.com/v2.0/vehicle
Request Data
{
"vehicleID": "54ed967f3c1081156ce39474",
"fleetID": "54ed95a43c1081156ce39471",
"vin": "WVWTH63B02P078259",
"mileage": 5345,
"active": "true"
}
Field | Type | Notes |
vehicleID | string | Required. The vehicle to modify. |
fleetID | string | Optional. The fleet this vehicle will be assigned to. |
vin | string | Optional. Label this fleet by customID of your choice. customID should be unique. |
mileage | integer | Optional. Accurate mileage is required. |
name | string | Optional. User friendly name for this vehicle. |
customID | string | Optional. Label this vehicle by customID of your choice. customID should be unique. |
tag | list<string> | Optional. Tagging is a way of organizing vehicles within a fleet into groups. A vehicle may have several tags, such as ‘Truck’ and ‘Red’ for example. Tags can be later used to retrieve a list of vins or analytic data. |
active | boolean | Optional. Activate or deactivate vehicles from CarMD services. Activated vehicles are subscribed and billable. Deactivated vehicles retain their current information, but are unable to access CarMD services and are no longer billable. |
Response
{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Update Vehicle",
"action": "PUT",
"counter": 208
},
"data": {
"vehicleID": "54dc717b3c10815130db0f80",
"fleetID": "54d9b5a93c10814380ae0af2",
"vehCustomID": "TOYOTA ABC",
"vin": "JTJBT20X530016947",
"vehName": "TOYOTA unknown",
"year": 2003,
"make": "LEXUS",
"model": "GX",
"engine": "T",
"mileage": 800,
"tag": "Cars,Blue",
"active": true
}
}
Field | Type | Notes |
message | Message | |
data | 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. |
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. |