Can I return a 504 HTTP code in ASP net core

Question

Currently I have an ExceptionFilterAttribute to handle exceptions on controllers. My API connects to a service (via proprietary TCP/IP). If this service is not reachable I want to return a HTTP 504 response code with a proper error message.

I have figured out how to send a 400

public override void OnException(ExceptionContext context)
{
    if (!MyService.IsConnected)
    {
        context.Result = new BadRequestObjectResult(new ResultInformation() { ResultCode = 2000056, Message = "My service is not reachable" });

    }
    else
    {
        context.Result = new BadRequestObjectResult(new ResultInformation() { ResultCode = 0, Message = context.Exception.Message });
    }
}

How can I change this code to send a 504 and the error message?

Nkosi · Accepted Answer · 2019-02-27 21:12:38Z

5

Use ObjectResult and set the status code manually.

//... omitted for brevity

if (!MyService.IsConnected) {
    var info = new ResultInformation() { 
        ResultCode = 2000056, 
        Message = "My service is not reachable" 
    };
    context.Result = new ObjectResult(info) {
        StatusCode = 504
    };
}

//... omitted for brevity

Most of the standard status result types that require an object body are in fact derived from ObjectResult where they set their specific status code. For example BadRequestObjectResult

If you do not need to actually return a response body, you can instead use StatusCodeResult

context.Result = new StatusCodeResult(504);

edited Feb 27, 2019 at 21:12

answered Feb 27, 2019 at 17:18

Nkosi

249k38 gold badges472 silver badges506 bronze badges

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

3 Comments

Chris Pratt Over a year ago

This is your answer here. When you need a response body and no other more specific result type will do, use ObjectResult and set the status code manually. If you do not need to actually return a response body, though, you can just use StatusCodeResult.

Nkosi Over a year ago

@ChrisPratt I'll add in that second part as additional info that will be useful to the op

Mat Over a year ago

That worked like a charm. BTW I used the StatusCodes enum instead of 504

Amir Molaei · Accepted Answer · 2019-02-27 17:17:38Z

0

Try this:

context.HttpContext.Response.StatusCode = 504;

answered Feb 27, 2019 at 17:17

Amir Molaei

3,8601 gold badge20 silver badges22 bronze badges

1 Comment

Chris Pratt Over a year ago

This doesn't really help the OP in their particular scenario. They need to return some sort of IActionResult, but don't know which is best. Setting the response status code directly will be potentially overridden by the eventual result type they return.

Collectives™ on Stack Overflow

Can I return a 504 HTTP code in ASP net core

2 Answers 2

3 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related