Home/ Questions/Q 9064977
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-06-16T16:23:24+00:00

I have a REST service that is exposed to iPhone and Android clients. Currently

  • 0

I have a REST service that is exposed to iPhone and Android clients. Currently I follow the HTTP codes 200, 400, 401, 403, 404, 409, 500 etc.

My question is where is the recommended place to put the reason/description/cause of the error? Does it make more sense for the REST API to always have custom Reason in the header like so?

< HTTP/1.1 400 Bad Request - Missing Required Parameters.
< Date: Thu, 20 Dec 2012 01:09:06 GMT
< Server: Apache/2.2.22 (Ubuntu)
< Connection: close
< Transfer-Encoding: chunked

Or is it better to have it in the Response Body via JSON? 

< HTTP/1.1 400 Bad Request
< Date: Thu, 20 Dec 2012 01:09:06 GMT
< Server: Apache/2.2.22 (Ubuntu)
< Connection: close
< Transfer-Encoding: chunked
< Content-Type: application/json
{ "error" : "Missing Required Parameters" }
Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    Quoting from the HTTP specification for 400.x error codes:

    The 4xx class of status code is intended for cases in which the client
    seems to have erred. Except when responding to a HEAD request, the
    server SHOULD include an entity containing an explanation of the error
    situation, and whether it is a temporary or permanent condition. These
    status codes are applicable to any request method. User agents SHOULD
    display any included entity to the user.

    It is best practice to include the error message as an entity in the body of the HTTP response – be it JSON, plain text, formatted HTML, or whatever other format you may want to utilize.

    • 0