Claim
List Claim #
URL #
[GET] /api/v3/claims
{
Authorization: Bearer {Token}
}
Query Params #
| Parameter | Type | Required | Description |
|---|
| page_id | integer | NO | Default: 1 |
| page_size | integer | NO | Default: 10 |
Response #
{
"Claims": [
{
"Case": {
"CreatedBy": "system_claim",
"CreateTime": "2022-09-20T04:58:33.768833Z",
"ModifyTime": "0001-01-01T00:00:00Z",
"Active": true,
"ID": 266,
"ExternalID": "...",
"Owner": 2,
"Vehicle": 266,
"Status": 1,
"OwnerLoginName": "...",
"DamageScoreFilter": 0.6
},
"Vehicle": null
"LaborRates": null,
"Images": null
},
...
],
"ClaimCount": 16,
"IsAdmin": false
}
Create Claim #
URL #
[POST] /api/v3/claim
{
Authorization: Bearer {Token}
}
Request Body #
{
ExternalID: 'String'
}
Response #
{
"Case": {
"CreatedBy": "system_claim",
"CreateTime": "2022-09-20T04:58:33.768833Z",
"ModifyTime": "0001-01-01T00:00:00Z",
"Active": true,
"ID": 266,
"ExternalID": "...",
"Owner": 2,
"Vehicle": 266,
"Status": 1,
"OwnerLoginName": "...",
"DamageScoreFilter": 0.6
},
"Vehicle": null
"LaborRates": null,
"Images": null
}
Get Claim By ID #
URL #
[GET] /api/v3/claim/{case_id}
{
Authorization: Bearer {Token}
}
Path Params #
| Parameter | Type | Required | Description |
|---|
| case_id | integer | YES | - |
Response #
{
"Case": {
"CreatedBy": "system_claim",
"CreateTime": "2022-09-20T05:34:41.672931Z",
"ModifyTime": "0001-01-01T00:00:00Z",
"Active": true,
"ID": 198,
"ExternalID": "...",
"Owner": 25,
"Vehicle": 198,
"Status": 1,
"OwnerLoginName": "...",
"DamageScoreFilter": 0.6
},
"Vehicle": null,
"Images": [
...
{
"ID": 491,
"URL": "...",
"ThumbnailURL": "...",
"Angle": 2,
"Active": true
},
{
"ID": 492,
"URL": "...",
"ThumbnailURL": "...",
"Angle": 1,
"Active": true
}
]
}
Add Image to Claim #
URL #
[POST] /api/v3/claim/{case_id}/image
{
Authorization: Bearer {Token}
}
Path Params #
| Parameter | Type | Required | Description |
|---|
| case_id | integer | YES | - |
Request Body #
{
"Images": [
{
"URL": "...",
"ThumbnailURL": "...",
"Angle": 14
},
{
"URL": "...",
"ThumbnailURL": "...",
"Angle": 13
},
...
]
}
Response #
{
"CaseID": 157,
"Images": [
{
"ID": 409,
"URL": "...",
"ThumbnailURL": "...",
"Angle": 14,
"Active": true
},
{
"ID": 410,
"URL": "...",
"ThumbnailURL": "...",
"Angle": 13,
"Active": true
},
...
]
}
Send Damage Detection #
URL #
[POST] /api/v3/claim/{case_id}/damage
{
Authorization: Bearer {Token},
X-API-KEY: {API_KEY}
}
Path Params #
| Parameter | Type | Required | Description |
|---|
| case_id | integer | YES | - |
Request Body #
""
Response #
200 ""
Get Damage Detection Result #
URL #
[GET] /api/v3/claim/{case_id}/damage
{
Authorization: Bearer {Token}
}
Path Params #
| Parameter | Type | Required | Description |
|---|
| case_id | integer | YES | - |
Response #
{
"Status": 1,
"Images": [
...
],
"Damages": [
{
"ImageID": 483,
"Method": 3,
"Score": 0.858046,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 728,
"Y0": 1761,
"X1": 864,
"Y1": 1817
}
},
{
"ImageID": 481,
"Method": 3,
"Score": 0.804109,
"Part": {
"ID": "Rocker Panel",
"Name": "Rocker Panel"
},
"Damage": {
"ID": "Dent",
"Name": "Dent"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2083,
"Y0": 2186,
"X1": 2703,
"Y1": 2338
}
},
{
"ImageID": 479,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2687,
"Y0": 1538,
"X1": 2814,
"Y1": 1738
}
},
{
"ImageID": 479,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Front Fender",
"Name": "Right Front Fender"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2300,
"Y0": 1223,
"X1": 2315,
"Y1": 1256
}
},
{
"ImageID": 480,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Rear Door",
"Name": "Right Rear Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 369,
"Y0": 1044,
"X1": 435,
"Y1": 1137
}
},
{
"ImageID": 480,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3684,
"Y0": 1668,
"X1": 3816,
"Y1": 1864
}
},
{
"ImageID": 480,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Rocker Panel",
"Name": "Right Rocker Panel"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 797,
"Y0": 2038,
"X1": 878,
"Y1": 2052
}
},
{
"ImageID": 481,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Rocker Panel",
"Name": "Right Rocker Panel"
},
"Damage": {
"ID": "Dent",
"Name": "Dent"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2064,
"Y0": 2231,
"X1": 2557,
"Y1": 2293
}
},
{
"ImageID": 481,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Rocker Panel",
"Name": "Right Rocker Panel"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2071,
"Y0": 2215,
"X1": 2536,
"Y1": 2230
}
},
{
"ImageID": 482,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Rear Fender",
"Name": "Right Rear Fender"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 1494,
"Y0": 1437,
"X1": 1581,
"Y1": 1462
}
},
{
"ImageID": 482,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Rocker Panel",
"Name": "Right Rocker Panel"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3862,
"Y0": 2115,
"X1": 3934,
"Y1": 2126
}
},
{
"ImageID": 482,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Right Front Door",
"Name": "Right Front Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3466,
"Y0": 1461,
"X1": 3485,
"Y1": 1495
}
},
{
"ImageID": 483,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 738,
"Y0": 1635,
"X1": 1756,
"Y1": 2162
}
},
{
"ImageID": 484,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 933,
"Y0": 1649,
"X1": 2939,
"Y1": 2004
}
},
{
"ImageID": 485,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2965,
"Y0": 2359,
"X1": 3247,
"Y1": 2774
}
},
{
"ImageID": 486,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Left Rear Fog Light",
"Name": "Left Rear Fog Light"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3091,
"Y0": 1949,
"X1": 3338,
"Y1": 1998
}
},
{
"ImageID": 486,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 1759,
"Y0": 1945,
"X1": 3357,
"Y1": 2295
}
},
{
"ImageID": 488,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Left Front Door",
"Name": "Left Front Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 1962,
"Y0": 1601,
"X1": 1987,
"Y1": 1615
}
},
{
"ImageID": 489,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Left Front Door",
"Name": "Left Front Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2270,
"Y0": 1601,
"X1": 3961,
"Y1": 1816
}
},
{
"ImageID": 490,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 1003,
"Y0": 1998,
"X1": 1013,
"Y1": 2129
}
},
{
"ImageID": 490,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Left Front Door",
"Name": "Left Front Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2889,
"Y0": 1464,
"X1": 3370,
"Y1": 1696
}
},
{
"ImageID": 491,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2479,
"Y0": 1764,
"X1": 2504,
"Y1": 1775
}
},
{
"ImageID": 492,
"Method": 1,
"Score": 0.8,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2675,
"Y0": 2470,
"X1": 2708,
"Y1": 2492
}
},
{
"ImageID": 487,
"Method": 3,
"Score": 0.780598,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2897,
"Y0": 1818,
"X1": 3025,
"Y1": 1877
}
},
{
"ImageID": 483,
"Method": 3,
"Score": 0.777576,
"Part": {
"ID": "Right Rear Fender",
"Name": "Right Rear Fender"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2227,
"Y0": 1467,
"X1": 2367,
"Y1": 1514
}
},
{
"ImageID": 486,
"Method": 3,
"Score": 0.775304,
"Part": {
"ID": "Left Tail Light",
"Name": "Left Tail Light"
},
"Damage": {
"ID": "Broken Light",
"Name": "Broken Light"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2395,
"Y0": 1078,
"X1": 2520,
"Y1": 1279
}
},
{
"ImageID": 479,
"Method": 3,
"Score": 0.724781,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2682,
"Y0": 1650,
"X1": 2834,
"Y1": 1760
}
},
{
"ImageID": 482,
"Method": 3,
"Score": 0.717649,
"Part": {
"ID": "Right Rear Door",
"Name": "Right Rear Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2377,
"Y0": 1745,
"X1": 2789,
"Y1": 1822
}
},
{
"ImageID": 485,
"Method": 3,
"Score": 0.702295,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 738,
"Y0": 2565,
"X1": 966,
"Y1": 2656
}
},
{
"ImageID": 486,
"Method": 3,
"Score": 0.698567,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3222,
"Y0": 1936,
"X1": 3373,
"Y1": 1991
}
},
{
"ImageID": 482,
"Method": 3,
"Score": 0.696244,
"Part": {
"ID": "Right Rear Fender",
"Name": "Right Rear Fender"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 1490,
"Y0": 1436,
"X1": 1623,
"Y1": 1485
}
},
{
"ImageID": 485,
"Method": 3,
"Score": 0.688562,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2103,
"Y0": 2407,
"X1": 2254,
"Y1": 2489
}
},
{
"ImageID": 483,
"Method": 3,
"Score": 0.664543,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 715,
"Y0": 1650,
"X1": 846,
"Y1": 1704
}
},
{
"ImageID": 482,
"Method": 3,
"Score": 0.656179,
"Part": {
"ID": "Rear Bumper",
"Name": "Rear Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 578,
"Y0": 1587,
"X1": 625,
"Y1": 1626
}
},
{
"ImageID": 490,
"Method": 3,
"Score": 0.654157,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 973,
"Y0": 1991,
"X1": 1033,
"Y1": 2180
}
},
{
"ImageID": 489,
"Method": 3,
"Score": 0.650066,
"Part": {
"ID": "Left Front Door",
"Name": "Left Front Door"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2627,
"Y0": 1630,
"X1": 2727,
"Y1": 1686
}
},
{
"ImageID": 487,
"Method": 3,
"Score": 0.640115,
"Part": {
"ID": "Left Tail Light",
"Name": "Left Tail Light"
},
"Damage": {
"ID": "Broken Light",
"Name": "Broken Light"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3739,
"Y0": 1339,
"X1": 3832,
"Y1": 1452
}
},
{
"ImageID": 479,
"Method": 3,
"Score": 0.618681,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 2683,
"Y0": 1530,
"X1": 2758,
"Y1": 1613
}
},
{
"ImageID": 481,
"Method": 3,
"Score": 0.614026,
"Part": {
"ID": "Right Rear Fender",
"Name": "Right Rear Fender"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 99,
"Y0": 1520,
"X1": 240,
"Y1": 1576
}
},
{
"ImageID": 480,
"Method": 3,
"Score": 0.611606,
"Part": {
"ID": "Front Bumper",
"Name": "Front Bumper"
},
"Damage": {
"ID": "Scratch",
"Name": "Scratch"
},
"Severity": {
"ID": "",
"Name": ""
},
"Location": {
"X0": 3700,
"Y0": 1669,
"X1": 3760,
"Y1": 1732
}
}
]
}
Swagger #