ErrorResponse

Das Standard-Fehler-Objekt dient zur Vereinheitlichung der Fehlerbehandlung.

{
  "code": "error-code",
  "messageCode": "message-code",
  "violations": [{
    "sourceId": "field-name-or-identifier-of-source-inside-the-request",
    "messageCode": "message-code"
  }]
}

violations

Das Attribut "violations" kann leer sein "[]".

violations.sourceId

Die "sourceId" ist als Identifizierungsmerkmal für eine Fehlerquelle gedacht, wo es mehrere in einem Request geben kann. Üblicher Weise ist es der "fieldName" in Formularen. In Formularen können denen mehrere Felder gleichzeitig invalide sein. Das soll dem Anwender angezeigt werden können.

messageCode und violations.messageCode

Der messageCode soll als Code übertragen werden um damit übersetzungen zu ermöglichen.