Incremental Damage API
This API allows authorized clients to compare two existing vehicle inspections incrementally. It generates a new inspection session from the two existing inspections and records the incremental damage results.
Method | Base URL | Endpoint |
POST | https://reports.inspektlabs.com | /api/incremental_damage |
Authentication
- Requires JWT token in
Authorization: Bearer <token>header. - The Bearer token is obtained from the Authentication API.
Click the button below to download the Postman collection for the API.
Incremental_damage_api.json2.2 KB
Parameters
Field | Type | Required | Description |
case_id | string | Yes | Unique case identifier for this incremental damage request |
session | string | Yes | New session/inspection ID to be created |
inspection_id_1 | string | Yes | Existing inspection ID (of first inspection) |
inspection_id_2 | string | Yes | Existing inspection ID (of second inspection) |
Curl
curl -X POST https://reports.inspektlabs.com/api/incremental_damage \
-H "Authorization: Bearer <jwt_token>" \
-H "Content-Type: application/json" \
-d '{
"case_id": "case_001",
"session": "session_123",
"inspection_id_1": "insp_001",
"inspection_id_2": "insp_002"
}'
Replace the Fields with your actual values. Use only the appropriate keys and mandatory fields as per your use case.
Responses
{
"status": "success",
"session": "ins123"
}Error message and status code
HTTP Code | Message | Condition |
401 | token invalid | Invalid token |
403 | no access | Client Id does not has access |
404 | cases not found | Provided inspection Ids don’t belong to that client Id |
400 | Inspection Id already exists, please generate a new one | Session already exists |
400 | Please hit authenticate endpoint first and use session from there | Session folder missing |
400 | Missing a required field | Required field missing |
500 | Server Side Issue | Server Side Issue |
←Q Score API
Result Json→
On this page
- Incremental Damage API
- Authentication
- Parameters
- Curl
- Responses
- Error message and status code