Get Vehicle (GET)

Retrieve a list of vehicles based on filter criteria or look up a single vehicle.

http://api2.carmd.com/v2.0/vehicle?vehicleID=vehicleID1,vehicleID2
http://api2.carmd.com/v2.0/vehicle?vin=vin1,vin2
http://api2.carmd.com/v2.0/vehicle?name=name1,name2
http://api2.carmd.com/v2.0/vehicle?fleetID=fleetID1,fleetID2
http://api2.carmd.com/v2.0/vehicle?orgID=orgID1,orgID2
http://api2.carmd.com/v2.0/vehicle?customID=customID1,customID2
http://api2.carmd.com/v2.0/vehicle?fleetID=fleetID1&minMileage=minMileage&maxMileage=maxMileage&tag=tag1,tag2&active=active

Example

http://api2.carmd.com/v2.0/vehicle?vehicleID=541655333c10813ac8a0f766
http://api2.carmd.com/v2.0/vehicle?vin=1FTRW08L83KA45961
http://api2.carmd.com/v2.0/vehicle?name=Joes%20Car,Bobs%20Truck
http://api2.carmd.com/v2.0/vehicle?fleetID=541655173c10813ac8a0f763
http://api2.carmd.com/v2.0/vehicle?orgID=537c1d7f3c1081e3981b21e0
http://api2.carmd.com/v2.0/vehicle?customID=id123,id456
http://api2.carmd.com/v2.0/vehicle?fleetID=541655173c10813ac8a0f763&minMileage=1000&maxMileage=5000&tag=Cars,Trucks&active=true

URL Parameters

Get by vehicleID

Field Type Notes
vehicleID string Required. Separate by commas. Get information on a or a list of vehicles. Optional parameters are accepted and will filter out vehicles that do not meet the criteria.
minMileage integer Optional. A filter that excludes vehicles below a minimum mileage.
maxMileage integer Optional. A filter that excludes vehicles above a maximum mileage.
tag string Optional. Separate by commas. A filter that excludes vehicles without that tag/those tags.
active boolean Optional. A filter that only includes vehicles of a certain active state.

Get by vin

Field Type Notes
vin string Required. Separate by commas. Get information on a or a list of vehicles by vin. Optional parameters are accepted and will filter out vehicles that do not meet the criteria.
minMileage integer Optional. A filter that excludes vehicles below a minimum mileage.
maxMileage integer Optional. A filter that excludes vehicles above a maximum mileage.
tag string Optional. Separate by commas. A filter that excludes vehicles without that tag/those tags.
active boolean Optional. A filter that only includes vehicles of a certain active state.

Get by name

Field Type Notes
vin string Required. Separate by commas. Get information on a or a list of vehicles by name. Optional parameters are accepted and will filter out vehicles that do not meet the criteria.
minMileage integer Optional. A filter that excludes vehicles below a minimum mileage.
maxMileage integer Optional. A filter that excludes vehicles above a maximum mileage.
tag string Optional. Separate by commas. A filter that excludes vehicles without that tag/those tags.
active boolean Optional. A filter that only includes vehicles of a certain active state.

Get by fleetID

Field Type Notes
vin string Required. Separate by commas. Get information on a or a list of vehicles by fleetID. Optional parameters are accepted and will filter out vehicles that do not meet the criteria.
minMileage integer Optional. A filter that excludes vehicles below a minimum mileage.
maxMileage integer Optional. A filter that excludes vehicles above a maximum mileage.
tag string Optional. Separate by commas. A filter that excludes vehicles without that tag/those tags.
active boolean Optional. A filter that only includes vehicles of a certain active state.

Get by orgID

Field Type Notes
vin string Required. Separate by commas. Get information on a or a list of vehicles by orgID. Optional parameters are accepted and will filter out vehicles that do not meet the criteria.
minMileage integer Optional. A filter that excludes vehicles below a minimum mileage.
maxMileage integer Optional. A filter that excludes vehicles above a maximum mileage.
tag string Optional. Separate by commas. A filter that excludes vehicles without that tag/those tags.
active boolean Optional. A filter that only includes vehicles of a certain active state.

Get by customID

Field Type Notes
vin string Required. Separate by commas. Get information on a or a list of vehicles by customID. Optional parameters are accepted and will filter out vehicles that do not meet the criteria.
minMileage integer Optional. A filter that excludes vehicles below a minimum mileage.
maxMileage integer Optional. A filter that excludes vehicles above a maximum mileage.
tag string Optional. Separate by commas. A filter that excludes vehicles without that tag/those tags.
active boolean Optional. A filter that only includes vehicles of a certain active state.

Response


{

    "message": {

        "code": 0,

        "message": "OK",

        "credentials": "Valid",

        "version": "v2.0.0",

        "account": "Free",

        "method": "Get Vehicle",

        "action": "GET",

        "counter": 211

    },

    "data": [

        {

            "vehicleID": "54dc3ee13c108145cc85a46f",

            "fleetID": "54dc23d73c108148a02908de",

            "vehCustomID": null,

            "vin": "1G8ZP12822Z134500",

            "vehName": "",

            "year": 2002,

            "make": "SATURN",

            "model": "SC1",

            "engine": "8",

            "mileage": 100,

            "tag": "Cars,Blue",

            "fuelMpgCombined": "26.50",

            "fuelMpgCity": "24.50",

            "fuelMpgHighway": "30.00",

            "active": false

        },

        {

            "vehicleID": "54dc49103c1081576c0de4db",

            "fleetID": "54dc23d73c108148a02908de",

            "vehCustomID": null,

            "vin": "1FTRW08L83KA45961",

            "vehName": "Ford Explorer Red",

            "year": 2003,

            "make": "FORD",

            "model": "F150",

            "engine": "L",

            "mileage": 200,

            "tag": "Cars,Blue",

            "fuelMpgCombined": "27.50",

            "fuelMpgCity": "24.50",

            "fuelMpgHighway": "30.00",

            "active": false

        }....

    ],

    "pagination": {

        "pageSize": 0,

        "currentPage": 1,

        "itemCount": 19,

        "totalPage": 1

    }

}
Field Type Notes
message Message
data list<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.

State and the church college paper writing services hold in reserve for such cases.