Get HTTP status code descriptions in ASP.Net Core

Question

In previous versions of ASP.Net, we could retrieve the description of a HTTP status code in a few ways as shown here:

Is there something similar to HttpWorkerRequest.GetStatusDescription in ASP.Net Core?

Do you have a HttpResponseMessage? You can use the ReasonPhrase property of it, it seems. It does use HttpStatusDescription internally, but sadly that class is not public. — Ray
– Ray, Commented Aug 27, 2018 at 10:06

Martin Costello · Accepted Answer · 2020-02-24 16:17:04Z

49

You can use Microsoft.AspNetCore.WebUtilities.ReasonPhrases.GetReasonPhrase(int statusCode) (which can be got from the Microsoft.AspNetCore.WebUtilities package in NuGet if not already referenced in your project transiently by a package like Microsoft.AspNetCore.App):

using Microsoft.AspNetCore.WebUtilities;

int statusCode = 404;
string reasonPhrase = ReasonPhrases.GetReasonPhrase(statusCode);

edited Feb 24, 2020 at 16:17

answered Jan 10, 2019 at 17:42

Martin Costello

11.1k5 gold badges66 silver badges78 bronze badges

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

6 Comments

Mister Epic Over a year ago

What is the value of reasonPhrase?

Martin Costello Over a year ago

In this case for 404 it would be "Not Found". For 405 it would be "Method Not Allowed" etc.

Steven Rands Over a year ago

It might be worth pointing out that this method is in a NuGet package, and is not part of Net Core itself.

Poul Bak Over a year ago

It's part of asp.net 5.0, no need for Nuget.

Thomas Williams Over a year ago

Microsoft.AspNetCore.WebUtilities has been marked as deprecated.

|

Mister Epic · Accepted Answer · 2017-05-04 13:19:43Z

15

This is close enough for my needs:

var statusCode = httpContext.Response.StatusCode
var description = ((HttpStatusCode)statusCode).ToString(); // 404 -> "NotFound"

edited May 4, 2017 at 13:19

answered May 4, 2017 at 13:00

Mister Epic

16.8k13 gold badges88 silver badges156 bronze badges

3 Comments

Chris Peacock Over a year ago

Not a real solution - you could have done this in ASP.Net, it doesn't give you a user-friendly message.

Mister Epic Over a year ago

@ChrisPeacock And that is why I didn't select this as the answer. If someone posts something better, then I will certainly accept it.

Chris Peacock Over a year ago

I've resorted to copying the code from ASP.Net's HttpWorkerRequest.

refactorthis · Accepted Answer · 2020-08-23 19:50:18Z

Instead of using a NuGet or splicing a string, here's a simple implementation. These descriptions should match the source of HttpWorkerRequest.

        /// <summary>
        /// Descriptions for Http Status Code
        /// </summary>
        /// <param name="code"></param>
        /// <returns></returns>
        public static string GetHttpStatusDescription(int code)
        {
            switch (code)
            {
                case 100: return "Continue";
                case 101: return "Switching Protocols";
                case 102: return "Processing";
                case 200: return "OK";
                case 201: return "Created";
                case 202: return "Accepted";
                case 203: return "Non-Authoritative Information";
                case 204: return "No Content";
                case 205: return "Reset Content";
                case 206: return "Partial Content";
                case 207: return "Multi-Status";
                case 300: return "Multiple Choices";
                case 301: return "Moved Permanently";
                case 302: return "Found";
                case 303: return "See Other";
                case 304: return "Not Modified";
                case 305: return "Use Proxy";
                case 307: return "Temporary Redirect";
                case 400: return "Bad Request";
                case 401: return "Unauthorized";
                case 402: return "Payment Required";
                case 403: return "Forbidden";
                case 404: return "Not Found";
                case 405: return "Method Not Allowed";
                case 406: return "Not Acceptable";
                case 407: return "Proxy Authentication Required";
                case 408: return "Request Timeout";
                case 409: return "Conflict";
                case 410: return "Gone";
                case 411: return "Length Required";
                case 412: return "Precondition Failed";
                case 413: return "Request Entity Too Large";
                case 414: return "Request-Uri Too Long";
                case 415: return "Unsupported Media Type";
                case 416: return "Requested Range Not Satisfiable";
                case 417: return "Expectation Failed";
                case 422: return "Unprocessable Entity";
                case 423: return "Locked";
                case 424: return "Failed Dependency";
                case 500: return "Internal Server Error";
                case 501: return "Not Implemented";
                case 502: return "Bad Gateway";
                case 503: return "Service Unavailable";
                case 504: return "Gateway Timeout";
                case 505: return "Http Version Not Supported";
                case 507: return "Insufficient Storage";
            }
            return "";
        }

Andris · Accepted Answer · 2018-08-01 22:12:04Z

Improving on the previous answer, you could split HttpStatusCode enum name with spaces, e.g.:

public string GetStatusReason(int statusCode)
{
    var key = ((HttpStatusCode) statusCode).ToString();

    return string.Concat(
        key.Select((c, i) =>
            char.IsUpper(c) && i > 0
                ? " " + c.ToString()
                : c.ToString()
        )
    );
}

Or if you prefer regular expressions:

public string GetStatusReason(int statusCode)
{
    var key = ((HttpStatusCode) statusCode).ToString();
    return Regex.Replace(key, "(\\B[A-Z])", " $1");
}

Also you can simplify it to just this:

public string GetStatusReason(HttpStatusCode statusCode)
{
    var key = statusCode.ToString();
    return Regex.Replace(key, "(\\B[A-Z])", " $1");
}

Looking at the enum key names they seem to be pretty reasonably named so most, if not all, status codes should yield acceptable reason messages.

The only issue with this is status code 200 (OK), which gets converted to "O K" (ie. the characters O and K, with a space inbetween).

Kishore Kumar · Accepted Answer · 2021-05-27 14:24:26Z

1

You can do

int code = 404;
string statusText = Enum.GetName(typeof(HttpStatusCode), code);

answered May 27, 2021 at 14:24

Kishore Kumar

12.9k27 gold badges99 silver badges158 bronze badges

1 Comment

Joel Brighton Over a year ago

This would return "NotFound"; the expected result would be "Not Found".

user21952319 · Accepted Answer · 2023-05-24 08:48:17Z

0

if response is HttpResponseMessage from HttpClient...

ReasonPhrases.GetReasonPhrase((int)response.StatusCode))

answered May 24, 2023 at 8:48

user21952319

1

Collectives™ on Stack Overflow

Get HTTP status code descriptions in ASP.Net Core

6 Answers 6

6 Comments

3 Comments

Comments

1 Comment

1 Comment

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

6 Comments

3 Comments

Comments

1 Comment

1 Comment

Comments

Linked

Related