# Submit Fir
# API Description
This API is used to submit fir.
# Environment
# Test
https://oversea.saicmaxus.com/australia/test/fir/new/submit (opens new window)
# Prod
https://oversea.saicmaxus.com/australia/fir/new/submit (opens new window)
# Method
POST
# Request
# Authorization
Set 'maxus_jwt' in header,see in Get Maxus JWT Token
# Payload
| Parameter | Type | Required | Web page field | Description | 中文描述 |
|---|---|---|---|---|---|
| title | String(200) | Yes | Failure Description | The title of the FIR. | 案例标题 |
| creatorName | String(100) | Yes | Employee Name | The name of the person who created the FIR. | 案例创建人 |
| mobile | String(20) | No | Contacts | Contacts phone. | 联系电话 |
| vin | String(17) | Yes | VIN/ Chassis No | The Vehicle Identification Number. | 车架号 |
| carLine | String(60) | No | Model | The line of cars that the vehicle belongs to. | 车系 |
| mileage | String(10) | Yes | Mileage | The mileage of the vehicle. | 行驶里程 |
| troubleLevel1 | String(60) | No | The primary level of trouble. | 系统一级分类 | |
| troubleLevel1Code | String(20) | Yes | Classification 1 | The code for the primary level of trouble. | 系统一级分类代码 |
| troubleLevel2 | String(50) | No | The secondary level of trouble. | 系统二级分类 | |
| troubleLevel2Code | String(20) | Yes | Classification 2 | The code for the secondary level of trouble. | 系统二级分类代码 |
| troubleLevel3 | String(50) | No | The tertiary level of trouble. | 系统三级分类 | |
| troubleLevel3Code | String(20) | Yes | Classification 3 | The code for the tertiary level of trouble. | 系统三级分类代码 |
| failedMode | String(50) | No | The mode in which the failure occurred. | 失效模式 | |
| failedModeCode | String(20) | Yes | Failure Mode | The code for the failure mode. | 失效模式代码 |
| failPartCode | String(30) | Yes | Failure P/N | The code for the part that failed. | 失效零件号 |
| loseFunctionPartName | String(200) | No | The name of the part that lost function. | 失效零件名称 | |
| isAuthorized | String(1) | Yes | Pre-Authorization Application | Whether the case applies for pre authorization or not | 是否预授权 |
| troubleCode | String(200) | No | Fault Code | The trouble code associated with the case. | 诊断仪故障码 |
| symptomComplaint | String(4000) | Yes | Fault Symptom | The symptom or complaint. | 故障症状 |
| corReactiveAction | String(4000) | Yes | Solution | The corrective or reactive action taken. | 解决方案 |
| probableCause | String(4000) | Yes | Repair Process | The probable cause of the issue. | 维修经过 |
| remark | String(4000) | No | Remark | Any additional remarks. | 备注 |
| pbList | List | No | A list of QualityReportAttachmentDto objects. | 预授权问题 | |
| pbList.attachmentVoList | List | No | Upload attachments | 预授权问题附件 | |
| pbList.attachmentVoList.fileType | String(255) | No | Upload file type | 文件类型 | |
| pbList.attachmentVoList.fileUrl | String(2500) | No | Encrypted file upload url | 文件地址 | |
| pbList.attachmentVoList.fileName | String(255) | No | Upload file name | 文件名称 | |
| pbList.attachmentVoList.fileSize | String(255) | No | Upload file size | 文件大小 | |
| pbList.pbDesc | String(255) | No | Failure Description | Fault Description | 问题描述 |
| pbList.pbAuthorizedMoney | String(255) | No | Amount | Pre authorization amount | 预授权金额 |
| attachmentVoList | List | Yes | A list of QualityReportAttachmentDto objects. | 案例附件 | |
| attachmentVoList.attachmentVoList | List | Yes | Upload attachments | ||
| attachmentVoList.attachmentVoList.fileType | String(255) | Yes | Upload file type | 附件文件类型 | |
| attachmentVoList.attachmentVoList.fileUrl | String(2500) | Yes | Encrypted file upload url | 附件地址 | |
| attachmentVoList.attachmentVoList.fileName | String(255) | Yes | Upload file name | 附件名称 | |
| attachmentVoList.attachmentVoList.fileSize | String(255) | Yes | Upload file size | 附件大小 | |
| attachmentVoList.busiTag | String(255) | Yes | Attachment option code, refer to API doc (opens new window) | 附件所属业务分类 | |
| caseClassification | String(50) | Yes | Case Classification | The classification of the case. | 案例分类 |
| positionCode | String(50) | No | Employee Position Code | 员工岗位代码 | |
| country | String(100) | No | Country Name | 所属国家 | |
| countryCode | String(100) | No | Country Code | 所属国家代码 | |
| creator | String(100) | No | Employee xyx Id | 创建人id | |
| worksheetStartDate | Date | No | R/O Start Date | R/O Start Date | 工单维修日期 |
| worksheetEndDate | Date | No | R/O Finish Date | R/O Finish Date | 工单维修结束日期 |
| insuranceStartTime | Date | No | Warranty Start | Warranty Start | 保修日期 |
| vehicleSpeed | String(20) | Yes | Speed | Speed Code | 车速 |
| vehicleLoad | String(20) | No | Load | Vehicle load Code | 车辆载重 |
| roadCondition | String(20) | No | Road Condition | Road condition Code | 路况 |
| weather | String(50) | No | Weather | Weather Code | 天气 |
| purchaseDate | Date | No | Retail Date | Retail Date | 购车日期 |
| clientName | String(255) | No | Customer Name | Customer Name | 客户姓名 |
| clientMobile | String(255) | No | Contact | Contact | 客户电话 |
| clientEmail | String(255) | No | 客户邮箱 | ||
| clientAddr | String(255) | No | Address | Address | 客户地址 |
| dealerCode | String(20) | No | Dealer | Dealer code, refer to API doc (opens new window) | 二级经销商代码 |
# Example
curl --location 'https://oversea.saicmaxus.com/australia/test/fir/new/submit' \
--header 'maxus_jwt: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhc2NDb2RlIjoiNDE5ODEzMCIsImFzY0lkIjo0MTk4MTMwLCJhc2NOYW1lIjoiQVRFQ08iLCJjYWxsQmFja1VybCI6IjEiLCJleHBpcmVUaW1lU3RhbXAiOiIxNzA0MzY2NTY2NTY4IiwicmVtYXJrIjoicHJpdmF0ZT09MTI1Njk4NjU0ODQ3ODg4MTAyMjA2MjAxODEzMzgxNTA2MTE2ODk4Njg1MDgyMzUyNTcyNjAxMDg1MTkzMzg0OTE4MjEzOTUzNDUzMjY3NDAxNzgyMjQ3NTc4OTMwNDU4MTg3Mzg5Mjk5OTU1MjU5MjUwMTI4MzE5OTYxNTYzNjE5MTIxOTQ4MzI0MTA3NTI3MDc0NjEyMzg4MjM4NzAxMjQzNzA2ODE3NjgyNTEyNjk1NDc4OTQ1MjYzOTc5NTc2NjU2MTUwMzgyMTk0NzQ1OTY0OTg4OTc0NTc5ODIyNzc5NjM2NTYxNTYyOTM5Mjc1ODkwMTExNTQ3ODIxNjMzNzMxMzQ2MTc2MjU1ODMzOTEwNTE5NTYyNDg2NTI3OTE5MzMxMTYxMjY2ODA5OTE3ODc4Nzltb2R1bGVzPT0zNDQ2NzU5MjY3NjUwMDkzMjE4MDA3NTU2NTE5MTY1NDAxMTgyODEzNDE3MTYxOTMzMjY3MzE0MzQ4MzA4ODEwMTk2MDcyNzUwNTA5ODg2NjEwMzY1MDk1OTExMjk3MjE2MjI5NTEzOTA5NjE1NTU2MzUzMzk2MzY1NzExOTA0NjUwNjg3NDczOTkzOTUxMTE2MzkwMjcxNDE1MTUyMjE0Mzc3NDI4MjY1NTMwOTQyMzA4MTUxNTk2NjMxOTI0MTA0NTAyMTIwOTk0NzI2MDcxMDcxNTc3MTMwMzExMzg4NTg1MjAyMTA1NjM1MjMwNTIzMTc2NDY2MzU4MDA1NDU2MjQ3NjMwMjY5NzQzMzE1OTQxODAyNTQwNjcyNzM0ODg5MDExODAxMDI2ODAxOTIxNjkzMSIsInJzYVZPIjp7InJzYVB1YmxpY0V4cG9uZW50IjoiMTAwMDEiLCJyc2FNb2R1bGVzIjoiOGNmMDhkMjkxNzdjYTJiOTQyN2M1YTJiMWQ0MTUzZjg2MGVhNWVkNzAxZGFlYTk4Mzg5YWJmZmNjNGQ1OTQ0Mjk5ZWQ4YmRkZjRkMWI1MjhhNzQ2ZGE2Yjk3OTkyODJlOGJiNTUzMDQ5NWE0MjRkZTcwM2NjMTc4ZWQyZGUwNDE1OTliY2FjMWY1MTIzNjg5NmU2MWM3M2RkYTk1ODZmOWNjZjRlMjI0NzMxZmEzNzFkOTg0ODg5MzhlZWJmNDUzODhlMTc5MjMxNTExMjY3ODM4YTE5MGJmOWE2N2YzYjcwYzg5ZWRlMWE2ODQ2ZGNjZWZkY2I0OTUzNDRmMDIzZiIsInJzYVByaXZhdGVFeHBvbmVudCI6IjFlMTNjZmVjMmYwOGY4MjkxNTE5Mzg5Y2VlZDc1YzM2MmI2ODk4ZThjNThhOTQ3OWZiY2E3YWEyNTRkNzQ3OTY5NzA2ZWNjYzY3NGNjMTllNzU2NDU3ODQ5MjhiYWFkOTk0MTMxNDJlNmM0OGU1NWQ1YjEyN2MyZjc0NWU0ZmY3MGRmZWU4MWQ0YWY4OWM0ODg1NTViMzMwMmE4OWY3ZjcwM2JmMTU0YjM1ZmM5NmVhZjMxYTFhYjMwNTQwMTE4ZGEzY2ZhY2ViZTZkMTI3ZmEyODQzZWQ3MDQ0NDJlZWE5ZDc3ODUxMTlhN2Q3MjkzY2U3NTliNGE5ZmIwODA0MzEiLCJnYWluQ291bnQiOjkzfSwic2FwQWNjb3VudCI6IjQxOTgxMzAiLCJzZXJ2aWNlQ29kZSI6IkF0ZWNvIiwiaWF0IjoxNzA0MzY2Mzg2LCJleHAiOjE3MDQzNjc4MjZ9.vTVFWupN7dbBZeEnGbYnSHPT0h0IWhInLpubS5Hjjc8' \
--header 'Content-Type: application/json' \
--header 'Cookie: HttpOnly' \
--data '{
"title": "Api Failure Description-0327-01",
"creatorName": "api-顾岳毅",
"vin": "LSFAM11A1KA046996",
"carLine": "T60",
"mileage": "20",
"troubleLevel1": "Engine",
"troubleLevel2": "Engine machinery - crank linkage",
"troubleLevel3": "Cylinder block/ crankcase assembly",
"troubleLevel1Code": "20011001",
"troubleLevel2Code": "20011014",
"troubleLevel3Code": "20011090",
"failedMode": "AC failure",
"failedModeCode": "10121026",
"failPartCode": "C00073518",
"loseFunctionPartName": "CAP-RAIN SUN SEN",
"isAuthorized": "0",
"troubleCode": "Fault Code text",
"symptomComplaint": "*Fault Symptom text",
"corReactiveAction": "Solution",
"probableCause": "Repair Process text",
"remark": "Remark text",
"pbList": [
{
"attachmentVoList": [
{
"fileType": "mp4",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b2d2410893ffcc1f40ff4465301b4fc882c50ace5b5d6925c737157ebe7c562850a8cf3c3113373eed96b24b55e0759143e1b557fe240b47ab027844749abb931c1b71724a9459a55383c4bc1b64cfff2",
"fileName": "demo.mp4",
"fileSize": "494"
},
{
"fileType": "mp4",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b2d2410893ffcc1f40ff4465301b4fc882c50ace5b5d6925c737157ebe7c562850a8cf3c3113373eed96b24b55e0759143e1b557fe240b47ab027844749abb931c1b71724a9459a55383c4bc1b64cfff2",
"fileName": "demo.mp4",
"fileSize": "494"
}
],
"pbDesc": "Failure Description",
"pbAuthorizedMoney": "100"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e84ed71b891547cb448254b167c57ec3d8b67428c4d1138cddadb65c853abf6832c9048812787693958f77f3ceb879a68e358560ff6bb565b0ef395178a6c6b5a",
"fileName": "mifa1.png",
"fileSize": "13395800"
}
],
"pbDesc": "Failure Description2",
"pbAuthorizedMoney": "111"
}
],
"attachmentVoList": [
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191001"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191002"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191003"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191004"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191005"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191006"
},
{
"attachmentVoList": [
{
"fileType": "png",
"fileUrl": "cb2bf31fca3f4dbeb6f8863c20d41eb4263a5ea46afae55aae70a8e3da74dd9b0ad02355b706aa40a7620dfb7522053e4cc70e5577da6e7ac56fadc2f49cd2516fe35e927c98b75a4db0de5556b6fc941195616c6cd8beb9a25c7ada592fd8b7e7dcdaf1d3939b688b45c4273aa2d735",
"fileName": "3c308ac6a1f14761a05928154f907afb.png",
"fileSize": "336826"
}
],
"busiTag": "10191007"
}
],
"caseClassification": "Warranty",
"positionCode": 10046789,
"positionName": "华东一区-上海",
"country": "中国",
"countryCode": "10000",
"creator": 10000000012333,
"worksheetEndDate": "1679127190000",
"worksheetStartDate": "1647591190000",
"insuranceStartTime": "1616055190000",
"vehicleSpeed": "11011002",
"vehicleLoad": "12011003",
"roadCondition": "13011002",
"weather": "14011001",
"purchaseDate": "1710749590903",
"clientAddr": "Address",
"clientEmail": "Email",
"clientMobile": "Contact",
"clientName": "Customer Name"
}'
# Response
# Payload
| Parameter | Type | Description |
|---|---|---|
| status | int | 1: Success, 0: Failure |
| errMsg | String | Error message |
| data | String | case id |
# Response Code (errCode)
| Status Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Unknown Error |
| 503 | Dependency System Unavailable |
# Example
# OK
{
"status": 1,
"errCode": "200",
"errMsg": "SUCCESS",
"data": "4198130-20240308-22"
}
# NOT FOUND
{
"status": 0,
"errMsg": "NOT FOUND",
"errCode": "404",
"data": null
}
# INTERNAL ERROR
{
"status": 0,
"errMsg": "DEPENDENCY SYSTEM UNAVAILABLE",
"errCode": "503",
"data": null
}
{
"status": 0,
"errMsg": "UNKNOWN ERROR",
"errCode": "500",
"data": null
}
# GATEWAY ERROR
http status code: 500