What should a JSON service return on failure / error

by

See this question for some insight into best-practices for your situation.

The topline suggestion (from said link) is to standardize a response structure (for both success and failure) that your handler looks for, catching all Exceptions at the server layer and converting them to the same structure. For example (from this answer):

{
    success:false,
    general_message:"You have reached your max number of Foos for the day",
    errors: {
        last_name:"This field is required",
        mrn:"Either SSN or MRN must be entered",
        zipcode:"996852 is not in Bernalillo county. Only Bernalillo residents are eligible"
    }
}

This is the approach stackoverflow uses (in case you were wondering how others do this kind of thing); write operations like voting have "Success" and "Message" fields, regardless of if the vote was allowed or not:

{ Success:true, NewScore:1, Message:"", LastVoteTypeId:3 }

As @Phil.H pointed out, you should be consistent in whatever you choose. This is easier said than done (as is everything in development!).

For example, if you submit comments too quickly on SO, instead of being consistent and returning

{ Success: false, Message: "Can only comment once every blah..." }

SO will throw a server exception (HTTP 500) and catch it in their error callback.

As much as it “feels right” to use jQuery + .ashx + HTTP [status codes] IMO it will add more complexity to your client-side code base than it’s worth. Realize that jQuery does not “detect” error codes but rather the lack of a success code. This is an important distinction when trying to design a client around http response codes with jQuery. You only get two choices (was it a “success” or “error”?), which you have to branch further on your own. If you have a small number of WebServices driving a small number of pages then it might be okay, but anything larger scale may get messy.

It’s much more natural in a .asmx WebService (or WCF for that matter) to return a custom object than to customize the HTTP status code. Plus you get the JSON serialization for free.

More Related Contents:

  1. Jquery Ajax Posting JSON to webservice
  2. Can I return JSON from an .asmx Web Service if the ContentType is not JSON?
  3. How to parse JSON data with jQuery / JavaScript?
  4. Sorting JSON by values
  5. jquery loop on Json data using $.each
  6. Pass array to ajax request in $.ajax() [duplicate]
  7. TypeError: $.ajax(…) is not a function?
  8. How do I format a Microsoft JSON date?
  9. jQuery loop over JSON result from AJAX Success?
  10. How do I build a JSON object to send to an AJAX WebService?
  11. XMLHttpRequest cannot load an URL with jQuery
  12. jQuery autocomplete with callback ajax json
  13. jQuery posting valid json in request body
  14. How to return JSON from a 2.0 asmx web service
  15. Store JSON object in data attribute in HTML jQuery
  16. jQuery getJSON works locally, but not cross domain
  17. jqGrid does not populate with data
  18. data.map is not a function
  19. What does autocomplete request/server response look like?
  20. How to populate a dropdownlist with json data in jQuery?
  21. Return Partial View and JSON from ASP.NET MVC Action
  22. Creating a json object in jsp and using it with JQuery
  23. How to iterate json data in jquery
  24. Populate Select box options on click with Javascript/Jquery with Json data
  25. How can I check if a value is a JSON object?
  26. jQuery – How to PUT JSON via Ajax?
  27. How do I make a JSONP call with JQuery with Basic Authentication?
  28. jquery reading nested json
  29. Why does $.getJSON silently fail?
  30. How to download a file through ajax request in asp.net MVC 4

Leave a Comment