Skip to main content

Objects

This section describes the core objects returned by the Silent Witness API. Understanding these objects helps you work effectively with API responses and build robust integrations.

Core Objects

ObjectDescription
CaseThe central entity representing a legal case with vehicles, occupants, and analysis
VehicleA vehicle involved in the accident, with crash parameters
OccupantA person in the vehicle, used for biomechanics analysis
ReportGenerated technical report with PDF/DOCX outputs
Crash ParametersComputed crash analysis data including delta-v

Object Relationships

Case
├── accident (Accident Info)
├── vehicles[] (Vehicle)
│ ├── files[] (File)
│ └── crash_parameters (Crash Parameters)
├── occupants[] (Occupant)
└── report (Report)

Naming Conventions

The API uses consistent snake_case naming throughout all objects:

  • Field names: plaintiff_name, crash_parameters, delta_v_min
  • IDs: case_id, report_id, vehicle_id
  • Timestamps: created_at, updated_at, calculated_at

Null vs Empty

  • Null objects: Indicates the related resource doesn't exist yet (e.g., crash_parameters: null means delta-v hasn't been calculated)
  • Empty arrays: Indicates no items of that type (e.g., occupants: [] means no occupants defined)
  • Omitted fields: Optional fields may be omitted entirely when not set