Add Vehicle (POST)
Adds a new vehicle to your account. This is required to enable CarMD services for that vehicle aside from VIN accessible APIs.
http://api2.carmd.com/v2.0/vehicle
Request Data
{
"fleetID" :"54ed95a43c1081156ce39471",
"vin" : "JS2RD62H265350149",
"mileage" :"7000",
"name" :"2006 SUZUKI Areo",
"customID": "SuZUKI",
"tag" : [ "Cars", "Yellow White" ]
}
Field | Type | Notes |
fleetID | string | Required. The fleet this vehicle will be assigned to. |
vin | string | Required. Label this fleet by customID of your choice. customID should be unique. |
mileage | integer | Required. 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. Determine if this vehicle should immediately subscribe to CarMD services or not. By default, if the active state is not included in the request, the vehicle is automatically subscribed and billable. |
Response
{
"Message": {
"Code": 0,
"Message": "OK",
"Credentials": "Valid",
"Version": "2.0.0",
"Account": "Free",
"Method": "Add Vehicle",
"Action": "POST",
"Counter": 296
},
"data": {
"vehicleID": "54f026583c108148643e3f41",
"fleetID": "54ed95a43c1081156ce39471",
"vehCustomID": "SUZUKI",
"vin": "WVWTH63B02P078259",
"vehName": "2006 SUZUKI Areo",
"year": 2006,
"make": "SUZUKI",
"model": "AERIO",
"engine": "6",
"mileage": 7000,
"fuelMpgCombined": "26.50",
"fuelMpgCity": "24.50",
"fuelMpgHighway": "30.00",
"tag": "Cars,Yellow White",
"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. |
fuelMpgCombined | string | |
fuelMpgCity | string | |
fuelMpgHighway | string | |
vehCustomID | string | Null or returns the vehCustomID of this vehicle. |
active | boolean | True or False. True if services are available for this vehicle. |
Empire under an interdict, but he cannot reign http://writemyessay4me.org/ there?