Flask, how to return a success status code for ajax call
When returning a response using jsonify
just add the status_code
as the second parameter of the return
. I've used jsonify
in this admin_required decorator with the 401 unauthorized HTTP code. Example:
return jsonify({'error': 'Admin access is required'}), 401
Full example:
def admin_required(f):
@wraps(f)
def decorated(*args, **kwargs):
if current_user and hasattr(current_user, 'user_type') and current_user.user_type == 'admin':
return f(*args, **kwargs)
else:
if '/api/' in request.url_rule.rule:
return jsonify({'error': 'Admin access is required'}), 401
flash(_('Admin access required'))
return redirect(url_for('main.public_index'))
return decorated
About Responses in Flask:
About Responses
The return value from a view function is automatically converted into a response object for you. If the return value is a string it's converted into a response object with the string as response body, a
200 OK
status code and atext/html
mimetype. The logic that Flask applies to converting return values into response objects is as follows:
- If a response object of the correct type is returned it's directly returned from the view.
- If it's a string, a response object is created with that data and the default parameters.
- If a tuple is returned the items in the tuple can provide extra information. Such tuples have to be in the form
(response, status, headers)
or(response, headers)
where at least one item has to be in the tuple. Thestatus
value will override the status code andheaders
can be a list or dictionary of additional header values.- If none of that works, Flask will assume the return value is a valid WSGI application and convert that into a response object.
So, if you return text string (as you are doing), the status code that your AJAX call has to receive is 200 OK
, and your success callback must be executing. However, I recommend you to return a JSON formatted response like:
return json.dumps({'success':True}), 200, {'ContentType':'application/json'}
As an option to aabilio's answer, you can use the jsonify method in Flask which automatically sets the Content-Type:
from flask import jsonify
resp = jsonify(success=True)
return resp
You can (optionally) set the response code explicitly:
resp.status_code = 200
In addition to the answers already posted, I find using the make_response
method in Flask (from version 0.6) to be a clearer alternative especially when you need to return status codes with the response JSON for APIs from Flask:
from flask import Flask, jsonify, make_response
app = Flask(__name__)
@app.route('/do_thing')
def do_thing():
# ... other code ...
data = {'message': 'Done', 'code': 'SUCCESS'}
return make_response(jsonify(data), 201)
if __name__ == '__main__':
app.run(host='0.0.0.0', port=8080)
Also, this approach allows you to pass a response code (201) and will automatically set the Content-Type
header to application/json
.