How to return Http Status Code from ASP.NET Web API Controller ?

Published on November 26, 2016 by abundantcode

Filed under WebAPI

Last modified November 26, 2016

Print this page

rate 1 star rate 2 star rate 3 star rate 4 star rate 5 star
Your rating: none, Average: 0 (0 votes)

This article have been viewed 3951 times

There are times when you might want to return the Http Status code from an action method of a ASP.NET Web Api Controller.

One of the simplest way of doing this is using the CreateResponse method of the HttpRequestMessage as shown below. The sample below demonstrates how to return the status code 304 and 200 based on the last modified date of the employee record.

How to return Http Status Code from ASP.NET Web API Controller ?

[ResponseType(typeof(Employee))]
public HttpResponseMessage GetACEmployee(HttpRequestMessage request, int empID, DateTime lastModified)
{
    var employee = new EmployeeContext.GetEmployees().First(p => p.Id == empID);
    if (employee.RecordLastModified <= lastModified)
    {
        return new HttpResponseMessage(HttpStatusCode.NotModified);
    }
    return request.CreateResponse(HttpStatusCode.OK, employee);
}

Leave a Comment


x

You might be Interested in these Posts

How to read connection string from web.config in ASP.NET and C# ?

Here's a sample code snippet demonstrating how to get the connection string from your ASP.NET web.co...

How to return Json instead of XML in ASP.NET Web API ?

When you make a call to the ASP.NET Web API action method and notice this in Google Chrome browser ,...

How to Add Web API to existing ASP.NET Web Forms Project ?

In one of the previous posts , we saw how to add the WebAPI to the existing ASP.NET MVC project. Wel...