Inhalt der Dokumentation

Fehlermodell

Alle Funktionen verwenden denselben Fehlervertrag.

Statuscodes

Status	Bedeutung	Was Sie tun
200	Erfolg, das Ergebnis steht im Feld `message`	Ergebnis verarbeiten
401	Nicht angemeldet oder Schlüssel ungültig	Anmeldung prüfen
403	Rolle oder Dokumentrecht fehlt	Rollen des Benutzers prüfen
404	Beleg nicht gefunden	Name prüfen
409	Beleg existiert bereits	vorhandenen Beleg verwenden
417	Eingabe abgelehnt, die Meldung nennt Feld und Code	Eingabe korrigieren
429	Zu viele Aufrufe in kurzer Zeit	später erneut senden
500	Unerwarteter Fehler, die Antwort enthält eine Fehlernummer	Fehlernummer an den Support geben

Erwartbare Eingabefehler

Fehlt eine Pflichtangabe oder ist ein Wert unzulässig, antwortet die Funktion mit Status 417. Die Meldung ist deutsch und endet mit Feld und Code, zum Beispiel (Feld: kunde, Code E-FEHLT). Der Code bleibt für eine Meldung stabil und eignet sich für die Auswertung im Programm.

Fehlernummer bei unerwarteten Fehlern

Tritt ein Fehler auf, der nicht zur Eingabe gehört, sieht der Aufrufer nur eine kurze Fehlernummer: im Feld fehlernummer der Antwort und im Meldungstext. Die Einzelheiten stehen im Fehlerprotokoll und lassen sich dort über die Nummer finden. Technische Texte, Pfade und Stacktraces verlässt der Server nie.

{
  "exc_type": "ValidationError",
  "_server_messages": "[\"...\"]",
  "fehlernummer": "7K3Q"
}

Funktionen mit diesem Verhalten sind in der Referenz mit "Fehlernummer bei unerwarteten Fehlern" gekennzeichnet. Siehe auch Fehlerbehebung.