Get Maintenance Status Policies (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/maintstatuspolicy?maintStatPolicyID=maintStatPolicyID1,maintStatPolicyID2
http://api2.carmd.com/v2.0/maintstatuspolicy?vehicleID=vehicleID1,vehicleID2
http://api2.carmd.com/v2.0/maintstatuspolicy?fleetIDs=fleetID1,fleetID2

Example

http://api2.carmd.com/v2.0/maintstatuspolicy?maintStatPolicyID=maintStatPolicyID1,maintStatPolicyID2
http://api2.carmd.com/v2.0/maintstatuspolicy?vehicleID=541655333c10813ac8a0f766
http://api2.carmd.com/v2.0/maintstatuspolicy?fleetID=541655173c10813ac8a0f763

URL Parameters

Get by all

Use the url without parameters or use the top level organization

Field Type Notes

Get by maintStatPolicyID

Field Type Notes
maintStatPolicyID string Required. Separate by commas. Get policy on a or a list of maintStatPolicyIDs.

Get by vehicleID

Field Type Notes
vehicleID string Required. Separate by commas. Get policy on a or a list of vehicles.

Get by fleetID

Field Type Notes
fleetID string Required. Separate by commas. Get policy on a or a list of fleets.

Get by orgID

Field Type Notes
orgID string Required. Separate by commas. Get policy on a or a list of organization.

Response


{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Get Maintenance Status Policies",
"action": "GET",
"counter": 229
},
"data": [
{
"fleet": {
"fleetID": "54dd70c03c10815228b1cd40",
"fleetCustomID": "Fleet_001",
"fleetName": "Fleet_001",
"email": "tramd@carmd.com",
"country": null,
"orgName": "org_0111",
"orgID": "54dd6eed3c10815228b1cd15"
},
"vehicles": [
{
"vehicle": {
"vehicleID": "54dc6adf9fbcdf3c40e5a4b7",
"fleetID": "54dc23d73c108148a02908de",
"vehCustomID": null,
"vin": "1B7GL22X4YS781343",
"vehName": "Toyota Crolla",
"year": 2000,
"make": "DODGE",
"model": "DAKOTA",
"engine": "X",
"mileage": 100,
"tag": "Cars,White",
"active": true
},
"policies": [
{
"maintStatPolicyID": "54d9982135201017dc2e9aad",
"name": "Policy1",
"minMileage": 1000,
"maxMileage": 19000,
"dateCreated": "2015-02-10T05:33:21.036Z",
"updateDate": "2015-02-10T06:01:48.271Z"
},
{
"maintStatPolicyID": "54d9a47635201004f8e97320",
"name": "Policy4",
"minMileage": 1200,
"maxMileage": 19000,
"dateCreated": "2015-02-10T06:25:58.096Z",
"updateDate": null
}
] },
{
"vehicle": {
"vehicleID": "54ee93923c10814b14e60447",
"fleetID": "54dd70c03c10815228b1cd40",
"vehCustomID": null,
"vin": "2HGES16525H550717",
"vehName": "toyota",
"year": 2005,
"make": "HONDA",
"model": "CIVIC",
"engine": "ES1",
"mileage": 1000,
"tag": "",
"active": true
},
"policies": [
{
"maintStatPolicyID": "54d9982135201017dc2e9aad",
"name": "Policy1",
"minMileage": 1000,
"maxMileage": 19000,
"dateCreated": "2015-02-10T05:33:21.036Z",
"updateDate": "2015-02-10T06:01:48.271Z"
},
{
"maintStatPolicyID": "54d9a47635201004f8e97320",
"name": "Policy4",
"minMileage": 1200,
"maxMileage": 19000,
"dateCreated": "2015-02-10T06:25:58.096Z",
"updateDate": null
}
] }
] }
],
"pagination": {
"pageSize": 2147483647,
"currentPage": 1,
"itemCount": 1,
"totalPage": 1
}
}
Field Type Notes
message Message
data list<FleetWithMSPolicy> A list of all fleets with that policy or listing all policies (depending on your get criteria). Each fleet then contains a list of vehicles with a list of policies.

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.

FleetWithMSPolicy object

Field Type Notes
fleet Fleet The fleet information.
vehicle list<VehicleWithMSPolicy> List of vehicles with their policies

Fleet object

Field Type Notes
fleetname string User selected name for this fleet.
orgName string Name of the org this fleet belongs under.
email string Contact email of the fleet admin.
fleetID string CarMD’s generated ID for this fleet. This ID will always be unique to this fleet.
orgID string CarMD’s organization ID for this fleet.
fleetcustomID string Null or returns the customID of this fleet.
country string Null or the county this fleet is in.

VehicleWithPolicy object

Field Type Notes
vehicle Vehicle Vehicle data.
policy list<MaintStatusPolicy> List of policies for this vehicle.

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.

MaintStatusPolicy object

Field Type Notes
maintStatPolicyID string The ID of this policy.
name string The name of this policy.
minMileage integer The minimum mileage range for this status.
maxMileage integer The maximum mileage range for this status.
dateCreated string Date this policy was created.
updatedDate string Date this policy was last updated.

And beauty to the orderessayonline reviews depths of vulgar humanity.
vinhnGet Maintenance Status Policies