API Documentation - Failure
Format
In case of failure, error details will be displayed in json format: the HTTP status, a TXTWerk-internal error code, a short error message and - if available - more error details. Please find here an example for exceeding the daily limit of API calls:
- {
- status: 403,
- code: "403-002",
- reason: "exceeded request quota",
- details: "number of allowed requests per day (1000) reached"
- }
In case of a validation error, the name of the parameter, the rejected value and the validation error message will be displayed :
- {
- 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."
- }
- {
- ]
- }
List of error codes
Code | HTTP Status | Error message | Description |
---|---|---|---|
400-001 | 400 | request binding error | The request was not identified as a valid request. |
400-002 | 400 | missing document source parameter | The request must include one of the following parameters: 'text', 'document' or 'htmlFile'. |
400-003 | 400 | duplicate document source parameter | The request must contain either 'text' or 'document' or 'htmlFile' parameter, not several of these. |
400-004 | 400 | document source file unknown | The document has been specified via the 'htmlFile' parameter, but is not reachable. |
400-005 | 400 | missing service parameter | The services must be passed as a comma-separated list in the parameter 'services'. Permitted values are listed in the API documentation. |
400-006 | 400 | illegal service parameter value | In your 'services' parameter list is an unsupported service. Please find permitted values in the API documentation. |
400-010 | 400 | uri already exists | Given URI already exists. |
400-011 | 400 | uri does not exist | Given URI does not exist yet. |
400-015 | 400 | missing service parameter | Necessary request parameter missing or wrong. |
400-020 | 400 | Field to patch an entry is missing | No field for a patch was found. |
400-021 | 400 | Unknown field to patch entry | Given field for patch was incorrect. |
401-001 | 401 | missing api key header | The request must contain a valid API Key of the requesting user in the header ("X-Api-Key"). |
401-002 | 401 | unknown api key | An unkown API key was passed in the header "X-Api-Key". |
401-003 | 401 | missing request signature | For the given user, signed requests are mandatory: Please sign the request and pass the signature in the header "X-Signature". |
401-004 | 401 | invalid request signature | The header "X-Signature" in the request signature does not match the request and the API Secret of the requesting user. |
401-005 | 401 | missing admin role | The requested service needs at least lexicon admin role. |
403-001 | 403 | locked api key | You are using the "X-Api-Key" header for a locked API Key. This may be caused by an expired plan or a manual blocking. |
403-002 | 403 | exceeded request quota | The number of requests per day according to your chosen plan was exceeded |
404-404-000 | 404 | Page was not found on server. | Requested page was not found on server. |
422-001 | 422 | validation failed | At least one of the parameters passed is not valid. |
422-002 | 422 | unsupported number of words | documentation.error.description.INVALID_LEXICON_TAG |
500-001 | 500 | unknown server error | A text mining API error has occurred, the request could not be answered. |
500-002 | 500 | watt server error | An error has occured in the nerd services called by the text mining API, the request could not be answered. |
500-003 | 500 | lexicon server error | An error has occured in the services called by the TXT lexicon, the request could not be answered. |