Diagnostic Specification

Connect the WebHook

Provide an endpoint that receives a request with the POST verb, the body (in JSON) is described in the following section.

If the endpoint is secure, please inform the technical team who will implement the necessary code.

Body example

{
  "reportUrl": "https://report.ca-rool.com/pcSv7d72",
  "dateAnalysis": "2023-11-23T17:38:16.720Z",
  "vehicle": {
    "license": "FG-856-MQ",
    "externalId": "123456",
    "vehicleMileage": 9876,
    "brand": "SEAT",
    "model": "Arona"
  },
  "frontLeft": {
    "data": {
      "reference": {
        "position": 1,
        "notVisible": false,
        "manufacturer": "First Stop",
        "name": "First Stop Winter 2",
        "width": 145,
        "ratio": 70,
        "isZR": false,
        "diameter": 13,
        "loadIndex": 71,
        "speedIndex": "T",
        "dotDate": "2016",
        "dotManufacturer": "HD",
        "countryCode": "ita",
        "hasHernia": false,
        "hasCut": false,
        "approvedReference": "205/55 R16 91V",
        "isRightWay": true
      },
      "wear": {
        "position": 1,
        "notVisible": false,
        "hasObject": false,
        "hasCracks": false,
        "hasShoulderWear": false,
        "hasDamaged": false,
        "rate": "A"
      }
    },
    "report": {
      "color": "RED",
      "brand": "First Stop",
      "model": "First Stop Winter 2",
      "dimension": "145/70R13 71 T",
      "season": "Hiver",
      "produced": "Produced in May 2016 - Italy",
      "diagnoses": [
        {
          "codeValue": "WEAR_VERY_OK",
          "value": "Tyre in very good condition, very good tread height",
          "color": "GREEN"
        },
        {
          "codeValue": "AXLE_DIFF_DIMENSION",
          "value": "Dimensions different on the axle",
          "color": "RED"
        }
      ],
      "recommendation": {
        "codeValue": "VERIFY_BY_SPECIALIST",
        "value": "To be checked by a specialist",
        "color": "RED"
      }
    }
  },
  "frontRight": {
    "data": {
      ...
    },
    "report": {
      "report": {
        ...
      }
    },
    "rearLeft": {
      "data": {
        ...
      },
      "report": {
        ...
      }
    },
    "rearRight": {
      "data": {
        ...
      },
      "report": {
        ...
      }
    },
    "recommendations": [
      {
        "codeLabel": "MOUNTING_DIRECTION",
        "label": "Checking mounting directions",
        "codeValue": "UNKNOWN",
        "value": "?",
        "color": "RED"
      },
      {
        "codeLabel": "AXLE",
        "label": "Same brand, pattern, dimension for each axle",
        "codeValue": "KO",
        "value": "KO",
        "color": "RED"
      },
      {
        "codeLabel": "TYRES_INTEGRITY",
        "label": "Presence of a cut, hernia, crack",
        "codeValue": "KO",
        "value": "KO",
        "color": "RED"
      },
      {
        "codeLabel": "CONCERNED_BY_MOUNTAIN_LAW",
        "label": "Postcode requires winter tyres",
        "codeValue": "UNKNOWN",
        "value": "?",
        "color": "OFF"
      }
    ]
  }

Request body properties

Property	Not null	Type	Description
reportUrl	yes	String	PDF report URL
vehicle	yes	VehicleObjet	Contains vehicle data
dateAnalysis	yes	String	Analysis creation date
frontLeft	yes	TyreObject	Front left tyre information
frontRight	yes	TyreObject	Front right tyre information
rearLeft	yes	TyreObject	Rear left tyre information
rearRight	yes	TyreObject	Rear right tyre information
recommendations	yes	Array[RecommendationObject]	Global recommendations

VehicleObjet

Property	Not null	Type	Description
license	yes	String	Vehicle registration number
maker	no	String	Vehicle Brand
model	no	String	Vehicle model
externalId	no	String	External code passed during analysis creation
vehicleMileage	no	Integer	Mileage (unit based on vehicle country)

TyreObject

Property	Not null	Type	Description
data	yes	DataObject	Raw tyre data
report	yes	ReportObject	Calculated PDF Report data

DataObject

Property	Not null	Type	Description
reference	yes	ReferenceObject	Extracted tyre sidewall data
wear	yes	WearObject	Extracted tyre tread data

ReferenceObject

Property	Not null	Type	Description
position	yes	Integer	Tyre position on the vehicle: 1 = front left tyre; 2 = front right tyre; etc
notVisible	yes	Boolean	If true, photo was not visible therefor no data is available
manufacturer	no	String	Tyre manufacturer
name	no	String	Tyre model
width	no	Integer	Tyre width
ratio	no	Integer	Tyre ratio
isZR	no	Boolean	Is Tyre ZR or not (R is no)
diameter	no	Integer	Rim diameter
loadIndex	no	Integer	Tyre load index
speedIndex	no	Integer	Tyre speed index
dotDate	no	String	Tyre manufacturing date
dotManufacturer	no	String	Tyre factory code
dotCountryCode	no	String	Country code of the tyre factory
season	no	String	Tyre season
3pmsf	no	Boolean	Tyre 3PMSF marking
hasHernia	no	Boolean	True if tyre has hernia
hasCut	no	Boolean	True if tyre has cut
approvedReference	no	String	Approved reference
isRightWay	no	Boolean	Is tyre mounted the right way

WearObject

Property	Not null	Type	Description
position	yes	Integer	Tyre position on the vehicle: 1 = front left tyre; 2 = front right tyre; etc
notVisible	yes	Boolean	If true, photo was not visible therefor no data is available
hasObject	no	Boolean	True if an object is detected in the tyre tread (nail / screw / etc)
hasCracks	no	Boolean	True if there is cracks in the grooves
hasShoulderWear	no	Boolean	True if the tyre has collapsed shoulder tread
hasDamaged	no	Boolean	True if the tyre has damage tread
rate	no	String	Tread wear: A = new tyre; B = tyre in good condition; BC = tyre almost worn; C = tyre worn; D = tyre with wear indicator reach

ReportObject

Property	Not null	Type	Description
color	yes	String	Tyre color indicator
brand	no	String	Tyre brand
model	no	String	Tyre model
dimension	no	String	Full tyre dimension
season	no	String	Tyre season
produced	no	String	DOT code meaning
diagnoses	yes	Array[DiagnosisObject]	List of tyre diagnostics
recommendation	yes	Array[RecommendationTyreObject]	List of tyre recommendations

DiagnosisObject

Property	Not null	Type	Description
color	yes	String	Color code of the result
value	yes	String	Label of the diagnostic result
codeValue	yes	String	Code representing the diagnostic result

RecommendationTyreObject

Property	Not null	Type	Description
color	yes	String	Color code of the result
value	yes	String	Label of the recommendation result
codeValue	yes	String	Code representing the recommendation result

RecommendationObject

Property	Not null	Type	Description
codeLabel	yes	String	Code representing the recommendation type
label	yes	String	Label of the recommendation type
codeValue	yes	String	Code representing the recommendation result
value	yes	String	Label of the recommendation result
color	yes	String	Result color

Signification Codes

Category	Code	Label
Anomaly
	PRESENCE_OBJECT	There is an object on the tread
	PRESENCE_CRACKS	There is cracks on the rubber
	PRESENCE_CUT	There is cut on the sidewall
	PRESENCE_HERNIA	There is hernia on the sidewall
	DAMAGED	Damaged tread
	SHOULDER_WEAR	Collapsed should wear
	TOO_OLD	Tyre age greater than 10 years, rubber aging
Axle
	AXLE_DIFF_DIMENSION	Different dimensions on the axle
	AXLE_DIFF_BRAND	Different brands on the axle
	AXLE_DIFF_PROFILE	Different patterns on the axle
	AXLE_DIFF_SEASON	Different seasons on the axle
Axle - specific GB
	AXLE_DIFF_BRAND	We recommend to have the same brand on the axle
	AXLE_DIFF_SPEED_INDEX	We recommend to have the same speed index on the axle
	AXLE_DIFF_SEASON	We recommend to have the same season on the axle
Wear
	IMPOSSIBLE_ANALYZE_WEAR	Impossible wear analysis
	WEAR_VERY_OK	Very good tread depth
	WEAR_OK	Good tread depth
	WEAR_MEDIUM	Tread low, replacement to be planned
	WEAR_WORN	Worn tyre, limited tread height, risk of aquaplaning
	WEAR_VERY_WORN	Worn tyre - Wear indicator reached
Recommandation Tyre
	REDO_PHOTO	Take your photos again while respecting the mask
	TO_BE_REPLACED_URGENTLY	To be replaced urgently
	VERIFY_BY_SPECIALIST	To be checked by a specialist
	TO_BE_REPLACED	To be replaced
	NEXT_CHECK_10000_KM	Next check in 6 months or 10,000 kms
	NEXT_CHECK_5000_KM	Next check in 6 months or 5,000 km
	NEXT_CHECK_5000_KM_AT_LATEST	Next check: 6 months or 5,000 kms at the latest
Recommandation Value
	OK	OK
	KO	KO
	UNKNOWN	?
	YES	Yes
	NO	no
Recommandation Label
	MOUNTING_DIRECTION	Checking the mounting directions
	AXLE	Same brand / profile / dimension per axle
	TYRES_INTEGRITY	No presence of hernia, cut or crack
	CONCERNED_BY_MOUNTAIN_LAW	Commune affected by the Mountain law )
	TYRES_COMPATIBLE_MOUNTAIN_LAW	Tyres compatible with mountain law (M+S / 3PMSF marking)