Modellen

Error

Standaard foutresponse-formaat

Foutresponse-vorm

Alle endpoints geven fouten terug in deze uniforme envelope.

{
  "success": false,
  "error": {
    "code":    "INVALID_URL",
    "status":  400,
    "message": "The provided URL is not valid",
    "details": null
  }
}

Velden

  • success (boolean): altijd false bij fouten
  • error.code (string): machineleesbare foutcode — zie Foutcodes
  • error.status (number): HTTP-statuscode (spiegelt de responsstatus; handig als de ruwe status niet beschikbaar is)
  • error.message (string): leesbare foutbeschrijving
  • error.details (object | null): gestructureerde context van de fout — bijvoorbeeld validatiefouten op veldniveau als { field: message }-paren bij INVALID_PARAMETER; null indien niet van toepassing

TypeScript-type

type ErrorResponse = {
  success: false;
  error: {
    code: string;       // machine-readable, e.g. "INVALID_URL"
    status: number;     // HTTP status code
    message: string;    // human-readable
    details: Record<string, unknown> | null;
  };
};

Stabiel contract: deze 4 error.*-velden zijn gegarandeerd. Toekomstige toevoegingen blijven achterwaarts compatibel — clients kunnen onbekende velden veilig negeren.