OpenAPI
  • Quick Start
  • Documentation
    • Instruction
    • Log Update
    • Glossary
  • Integration Instruction
    • Interface Specification
    • Callback Rules
    • Public Parameters
  • Best Practice
    • Integration Procedures
    • Integration Solution
  • Standardized Interface
    • Obtain Platform Access Credentials
    • Obtain Vehicle Health Check Report
    • Create Service Order Callback
    • Release Health Check Report Callback
      • Basic Integration: Embedded URL to H5 Health Check Report
      • Deep Integration: Comprehensive Health Check Result Data
    • Vehicle Condition & Maintenance Plan Callback
  • Customized Interface
    • Synchronize Vehicle Service Item Info
    • Synchronize Work Procedure Info
    • Synchronize Work Report Info
      • Basic Integration: Embedded URL to H5 Work Report
      • Deep Integration: Comprehensive Work Result Data
  • FAQ
    • Code Encryption DEMO
    • HTTPS Settings Instruction
  • ⚙️Translation
    • 简体中文
Powered by GitBook
On this page
  • Business Scenario
  • Main Process

Was this helpful?

  1. Standardized Interface

Vehicle Condition & Maintenance Plan Callback

PreviousDeep Integration: Comprehensive Health Check Result DataNextSynchronize Vehicle Service Item Info

Last updated 3 years ago

Was this helpful?

Business Scenario

  1. The staff completes the vehicle check-in process through the AutoX3 Intelligent Technician app.

  2. Synchronize vehicle condition problem list and maintenance plan to the access system through JSON.

  3. The developer from the access partner develops the comprehensive vehicle condition problem list and maintenance plan data.

Main Process

When the technician completed the health check order through the Intelligent Technician app.

Message Type:

event.autox3.order.detection.finish.report

Message Content:

{
  "content": {
    "carMaintenancePlanList": [        // Maintenace plan list 保养计划列表
      {
        "currentMiles": 1242,          // Current mileage 当前里程
        "expiredDays": 25,             // Expired date (larger than zero: has expired for x days; smaller than zero: will be expired 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,            // Esitimated service price预测服务项目价格
        "id": 1700,                          // Maintenance plan ID 保养计划id
        "mgtModified": 1622013059000,        // Recent modified date 最近修改时间
        "nextReplaceCycleKm": 854,           // Next maintenance mileage 下次保养里程
        "operator": "yang xingxingxing2",    // Operator 操作人
        "payProbability": 0.0,               // Payment successfuly probability 成交概率
        "perMiles": 15.5342798,              // Average mileage 平均里程
        "recommend": true,                   // Whether recommend maintenace 是否推荐立即保养
        "reductionType": "TIME",             // 维保计划计算类型
        "serviceBaseName": "wash car",       // Service item SN 服务项目SN
        "serviceBaseSn": "00107040513",      // Service item SN name 服务项目SN Name  
        "warningDate": "2021-05"             // Estimated warning date 计划报警日期 
      }
    ],
    "carNum": "JS73RHK",                     // 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
      }
    ]
  },
  "createTime": 1616502610117,                        // Timestamp 推送时间戳
  "msgType": "event.autox3.order.detection.finish",   // Message type 推送消息类型
  "msgSignature": "${hashCode}",                      // Message signature 消息签名
  "msgId": "e6ddea1d-0b8b-24e7-cb26-91c3aa0969db",    // Message ID 推送消息 id
  "staffInfo": {                       // Staff info 员工信息
    "areaCode": "+44",                 // Country area code 所属国家区号
    "brandId": 114,                    // Brand ID 品牌id
    "mobile": "17666166190",           // Phone number 手机号
    "staffId": 380,                    // Staff ID 员工id
    "staffName": "A梦 哆啦",            // Staff name 员工名称
    "storeId": 84                      // Shop ID 店铺id
  }
}        

Developer Normal Response Data:

{
	"data":null,
	"errorInfo":"",    // Error Information
	"status":0		     // 0 stands for successful callback reception
}
  1. For the deduplication process, msgid is recommended.

  2. When the AutoX3 server does not receive a normal response, it will initiate a retry six times, with intervals of 2s, 4s, 8s, 16s, 32s, and 64s.

  3. Signature rule: sha1(msgId + msgType + staffInfo + createTime + content + appSecret).