Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Invalid payload

Immediate

If you submit an invalid payload, your API call will immediately be rejected with the error payload typical for the API. Here is an example when submitting an invalid source locale:

Code Block
{
  "error": {
    "operation": null,
    "date": "2024-04-03T15:57:01.2110105Z",
    "title": "Invalid parameter 'src': Invalid source locale"
  },
  "reason": "Invalid parameter 'src': Invalid source locale"
}

Resolution: You likely need to fix your payload.

Operation failed

Delayed

If your payload is valid, your request is now queued. If the operation then fails with a fatal error, you get the async error payload. For example:

Code Block
{
    "trm": {
        "requestid": 559,
        "isbatch": false,
        "status": "Failed",
        "statusText": "Operation failed!",
        "statusInfo": "The parameter xy was not properly supplied"
    }
}

Resolution: Depending on the error message. You should not see such issues often. If the error details are unclear you may need to reach out to Wordbee support.

Operation ok but file failed

Delayed

The operation may have executed just fine but a submitted file (or several) could not be processed. The file specific error will be listed in the results, look for example success and error:

Code Block
"custom": {
        "files": [
            {
                "name": "file-003.htm",
                "format": {
                    "formatId": 7952,
                    "formatName": "Default Gemini",
                    "formatDomain": "HTML"
                },
                "exists": false,
                "success": false,
                "error": "Failed to process file. No segments.",
                "did": null,
                "segments": null
            }
        ]

Resolution: Depending on the message. You likely face one of these issues:

  • The file is invalid and failed to process. Think of a badly formatted XML file. Please check your files test manually in Wordbee Translator.

  • The file name is invalid, such as too long or contains invalid characters. Please fix file naming conventions.

  • The file contains 0 segments. Please do not submit empty files, Wordbee does not like them.

...