> For the complete documentation index, see [llms.txt](https://autox3api.gitbook.io/autox3/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://autox3api.gitbook.io/autox3/standardized-interface/obtain-vehicle-inspection-report.md). # Obtain Vehicle Health Check Report ## Request Address | Environment | HTTPS Request Address | | ------------------------------------- | ------------------------------------------------------ | | Mainland China Sandbox Environment | | | Mainland China Production Environment | | | Other Countries Environment | N/A | ## Request Parameter | Item | Sub-item | Required | Length | Type | Instruction | | ------- | ---------- | -------- | ------ | ------- | ------------------------------------- | | method | | Yes | 64 | String | autox3.order.detection.report.list | | content | | Yes | 200 | String | 请求接口内容字符串JSON | | | carNum | Yes | 64 | String | License Plate | | | isNeedJson | No | -- | Boolean | Whether return inspection report JSON | Request Command (take curl command as an example) Example: {% tabs %} {% tab title="curl" %} ``` curl 'https://cnopenapi.autox3.com/openapi/api-v1/rest' \ -H "accept: */*" \ -H "Authorization: ${token}" \ -H 'Content-Type: application/json;charset=UTF-8' \ --data-raw '{"method": "autox3.order.detection.report.list", "content":"{\"carNum\":\"云M16987\",\"isNeedJson\":\"false\"}"}' \ --compressed ``` {% endtab %} {% endtabs %} ## Authentication Successful Response Parameter | Item | Su | Required | Length | Type | Instruction | Sample Value | | --------- | ----------- | -------- | ------ | ------- | -------------------------------------------------------------- | --------------------------- | | status | | Yes | -- | Integer | Please refer to Page "Public Parameters --> Error Code" | 0 | | errorInfo | | Yes | -- | String | Error Info | network error | | data | | Yes | -- | Object | Response JSON | | | | carNum | Yes | -- | Integer | Expired time, unit: second. The default expired time is 7 days | 529200 | | | h5Url | Yes | -- | String | H5 Report URL | | | | releaseDate | Yes | -- | String | Report released time | 2021-03-31 13:34:30 | | | reportScore | Yes | -- | Float | Report Score | 100.0 | | | reportJson | No | -- | String | When isNeedJson = true, return inspection report JSON content | "{}" | #### Example: Structure without reportJson: ``` { "data":[ { "carNum":"JS73RHK", "h5Url":"${url}", "releaseDate":"2021-03-31 13:34:30", "reportScore":100.0, "reportJson":null } ], "errorInfo":null, "status":0 } ``` Structure with reportJson: ``` { "data":[ { "carNum":"JS73RHK", "h5Url":"${url}", "releaseDate":"2021-03-31 13:34:30", "reportScore":100.0, "reportJson": "{ // Inspectoin report JSON string "workBaseStatus": false, "carNum": "JS73RHK", // License plate "serviceBaseName": "Fluid Inspection", // Inspection item "list": [ // Inspection answer list { "evaluation": "This is a comment", // Technician comments "itemAmount": 1, // Number of inspection item "questionToSystemId": 1619, // Question system ID "templetItemEntityList": [ // Inspection items { "carId": 1846, // Vehicle ID "mimeTupleList": [ // Inspection photos/videos list { "key": 338578, // Resource ID "mimeType": "image/*", // Resource type image/* video资源类型 image/* video/* "value": "${url}" // Resource URL } ], "questionDetectionTempletQuestionList": [ // Inspection point list { "answer": "20%", // Inspection point answer "currentMiles": 49709, // Vehicle mileage when creating inspeciton report "description": "Brake Fluid Level", // Inspection point name "id": 10862, // Inspection point template ID "normalOrNot": 2, // Normal choice (0.Dangerous 1.Pass 2.Major 3.Minor ) "normalValue": "D", // Normal choice value "perMiles": 12.0980971, // Vehicle daily mileage when creating inspection report "questionBaseId": 7337, // Inspection point ID "questionBaseStatus": "DANGEROUS", // Inspection point status（PASS；MINOR；MAJOR；DANGEROUS；） "questionBaseStatusDesc": "DANGEROUS", // Inspection pooint status description "soundOrNot": false, // "takePhotoOrNot": true, "touchCycleBaseServiceEntityList": [ // Inspection point recommended service { "currentMiles": 49709, // Vehicle current mileage when creating inspeciton report "detectionPointName": "Brake Fluid Level", // Inspection point name "perMiles": 12.0980971, // Vehicle daily mileage when creating inspection report "restSafeMilesKm": 0, // Vehicle safety mileage when creating inspection report "serviceBaseName": "12345copy1", // Recommended service item "serviceBaseSn": "0009copy10704051301", // Recommended service item SN "touchQuestionBaseId": 7337 // active inspection point ID } ], "type": "CHOICE" // Inspection choice type（CHOICE，Multiple Choice；TYRE_CHOICE，Tyre Multiple Choice Group；NUMBER，Value；） } ], "questionToItemId": 4671, // Inspection item ID "resourceIdList": [ // Inspection result photos ID List 338578, 338579 ], "resourceUrlList": [ // Inspection result photos URL List "${url}" ], "toItemDesc": "Brake Fluid" // Inspection item description } ], "toSystemDesc": "Brake Fluid" // Corresponding system description } ], "perMiles": 19.47, // Predicted daily mileage预估动态日均里程 "currentMiles": 80000, // Predicted current mileage预估动态当前里程 "maintenancePlanAndQuestion": { // Maintenance plan & vehicle condition problem List "carMaintenancePlanList": [ // Maintenace plan list保养计划列表 { "currentMiles": 1242, // Current mileage当前里程 "expiredDays": 25, // Expired days (larger than zero: has expired for x days; smaller than zero: will expire in x days)过期天数（大于零：已过期x天；小于零：还有x天过期） "expiredMiles": 388, // Expired mileage (larger than zero: has expired for x mi.; smaller than zero: will expire in x mi.)过期里程（大于零：已超过x里程/小于零：还有x里程过期） "finish": true, // Whether finished editing是否已编辑完成 "forecastPrice": 10000.0, // Estimated price预测服务项目价格 "id": 1700, // Maintenance plan ID保养计划id "mgtModified": 1622013059000, // Recent modified date最近修改时间 "nextReplaceCycleKm": 854, // Mileage for next maintenance下次保养里程 "operator": "yang xingxingxing2", // Operator操作人 "payProbability": 0.0, // Payment successful probability成交概率 "perMiles": 15.5342798, // Averyage mileage平均里程 "recommend": true, // Whether recommend maintenance是否推荐立即保养 "reductionType": "TIME", // 维保计划计算类型 "serviceBaseName": "wash car", // Service item SN服务项目SN "serviceBaseSn": "00107040513", // Service item SN Name服务项目SN Name "warningDate": "2021-05" // Estimated warning date计划报警日期 } ], "carNum": "KAKA100", // License plate车牌号 "workProcedureQuestionList": [ // Vehicle condition problem list车况问题列表 { "optionDescription": "51", // Inspection point problem answer检测点问题答案 "questionBaseDescription": "error-indirect", // Inspection point description检测点描述 "questionBaseId": 5911, // Inspection point ID检测点ID "workProcedureQuestionId": 9133 // Inspection history ID检测记录ID } ] } "staffInfo": { // Staff info 员工信息 "areaCode": "+44", // Country area code 所属国家区号 "brandId": 5, // Brand ID 品牌id "mobile": "13133330000", // Phone number 手机号 "staffId": 1, // Staff ID 员工id "staffName": "A梦 哆啦", // Staff name员工名称 "storeId": 1 // ShopID 店铺id } }" } ], "errorInfo":null, "status":0 } ``` ## Authentication Failed Response Parameter | Item | Required | Length | Type | Instruction | Sample Value | | --------- | -------- | ------ | ------- | ------------------------------------------------------- | -------------------- | | status | Yes | -- | Integer | Please refer to Page "Public Parameters --> Error Code" | 403 | | error | Yes | -- | String | Error Info | Forbidden | | path | Yes | -- | String | Request Path | /openapi/api-v1/rest | | message | Yes | -- | String | Notification | Access Denied | | timestamp | Yes | -- | String | Time | 2021-06-02 11:50:34 | #### Example： ``` { "timestamp": "2021-06-02 11:50:34", "status": 403, "error": "Forbidden", "message": "Access Denied", "path": "/openapi/api-v1/rest" } ```