application/problem+json. Das Feld type sagt maschinenlesbar, was passiert ist, detail enthält einen deutschen Satz, den du anzeigen kannst. Weitere Felder tragen die Werte, die zum Fehler gehören, zum Beispiel den Monat.
Statuscodes
Ungültige Parameter
Jeder abgelehnte Parameter steht als eigener Eintrag inviolations, mit dem Namen in propertyPath, einem deutschen Satz in message und einem stabilen code. Mehrere Fehler kommen in einer Antwort.
scope= ohne Wert lehnt die API als unbekannte Ebene ab (422). Lass den Parameter weg, dann gilt die Ebene aus den Einstellungen.
Ruft eine Anfrage einen Endpunkt ganz ohne Daten auf, etwa POST /api/analytics/finance/snapshots ohne Body, lautet der Typ VALIDATION__EMPTY_PAYLOAD und violations ist leer. Validierungsfehler, die erst nach dem Einsetzen der Voreinstellungen entstehen, haben den Typ ANALYTICS_MRR_FINANCIALS__INVALID_QUERY und dieselbe violations-Form. Für dein System macht das keinen Unterschied: Werte immer violations aus.
Finanzberichte nicht freigeschaltet
Sind die Finanzberichte für deine Organisation noch nicht freigeschaltet, antwortet jeder Endpunkt dieser API mit403:
type. Eine fehlende Berechtigung ist davon getrennt und kommt als FRAMEWORK__ACCESS_DENIED.
404
409
Ein Snapshot für einen laufenden Monat ist ein ungültiger Wert:
422 mit dem Typ ANALYTICS_MRR_FINANCIALS__SNAPSHOT_MONTH_NOT_ENDED, den Feldern month und violations.
Ein Beispiel für jeden Fall findest du unter Snapshots.
Fehler bei Excel-Downloads
Die Excel-Bücher prüfen alle Parameter und rechnen den Datensatz, bevor das erste Byte der Datei gesendet wird.403 und 422 kommen deshalb immer als normale JSON-Antwort. Bricht die Verbindung während der Rohdaten ab, ist die Datei unvollständig, obwohl der Status 200 war. Eine solche Datei lässt sich nicht öffnen, lade sie erneut.
Lässt sich die Datei auf dem Server nicht schreiben, antwortet die API mit 500 und dem Typ ANALYTICS_FINANCE__WORKBOOK_WRITE_FAILED. Lade sie dann erneut herunter.