Connected Diagnosis Specification
Plug the WebHook
You need to provide an endpoint to receive a POST request with the following json body.
Auth will be adapted with CaRool's team
Request properties
| Property | Not null | Type | Description |
|---|---|---|---|
creationDate | yes | String | Date of creation |
reportUrl | yes | String | PDF URL of the report |
vehicle | yes | VehicleObjet | All vehicle information |
front | yes | AxleObjet | Front axle information |
rear | yes | AxleObjet | Rear axle information |
recommendations | yes | Array[RecommendationObject] | Car recommendations |
VehicleObject
| Property | Not null | Type | Description |
|---|---|---|---|
license | yes | String | Vehicle registration number |
externalId | no | String | External ID provided by external system to trigger the diagnosis |
brand | no | String | Brand of the vehicle |
model | no | String | Model of the vehicle |
AxleObject
| Property | Not null | Type | Description |
|---|---|---|---|
left | yes | TyreObject | Left tyre information |
right | yes | TyreObject | Right tyre information |
geometryNecessary | no | Boolean | Is geometry required on the axle |
TyreObject
| Property | Not null | Type | Description |
|---|---|---|---|
data | yes | DataObject | Raw tyre information |
report | yes | ReportObject | Pre-calculated report information |
DataObject
| Property | Not null | Type | Description |
|---|---|---|---|
reference | yes | ReferenceObject | Identification of the tyre |
wear | yes | WearObject | Wear of the tyre |
anomaly | no | AnomalyObject | Anomalies on the tyre |
ReferenceObject
| Property | Not null | Type | Description |
|---|---|---|---|
width | yes | Integer | Tyre width |
ratio | yes | Integer | Tyre ratio |
diameter | yes | Integer | Tyre diameter |
loadIndex | yes | Integer | Tyre load index |
speedIndex | yes | String | Tyre speed index |
is3pmsf | yes | Boolean | Tyre is marked with 3PMSF |
season (new) | no | Boolean | Season of the tyre |
mPlusS (new) | no | Boolean | Tyre is marked with M+S |
WearObject
| Property | Not null | Type | Description |
|---|---|---|---|
maxWearPercent | yes | Integer | Maximum percentage of wear on the tyre |
grooves | yes | Array[GrooveObject] | All tyre wear raw data |
GrooveObject
| Property | Not null | Type | Description |
|---|---|---|---|
grooveNumber | yes | Integer | Groove position (from the outside to the inside of the tyre) |
wearPercent | yes | Integer | percentage of wear on the groove |
depth | yes | Double | Depth left on the groove (mm) |
AnomalyObject
| Property | Not null | Type | Description |
|---|---|---|---|
cracks | yes | Boolean | Crack is visible on the tread |
cut | yes | Boolean | Cut is visible on the sidewall |
objects | yes | Boolean | Object is visible on the tread |
ageLimitExceeded | yes | Boolean | Tyre over age limit (default is 10 years) |
damaged | yes | Boolean | Tread is damaged |
shoulderWear | yes | Boolean | Uneven wear level, cause by wheel alignment issue |
hernia | yes | Boolean | Hernia visible on the tread |
ReportObject
| Property | Not null | Type | Description |
|---|---|---|---|
color | yes | String | Color of the label displayed |
dimension | yes | String | Dimension of the tyre |
mountainLabel | yes | String | Type of tyre marking (3PMSF / Season) |
grooves | yes | String | Count of the grooves |
wearPercents | yes | String | Corresponding wear measures |
recommendations | yes | Array[RecommendationTyreObject] | All tyre recommendations |
RecommendationTyreObject
| Property | Not null | Type | Description |
|---|---|---|---|
code | yes | String | Recommendation code |
label | yes | String | Recommendation label |
Available RecommendationTyreCode
| Code | Description |
|---|---|
OK | Tyre is in good condition |
TO_BE_PLANNED | Tread is low, replacement will be needed soon |
WORN_TYRE_TO_BE_REPLACED | Tread is low, replacement needed |
TO_BE_REPLACED | Need to be replaced because other axle is worn (4x4 vehicle) |
CONTRAVENTION | Tread low at the limit, replacement urgent required |
SEVERAL_ANOMALY | Several anomalies on the tyre |
| AnomalyObject name | If alone, can be any of the anomaly listed |
WEAR_UNKNOWN | Unable to provide a wear analysis |
RecommendationObject
| Property | Not null | Type | Description |
|---|---|---|---|
code | yes | String | Main recommendation code |
extractLabels | yes | Array[ExtractLabelObject] | All labels associated with the code |
Available RecommendationObjectCode
| Code | Description |
|---|---|
ALL_TYRES_TO_BE_REPLACED | All tyres need to be replaced |
ALL_TYRES_TO_BE_PLANNED | All tyres need to be planned |
REAR_TYRES_TO_BE_REPLACED | Rear tyres need to be replaced |
REAR_TYRES_TO_BE_PLANNED | Rear tyres need to be planned |
FRONT_TYRES_TO_BE_REPLACED | Front tyres need to be replaced |
FRONT_TYRES_TO_BE_PLANNED | Front tyres need to be planned |
FRONT_AXLE_NEED_GEOMETRY | Front axle need wheel alignment |
ALL_TYRES_OK | All tyres are ok |
ExtractLabelObject
| Property | Not null | Type | Description |
|---|---|---|---|
label | yes | String | Recommendation label |
color | yes | String | Recommendation code |
Changelog
| Date | Changelog |
|---|---|
| 03/05/2024 | Add hernia (see AnomalyObject) |
| 30/10/2025 | Translate to english / Update missing fields (season & mPlusS on ReferenceObject) |
| 30/10/2025 | Add all available codes |