Return content with IHttpActionResult for non-OK response

Question

For returning from a Web API 2 controller  I can return content with the response if the response is OK  status 200  like this       public IHttpActionResult Get                 string myResult               return Ok myResult           If possible  I want to use the built-in result types here when possible  https   msdn microsoft com en-us library system web http results v vs 118  aspx  My question is  for another type of response  not 200   how can I return a message  string  with it  For example  I can do this       public IHttpActionResult Get                return InternalServerError            but not this       public IHttpActionResult Get                return InternalServerError  Message describing the error here            Ideally I want this to be generalized so that I can send a message back with any of the implementations of IHttpActionResult   Do I need to do this  and build my own response message        public IHttpActionResult Get                HttpResponseMessage responseMessage              return ResponseMessage responseMessage           or is there a better way

User · Answer

Sorry for the late answer why don t you simple use  return BadRequest  your message     I use it for all my IHttpActionResult errors its working well  here is the documentation   https   msdn microsoft com en-us library system web http apicontroller badrequest v vs 118  aspx

User · Answer

You can use HttpRequestMessagesExtensions CreateErrorResponse  System Net Http namespace   like so   public IHttpActionResult Get        return ResponseMessage Request CreateErrorResponse HttpStatusCode InternalServerError   Message describing the error here         It is preferable to create responses based on the request to take advantage of Web API s content negotiation

User · Answer

mayabelle you can create IHttpActionResult concrete and wrapped those code like this   public class NotFoundPlainTextActionResult   IHttpActionResult       public NotFoundPlainTextActionResult HttpRequestMessage request  string message                Request   request          Message   message             public string Message   get  private set        public HttpRequestMessage Request   get  private set         public Task lt HttpResponseMessage gt  ExecuteAsync CancellationToken cancellationToken                return Task FromResult ExecuteResult                public HttpResponseMessage ExecuteResult                 var response   new HttpResponseMessage             if   string IsNullOrWhiteSpace Message                 response Content   new StringContent Message               response   Request CreateErrorResponse HttpStatusCode NotFound  new Exception Message             response RequestMessage   Request          return response

User · Answer

this answer is based on Shamil Yakupov answer  with real object instead of string   using System Dynamic   dynamic response   new ExpandoObject    response message    Email address already exist    return Content lt object gt  HttpStatusCode BadRequest  response

User · Answer

In ASP NET Web API 2  you can wrap any ResponseMessage in a ResponseMessageResult   public IHttpActionResult Get        HttpResponseMessage responseMessage          return new ResponseMessageResult responseMessage       In some cases this may be the simplest way to get the desired result  although generally it might be preferable to use the various results in System Web Http Results

User · Answer

A more detailed example with support of HTTP code not defined in C  HttpStatusCode   public class MyController   ApiController       public IHttpActionResult Get                 HttpStatusCode codeNotDefined    HttpStatusCode 429          return Content codeNotDefined   message to be sent in response body              Content is a virtual method defined in abstract class ApiController  the base of the controller  See the declaration as below   protected internal virtual NegotiatedContentResult lt T gt  Content lt T gt  HttpStatusCode statusCode  T value

User · Answer

For exceptions  I usually do   catch  Exception ex                        return InternalServerError new ApplicationException  Something went wrong in this request  internal exception      ex Message

User · Answer

I would recommend reading this post  There are tons of ways to use existing HttpResponse as suggested  but if you want to take advantage of Web Api 2  then look at using some of the built-in IHttpActionResult options such as   return Ok      or   return NotFound     Choose the right return type for Web Api Controllers

User · Answer

I ended up going with the following solution   public class HttpActionResult   IHttpActionResult       private readonly string  message      private readonly HttpStatusCode  statusCode       public HttpActionResult HttpStatusCode statusCode  string message                 statusCode   statusCode           message   message             public Task lt HttpResponseMessage gt  ExecuteAsync CancellationToken cancellationToken                HttpResponseMessage response   new HttpResponseMessage  statusCode                        Content   new StringContent  message                     return Task FromResult response                 which can be used like this   public IHttpActionResult Get        return new HttpActionResult HttpStatusCode InternalServerError   error message       can use any HTTP status code     I m open to suggestions for improvement

User · Answer

You can use this   return Content HttpStatusCode BadRequest   Any object

User · Answer

Anyone who is interested in returning anything with any statuscode with returning ResponseMessage     CreateResponse HttpStatusCode  T value  return ResponseMessage Request CreateResponse HttpStatusCode XX  object

User · Answer

Simple   return ResponseMessage Request CreateErrorResponse HttpStatusCode InternalServerError   Your message      Remember to reference System Net Http and System Net

User · Answer

You can also do   return InternalServerError new Exception  SOME CUSTOM MESSAGE

User · Answer

Above things are really helpful   While creating web services  If you will take case of services consumer will greatly appreciated  I tried to maintain uniformity of the output  Also you can give remark or actual error message  The web service consumer can only check IsSuccess true or not else will sure there is problem  and act as per situation      public class Response                    lt summary gt              Gets or sets a value indicating whether this instance is success               lt  summary gt               lt value gt               lt c gt true lt  c gt  if this instance is success  otherwise   lt c gt false lt  c gt                lt  value gt          public bool IsSuccess   get  set      false                lt summary gt              Actual response if succeed               lt  summary gt               lt value gt              Actual response if succeed               lt  value gt          public object Data   get  set      null                lt summary gt              Remark if anythig to convey              lt  summary gt               lt value gt              Remark if anythig to convey              lt  value gt          public string Remark   get  set      string Empty               lt summary gt              Gets or sets the error message               lt  summary gt               lt value gt              The error message               lt  value gt          public object ErrorMessage   get  set      null                 HttpGet          public IHttpActionResult Employees                         Response  res   new Response                try                                DalTest objDal   new DalTest                      res Data   objDal GetTestData                     res IsSuccess   true                  return Ok lt Response gt   res                             catch  Exception ex                                 res IsSuccess   false                   res ErrorMessage   ex                  return ResponseMessage Request CreateResponse HttpStatusCode InternalServerError   res                                 You are welcome to give suggestion if any

User · Answer

I had the same problem  I want to create custom result for my api controllers  to call them like  return Ok  some text     Then i did this  1  Create custom result type with singletone  public sealed class EmptyResult   IHttpActionResult       public Task lt HttpResponseMessage gt  ExecuteAsync CancellationToken cancellationToken                return Task FromResult new HttpResponseMessage System Net HttpStatusCode NoContent    Content   new StringContent  Empty result                 2  Create custom controller with new method   public class CustomApiController   ApiController       public IHttpActionResult EmptyResult                 return new EmptyResult              And then i can call them in my controllers  like this   public IHttpActionResult SomeMethod                return EmptyResult

[c#] Return content with IHttpActionResult for non-OK response

Examples related to c#

Examples related to asp.net-web-api

Examples related to httpresponse