Organize Vehicles by Diagnostic Status (GET)
Sort a group of vehicles into Red, Yellow, or Green. This status based upon the current diagnostic condition of the vehicle, whereas:
Red The check engine light is on
Yellow An possible issue has been detected but the vehicle has not yet determined if action is needed
Green Vehicle is fine
http://api2.carmd.com/v2.0/report/organize?orgID=orgID1,orgID2
http://api2.carmd.com/v2.0/report/organize?fleetID=fleetID1,fleetID2
http://api2.carmd.com/v2.0/report/organize?vehicleID=vehicleID1,vehicleID2
http://api2.carmd.com/v2.0/report/organize?fleetID=fleetID&reportType=reportType&detailLvl=detailLvlExample
http://api2.carmd.com/v2.0/report/organize?orgID=537c1d7f3c1081e3981b21e0
http://api2.carmd.com/v2.0/report/organize?fleetID=541655173c10813ac8a0f763
http://api2.carmd.com/v2.0/report/organize?vehicleID=541655333c10813ac8a0f766
http://api2.carmd.com/v2.0/report/organize?fleetID=541655173c10813ac8a0f763&reportType=green,yellow&detailLvl=0URL Parameters
Organize vehicles in orgID
| Field | Type | Notes |
| orgID | string | Required. Separate by commas. Retrieves report by orgID. |
| reportType | string | Required. Separate by commas. A filter that determines which status of report to provide: red – Primary DTC found, check engine light(CEL) is on yellow – Pending DTC detected, CEL is not on green – No DTCs found, vehicles are ok all – Get all. |
| detailLvl | integer | Required. A filter that determines the level of detail to provide: 1 – only respond with the number of vehicles for reportType 2 – respond with the number of vehicles and vehicle data of each vehicle for reportType 3 – respond with the number of vehicles and vehicle data of each vehicle for reportType and detailed diagnostic reports if available. Note: Only Red and Yellow reported vehicles will have diagnostic reports. |
Organize vehicles in fleetID
| Field | Type | Notes |
| fleetID | string | Required. Separate by commas. Retrieves report by fleetID. |
| reportType | integer | Required. A filter that determines which status of report to provide: red – Primary DTC found, check engine light(CEL) is on yellow – Pending DTC detected, CEL is not on green – No DTCs found, vehicles are ok all – Get all. |
| detailLvl | integer | Required. A filter that determines the level of detail to provide: 1 – only respond with the number of vehicles for reportType 2 – respond with the number of vehicles and vehicle data of each vehicle for reportType 3 – respond with the number of vehicles and vehicle data of each vehicle for reportType and detailed diagnostic reports if available. Note: Only Red and Yellow reported vehicles will have diagnostic reports. |
Organize vehicles in vehicleID
| Field | Type | Notes |
| vehicleID | string | Required. Separate by commas. Retrieves report by vehicleID. |
| reportType | integer | Required. A filter that determines which status of report to provide: red – Primary DTC found, check engine light(CEL) is on yellow – Pending DTC detected, CEL is not on green – No DTCs found, vehicles are ok all – Get all. |
| detailLvl | integer | Required. A filter that determines the level of detail to provide: 1 – only respond with the number of vehicles for reportType 2 – respond with the number of vehicles and vehicle data of each vehicle for reportType 3 – respond with the number of vehicles and vehicle data of each vehicle for reportType and detailed diagnostic reports if available. Note: Only Red and Yellow reported vehicles will have diagnostic reports. |
Response
{
"message": {
"code": 0,
"message": "OK",
"credentials": "Valid",
"version": "v2.0.0",
"account": "Free",
"method": "Organize Vehicles by Diagnostic Status ",
"action": "GET",
"counter": 244
},
"red": {
"numVehicle": 0,
"vehicle": [],
"diagReports": []
},
"green": {
"numVehicle": 0,
"vehicle": [],
"diagReports": []
},
"yellow": {
"numVehicle": 1,
"vehicle": [
{
"vehicleID": "54f026583c108148643e3f41",
"fleetID": "54ed95a43c1081156ce39471",
"vehCustomID": "SUZUKI",
"vin": "JS2RD62H265350149",
"vehName": "2006 SUZUKI Areo",
"year": 2006,
"make": "SUZUKI",
"model": "AERIO",
"engine": "6",
"mileage": 7000,
"tag": "Cars,Yellow White",
"active": true
}
],
"diagReports": [
{
"reportID": "54f026c83c10814ea02e2cef",
"fix": [
{
"dateCreated": "0001-01-01T00:00:00",
"name": "Clean Ground Wire",
"desc": "Check engine , body & pcm grounds. Must be clean and tight. ",
"errCode": "P0505",
"errType": 0,
"fixRating": 1,
"laborCost": 108.36,
"laborHours": 1,
"laborRate": 108.36,
"partsCost": 0,
"additionalCost": 25,
"totalCost": 133.36,
"fixParts": null
}
],
"codes": {
"pwrPrimary": "P0505",
"pwrStored": "U1022,P0505",
"pwrPending": "P0505,U1022",
"absPrimary": "",
"absStored": "C0012",
"absPending": "",
"srsPrimary": "",
"srsStored": "B0015",
"srsPending": ""
},
"definition": [
{
"code": "P0505",
"type": "PowerTrain",
"serverity": 0,
"condition": "Engine started, ECT sensor signal more than 140ºF, engine running at idle speed with the throttle closed, and the PCM detected the Actual idle speed was more than or less than the Target idle speed by too great an amount during the test.\n",
"bodyCode": null,
"engineType": null,
"laymansTermsSeverityLevel": 2,
"laymanConditions": "Code P0505 indicates a fault in the Idle Air Control System for a predetermined period of time.",
"laymanTitle": "Idle Air Control System",
"msgInidicatorLampFile": "i_Suzuki_MIL.html",
"msgIndicatorLampFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/i_Suzuki_MIL.html",
"monitorFile": "mt_Suzuki_CCM.html",
"monitorFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/mt_Suzuki_CCM.html",
"monitorType": "CCM",
"patIndicatorLampFile": "",
"patIndicatorLampFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"possibleCauses": "* IAC valve control circuit is open or shorted to ground\n* IAC valve power circuit is open (check power from the relay)\n* IAC valve ground circuit is open\n* IAC valve is damaged or has failed \n* PCM has failed",
"stsIndicatorLampFile": "",
"stsIndicatorLampFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"techTitle": "Idle Speed Control System",
"tciFile": "",
"tciFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"trips": "2"
},
{
"code": "U1022",
"type": "PowerTrain",
"serverity": 1,
"condition": null,
"bodyCode": null,
"engineType": null,
"laymansTermsSeverityLevel": 0,
"laymanConditions": null,
"laymanTitle": null,
"msgInidicatorLampFile": null,
"msgIndicatorLampFileURL": null,
"monitorFile": null,
"monitorFileURL": null,
"monitorType": null,
"patIndicatorLampFile": null,
"patIndicatorLampFileURL": null,
"possibleCauses": null,
"stsIndicatorLampFile": null,
"stsIndicatorLampFileURL": null,
"techTitle": null,
"tciFile": null,
"tciFileURL": null,
"trips": null
},
{
"code": "C0012",
"type": "Abs",
"serverity": 1,
"condition": "",
"bodyCode": null,
"engineType": null,
"laymansTermsSeverityLevel": 0,
"laymanConditions": "",
"laymanTitle": "",
"msgInidicatorLampFile": "",
"msgIndicatorLampFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"monitorFile": "",
"monitorFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"monitorType": "",
"patIndicatorLampFile": "",
"patIndicatorLampFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"possibleCauses": "",
"stsIndicatorLampFile": "",
"stsIndicatorLampFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"techTitle": "Left Front Hydraulic Release Too Long (Subfault)",
"tciFile": "",
"tciFileURL": "http://resources.innova.testing.metafuse.com/ErrorCodeInfo/",
"trips": "0"
},
{
"code": "B0015",
"type": "Srs",
"serverity": 1,
"condition": null,
"bodyCode": null,
"engineType": null,
"laymansTermsSeverityLevel": 0,
"laymanConditions": null,
"laymanTitle": null,
"msgInidicatorLampFile": null,
"msgIndicatorLampFileURL": null,
"monitorFile": null,
"monitorFileURL": null,
"monitorType": null,
"patIndicatorLampFile": null,
"patIndicatorLampFileURL": null,
"possibleCauses": null,
"stsIndicatorLampFile": null,
"stsIndicatorLampFileURL": null,
"techTitle": null,
"tciFile": null,
"tciFileURL": null,
"trips": null
}
],
"vehicle": {
"vehicleID": "54f026583c108148643e3f41",
"fleetID": "54ed95a43c1081156ce39471",
"vehCustomID": "SUZUKI",
"vin": "JS2RD62H265350149",
"vehName": "2006 SUZUKI Areo",
"year": 2006,
"make": "SUZUKI",
"model": "AERIO",
"engine": "6",
"mileage": 7000,
"tag": "Cars,Yellow White",
"active": true
},
"status": {
"report": "Yellow",
"mil": "Not Supported",
"engine": "Red",
"powerTrain": "Red",
"abs": "Yellow",
"srs": "Yellow",
"emission": "Not Ready"
},
"monitor": null,
"freezeFrame": null,
"tsb": [],
"vin": "JS2RD62H265350149",
"mileage": 7000,
"dateCreated": "2015-02-27T08:11:52Z"
}
]
}
}
| Field | Type | Notes |
| message | Message | |
| green | OrgVehicleDTC | An object containing the # of vehicles, vehicleID’s, and diagnostic info for this status. |
| yellow | OrgVehicleDTC | An object containing the # of vehicles, vehicleID’s, and diagnostic info for this status. |
| red | OrgVehicleDTC | An object containing the # of vehicles and vehicleID’s for this status. |
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. |
OrgVehicleDTC object
| Field | Type | Notes |
| numVehicle | integer | Number of vehicles in this status. |
| vehicle | list<Vehicle> | A list of vehicle data of vehicles in this status. |
| diagReports | list<Diagnostic> | The diagnostic report of vehicles in this status. |
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. |
Diagnostic object
| Field | Type | Notes |
| reportID | string | ID used to pull this report from the Get Report API. |
| fix | list<Fix> | A list of possible fixes for this issue. |
| codes | ErrorCode | The error codes retrieved from the vehicle. |
| definition | list<CodeDefinition> | Definitions of the codes retrieved from the vehicle. Contains both laymen and fairly technical information. |
| status | Status | Current status of the various systems, such as check engine light, emission status, etc. |
| tsb | list<TSB> | List of tsbID associated with this issue. |
| monitor | list<KeyValue> | Monitor information at the time when this error occurred. |
| freezeFrame | list<KeyValue> | Freeze frame information at the time when this error occurred. |
| mileage | string | The odometer reading of the vehicle when this issue occurred. |
| dateCreated | string | The date when this error occurred. |
| vehicle | Vehicle | General vehicle information. |
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. |
ErrorCode object
| Field | Type | Notes |
| pwrPrimary | string | The primary powertrain DTC is the DTC that caused an issue severe enough for the check engine light to come on. Also known as the MIL DTC. |
| pwrStored | list<string> | |
| pwrPending | list<string> | These are powertrain DTCs which have occurred at least once and the system is holding onto to see if it reoccurs. If the DTC fails to occur again, it is erased. If it reoccurs it matures into a primary powertrain DTC causing the check engine light to come on. |
| absPrimary | string | The primary ABS DTC is the DTC that caused an issue severe enough for the ABS warning light to come on. Also known as the ABS MIL DTC. |
| absStored | list<string> | |
| absPending | list<string> | Similar to pwrPending but for ABS. |
| srsPrimary | string | The primary SRC DTC is the DTC that caused an issue severe enough for the SRS warning light to come on. Also known as the SRS MIL DTC. |
| srsStored | list<string> | |
| srsPending | list<string> | Similar to pwrPending but for SRS. |
CodeDefinition object
| Field | Type | Notes |
| laymanTitle | string | Easy to understand english name of this error code. |
| code | string | The code of this error code. |
| severity | string | The severity level of this error code. 1 – Ok to ignore for now 2 – Get it looked at soon 3 – Take your car in for a repair ASAP |
| laymanConditions | string | |
| possibleCauses | string | Possible causes that may have triggered this error code to turn on. |
| techTitle | string | Technical / Mechanic term for this error. |
| type | string | |
| condition | string | |
| bodyCode | string | |
| engineType | string | |
| msgInidicatorLampFile | string | |
| msgInidicatorLampFileUrl | string | |
| monitorFile | string | |
| monitorURL | string | |
| monitorType | string | |
| patIndicatorLampFile | string | |
| patIndicatorLampFileUrl | string | |
| stsIndicatorLampFile | string | |
| stsIndicatorLampFileUrl | string | |
| tcilFile | string | |
| tcilFileUrl | string | |
| trips | string |
Status object
| Field | Type | Notes |
| report | string | Overall report status. Which are: red – Primary DTC found, check engine light(CEL) is on yellow – Pending DTC detected, CEL is not on green – No DTCs found, vehicles are ok |
| mil | string | |
| engine | string | |
| powerTrain | string | |
| abs | string | |
| srs | string | |
| emission | string |
TSB object
| Field | Type | Notes |
| tsbID | string | ID of this TSB |
| description | string | Description of the TSB |
| fileName | string | |
| fileURL | string | |
| manufacturer | string | |
| issueDate | DateTime | |
| createdDate | DateTime | |
| updatedDate | DateTime | |
| text | string | |
| system | string | |
| subSystem | string | |
| autoSystem | string | |
| dtcCodes | list<string> | DTC Codes associated with this TSB. |
| categories | list<string> | Categories this TSB falls under. |
Key Value object
| Field | Type | Notes |
| key | string | |
| value | string/int/bool |
Degradation on the one hand it pay someone to do my homework must emancipate itself from the