Unicat API Reference

Up - API Reference - Home

Error responses

Found in the result property of unsuccessful requests.

HTTP errors

The HTTP status code matches the error code.

400 Bad request - Missing parameters or wrong type or value
401 Unauthorized - Missing or expired JWT
403 Forbidden - Unknown user, or not a member of the project
422 Unprocessable entity - Entity doesn't exist
500 Internal server error - Please stop doing this
501 Not implemented - …yet

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="JWT access to Unicat."

{
    "success": false,
    "result": {
        "code": 401,
        "message": "Permission denied",
        "info": {}
    },
    "data": {}
}

Other API errors

These are reported with HTTP status code 422.

1000 Unexpected error - The Spanish Inquisition arrived
1001 Validation error - Invalid data for field - see Validation information
1002 Search error - Couldn't connect to the search backend
1003 Process error - External process failed
1004 Invite invalid - Invitee is deactivated for the project or has declined
1005 Excel worksheet invalid - Excel import failed
1006 Bulk selection error - Bulk operation on a selection failed

HTTP/1.1 422 Unprocessable entity

{
    "success": false,
    "result": {
        "code": 1001,
        "message": "Validation error",
        "info": {}
    },
    "data": {}
}