Error codes

If you try to access an object that does not exists the API responds with the HTTP error code 404. When trying to access an object without the necessary rights you will get an HTTP error code 403 in return.

If another error occurs the API responds with an HTTP status 400 and the following JSON format:

{
    "errors":[
        {
            "field":"name",
            "code":"already_exists",
            "message":"A tag with this name already exists."
        }
    ]
}

Please note that there can be more than one error (example with a german localisation):

{
    "errors":[
        {
            "field":"foo",
            "code":"invalid",
            "message":"Ungültig"
        },
        {
            "field":"bar",
            "code":"required",
            "message":"Pflichtfeld"
        }
    ]
}

An error always specifies the associated field. If the error doesn’t belong to a specific field (like “invalid_json”) the field value is “global_error”.

{
    "errors":[
        {
            "field":"global_error",
            "code":"invalid_json",
            "message":""
        }
    ]
}

Furthermore an error gives you an error code, which is a constant lower case string whose meaning is explained in the table below.

Some errors may provide an user message, too. This is a human readable localised error message translated to the language the user has chosen in the FundraisingBox. Pay attention that not every error provides such a human readable message. Generally speaking these errors without a human readable message points to a programming error. This case is neither caused by a user nor can be fixed by a user.