API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · vehicle_damages

Vehicle Damage Schema

Schema-ID
vehicle_damage
Collection
vehicle_damages
Permissions
  • Lesenvehicle_damage_view
  • Anlegenvehicle_damage_create
  • Ändernvehicle_damage_edit
  • Löschenvehicle_damage_delete

Felder

Vehicle Damage Schema

vehicle_damages4 Permissions

Schema for validating vehicle damage report / Schadensmeldung entities

vehicleIduuiderforderlich

Reference to the vehicle

reportedByIduuidoptional

User who reported the damage

nullable
datedateerforderlich

Date of the damage incident

descriptionstringerforderlich

Damage description

1–2000 Zeichen
locationstringoptional

Location on the vehicle (e.g. vorne links, Heckklappe)

max 200 Zeichennullable
damageZonesstring[]optional

Affected zones on the vehicle from the SVG damage map

Default: []nullable
severitystringoptional

Damage severity

MINORMODERATEMAJOR
Default: "MINOR"
statusstringoptional

Current damage status

REPORTEDIN_REPAIRREPAIREDINSURANCE_CLAIM
Default: "REPORTED"
estimatedRepairCoststringoptional

Estimated repair cost in EUR

Patternnullable
actualRepairCoststringoptional

Actual repair cost in EUR

Patternnullable
repairCoststringoptional

Repair cost in EUR as decimal string (legacy)

Patternnullable
repairShopstringoptional

Repair shop / Werkstatt

max 200 Zeichennullable
repairStartDatedateoptional

Repair start date

nullable
repairEndDatedateoptional

Repair end date

nullable
responsiblePartystringoptional

Responsible party for the damage

DRIVERTHIRD_PARTYUNKNOWN
nullable
policeReportNumberstringoptional

Police report number / Polizeiaktenzeichen

max 100 Zeichennullable
insuranceClaimNumberstringoptional

Insurance claim number

max 100 Zeichennullable
insuranceClaimStatusstringoptional

Insurance claim processing status

NONESUBMITTEDIN_REVIEWAPPROVEDDENIEDPAID
nullable
thirdPartyInsuranceobjectoptional

Third party insurance details

nullable
companystringoptional

Third party insurance company

max 200 Zeichen
policyNumberstringoptional

Third party policy number

max 100 Zeichennullable
claimNumberstringoptional

Third party claim number

max 100 Zeichennullable
insuranceDeductiblestringoptional

Insurance deductible amount in EUR / Selbstbeteiligung

Patternnullable
insuranceReimbursementstringoptional

Insurance reimbursement amount in EUR / Erstattungsbetrag

Patternnullable
expertAssessmentDatedateoptional

Expert assessment appointment date / Gutachtertermin

nullable
expertAssessmentCoststringoptional

Expert assessment cost in EUR / Gutachterkosten

Patternnullable
expertReportAttachmentIdstringoptional

Expert report document attachment ID

nullable
insuranceSubmissionDatedateoptional

Date insurance claim was submitted / Einreichungsdatum

nullable
insuranceResponseDeadlinedateoptional

Insurance response deadline / Frist der Versicherung

nullable
insuranceResolutionDatedateoptional

Date insurance claim was resolved / Abschlussdatum der Versicherung

nullable
workflowStepsobject[]optional

Audit trail of completed workflow steps

Default: []nullable
stepstringerforderlich

Workflow step identifier

completedAtdatetimeerforderlich

When step was completed

completedByuuiderforderlich

User who completed the step

notesstringoptional

Notes for this step

max 1000 Zeichennullable
linkedTaskIduuidoptional

Linked ticket/task ID for repair tracking

nullable
attachmentIdsstring[]optional

Photo attachment IDs

Default: []
notesstringoptional

Additional notes

max 2000 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/vehicle_damages — Liste, paginiert + filterbar
  • GET /api/v1/vehicle_damages/<id> — Einzelne Entity
  • POST /api/v1/vehicle_damages — Anlegen
  • PATCH /api/v1/vehicle_damages/<id> — Teil-Update
  • DELETE /api/v1/vehicle_damages/<id> — Soft-Delete
  • GET /api/v1/vehicle_damages/<id>/timeline — Audit + Aktivitäten

Suche