API-Dokumentation - Fehlerdokumentation

Format

Im Fehlerfall gibt die Neofonie-Textmining-API im Response-Body Fehlerdetails im JSON-Format zurück: den HTTP-Status, einen TXTWerk-internen Fehlercode, eine kurze Fehlermeldung und wenn verfügbar weitere Fehlerdetails. Eine Antwort für die Überschreitung der zulässigen Requestanzahl pro Tag lautet beispielsweise::

{
- status: 403,
- code: "403-002",
- reason: "exceeded request quota",
- details: "number of allowed requests per day (1000) reached"
}

Falls es sich um Validierungsfehler handelt, wird zusätzlich für jede fehlgeschlagene Validierung der Parametername, der abgelehnte Wert und der Grund in die Error-Response eingefügt:

{
- status: 422,
- code: "422-001",
- reason: "validation failed",
- fieldErrors: [
  - {
    - field: "htmlURL",
    - rejectedValue: "neofonie.de",
    - details: "Must be a valid HTTP URL."
  - },
  - {
    - field: "ntags",
    - rejectedValue: -2,
    - details: "Must have a nonnegative value."
  - }
- ]
}

Liste aller Fehler-Codes

Code	HTTP-Status	Fehlermeldung	Beschreibung
400-001	400	request binding error	Der Request wurde nicht als gültige Anfrage an die Neofonie-Textmining-API identifiziert.
400-002	400	missing document source parameter	Der Request muss einen der Parameter 'text', 'document' oder 'htmlFile' enthalten.
400-003	400	duplicate document source parameter	Der Request darf nur einen der Parameter 'text', 'document' oder 'htmlFile' enthalten.
400-004	400	document source file unknown	Das Dokument wurde über den 'htmlFile'-Parameter spezifiziert, aber unter diesem Parameter wurde keine Datei gefunden.
400-005	400	missing service parameter	Die anzufragenden Services müssen als komma-separierte Liste als Parameter 'services' übergeben werden. Die zulässigen Werte sind in der API-Dokumentation aufgeführt.
400-006	400	illegal service parameter value	In der als Parameter 'services' übergebenen Service-Liste ist ein Service enthalten, der nicht unterstützt wird. Die zulässigen Werte sind in der API-Dokumentation aufgeführt.
400-010	400	uri already exists	Die angegebene URI existiert bereits.
400-011	400	uri does not exist	Die angegebene URI wurde noch nicht angelegt.
400-015	400	missing service parameter	Notwendiger Request-Parameter fehlt oder ist falsch geschrieben.
400-020	400	Field to patch an entry is missing	Es konnte kein Feld für einen Patch gefunden werden.
400-021	400	Unknown field to patch entry	Das angegebene Feld für den Patch ist falsch.
401-001	401	missing api key header	Der Request muss im Header unter dem Namen "X-Api-Key" den API-Key des anfragenden Nutzers enthalten.
401-002	401	unknown api key	Im Header "X-Api-Key" wurde ein API-Key übergeben, der der Neofonie-Textmining-API nicht bekannt ist.
401-003	401	missing request signature	Für den Nutzer ist die Verwendung von signierten Requests eingestellt: In diesem Fall muss der Request signiert und die requestabhängige Signatur im Header "X-Signature" übergeben werden.
401-004	401	invalid request signature	Die im Header "X-Signature" übergebene Request-Signatur passt nicht zum Request und zum API-Secret des anfragenden Nutzers.
401-005	401	missing admin role	Für den angefragten Service ist mindestens die Rolle eines Lexikon-Administrators nötig.
403-001	403	locked api key	Im Header "X-Api-Key" wurde ein gesperrter API-Key übergeben. Ursache könnte der abgelaufene Gültigkeitszeitraum des zugrundeliegenden Tarifs oder eine manuelle Sperrung sein.
403-002	403	exceeded request quota	Die für den zugrundeliegenden Tarif zulässige Anzahl an Anfragen pro Tag wurde überschritten.
404-404-000	404	Page was not found on server.	Die aufgerufene Seite konnte auf dem Server nicht gefunden werden.
422-001	422	validation failed	Mindestens einer der übergebenen Parameter ist nicht gültig.
422-002	422	unsupported number of words	documentation.error.description.INVALID_LEXICON_TAG
500-001	500	unknown server error	In der Neofonie-Textmining-API ist ein Fehler aufgetreten, der Request kann nicht beantwortet werden.
500-002	500	watt server error	In den von der Neofonie-Textmining-API aufgerufenen Services ist ein Fehler aufgetreten, der Request kann nicht beantwortet werden.
500-003	500	lexicon server error	In den von der TXT-Lexikon-API aufgerufenen Services ist ein Fehler aufgetreten, der Request kann nicht beantwortet werden.