ASP.NET Web API set custom status code

Question

I have the following Api Controller:

[HttpPost]
public User Create(User user)
{
    User user = _domain.CreateUser(user);
    //set location header to /api/users/{id}
    //set status code to 201
    //return the created user
}

It seems like we have to depend on Request.CreateResponse(..) and change the signature of the controller so as to return IHttpActionResult.

I do not want to change the method signature as it is very useful for the documentation purpose. I am able to add the Location header using HttpContext.Current.Response... but not able to set the status code.

Anybody has any better idea on this?

Nhan · Accepted Answer · 2014-11-11 19:10:11Z

2

Because you are using a custom (other) return type outside of void, HttpResponseMessage, and IHttpActionResult - it's harder to specify the status code. See Action Results in Web API 2.

From Exception Handling in Web API. If you want to stick with not modifying the return type then this might be something you can do to set the status code:

[HttpPost]
public User Create(User user)
{
    User user = _domain.CreateUser(user);
    //set location header to /api/users/{id}

    //set status code to 201
    if (user != null)
    {
        //return the created user
        throw new HttpResponseException(Request.CreateResponse(HttpStatusCode.Created, user);
    }
    else
    {
        throw new HttpResponseException(Request.CreateResponse(HttpStatusCode.InternalServerError));        
    }
}

answered Nov 11, 2014 at 19:10

Nhan

1,4841 gold badge14 silver badges16 bronze badges

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

3 Comments

Matthew James Davis Over a year ago

this is not a good answer. it doesn't deserve a downvote because it does exactly what it says, but throwing exceptions to get the desired behavior here is WAY hacky.

Jijie Chen Over a year ago

Use an exception to indicate a normal result is not a reasonable answer.

Nhan Over a year ago

From the two articles, it is the recommended way by www.asp.net to set a specific status code and return a custom object.

Collectives™ on Stack Overflow

ASP.NET Web API set custom status code

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related