How to change the response code when not using HttpResponseMessage?

Question

I have this example of ASP.NET Web Api controller:

    public Mea Get(Int32 id)
    {
        try
        {
            return Meas.GetById(id) ?? new Mea(-1, 0D, 0D);
        }
        catch (Exception)
        {
            return new Mea(-1, 0D, 0D);
        }
    }

I want to be able to return a different response code if the GetById returns null or in the catch exception. All the examples that I see use HttpResponseMessage where you can add the response code. My question is how to change the response code when not using HttpResponseMessage, like in the above example?

I don't think it can be done. Why don't you like HttpResponseMessage? — sunil
– sunil, Commented Oct 30, 2013 at 22:26
@sunil It is just about coding convenience, that when you look at the method declaration you see what it returns and not just a generic HttpResponseMessage... — user1615362
– user1615362, Commented Oct 30, 2013 at 23:42

wizzardz · Accepted Answer · 2013-10-31 09:09:17Z

1

Well if you want to have different response code to be return from your function then you will have to wrap it in in a HttpResponseMessage.

Your function will always return an status code "200". Even if you return a bare object the framework pipeline will convert it to a HttpResponseMessage with default status code HttpStatusCode.OK, so better you do it by yourself.

What I would suggest is do not return bare objects/values from your API function. Always wrap the values in a HttpResponseMessage and then return a response message from your function.Basically by wrapping it in the HttpResponseMessage you can have proper status code in client side. Returning HttpResponseMessage is always the best practice.

So please change your function like this

public HttpResponseMessage Get(Int32 id)
{
    try
    {
     // on successful execution
      return this.Request.CreateResponse(HttpStatusCode.OK, Meas.GetById(id) ?? new Mea(-1, 0D, 0D));
    }
    catch (Exception)
    {
      return this.Request.CreateResponse(HttpStatusCode.InternalServerError, Mea(-1, 0D, 0D));
    }
}

in the case of an error you can also throw an HttpResponseException

edited Oct 31, 2013 at 9:09

answered Oct 31, 2013 at 8:49

wizzardz

5,9125 gold badges46 silver badges67 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

user1615362 Over a year ago

Why Returning HttpResponseMessage is always the best practice? Whats wrong with returning the object?

wizzardz Over a year ago

@user1615362: even if you return an object it will be wrapped in an HttpResponseMessage automatically by the framework. by returning as HttpResponseMessage you can have more control over the response from your api function also you can customize the response easily if a need arise in the future

user1615362 Over a year ago

Still, from the type safety perspective, it is better to return an "object".

Myobis Over a year ago

Depending on the situation, when changing the HttpStatucCode, you could also want to return different type of response objects, including a 'cause of error' property for instance. If you want to handle the error case in the controller, it seems to be the way to go. Also read exception-handling from Microsoft.

metalheart · Accepted Answer · 2013-10-31 08:31:33Z

0

You can throw a System.Web.Http.HttpResponseException, specifying an HTTP status code and/or optionally a whole HttpResponseMessage to be returned to the client.

answered Oct 31, 2013 at 8:31

metalheart

3,8091 gold badge26 silver badges29 bronze badges

Collectives™ on Stack Overflow

How to change the response code when not using HttpResponseMessage?

2 Answers 2

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related