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, Aug 27 '18 at 10:06

Martin Costello · Accepted Answer · 2020-02-24T16:17:04.650

44

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 '20 at 16:17

answered Jan 10 '19 at 17:42

Martin Costello

9,672
5
60
72

What is the value of `reasonPhrase`? – Mister Epic Jan 10 '19 at 20:37
In this case for 404 it would be `"Not Found"`. For `405` it would be `"Method Not Allowed"` etc. – Martin Costello Jan 11 '19 at 09:24
1

It might be worth pointing out that this method is in a [NuGet package](https://www.nuget.org/packages/Microsoft.AspNetCore.WebUtilities/), and is not part of Net Core itself. – Steven Rands Feb 24 '20 at 15:23
1

It's part of asp.net 5.0, no need for Nuget. – Poul Bak May 11 '21 at 19:02

Mister Epic · Answer 2 · 2017-05-04T13:19:43.490

15

This is close enough for my needs:

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

edited May 04 '17 at 13:19

answered May 04 '17 at 13:00

Mister Epic

16,295
13
76
147

1

Not a real solution - you could have done this in ASP.Net, it doesn't give you a user-friendly message. – Chris Peacock Mar 10 '18 at 00:12
3

@ChrisPeacock And that is why I didn't select this as the answer. If someone posts something better, then I will certainly accept it. – Mister Epic Mar 12 '18 at 15:18
I've resorted to copying the code from ASP.Net's HttpWorkerRequest. – Chris Peacock Mar 12 '18 at 16:17

score 4 · Answer 3 · answered Aug 01 '18 at 22:12

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). — Steven Rands, Feb 24 '20 at 15:21

score 4 · Answer 4 · answered Aug 23 '20 at 19:50

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 "";
        }

score 1 · Answer 5 · answered May 27 '21 at 14:24

1

You can do

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

answered May 27 '21 at 14:24

Kishore Kumar

12,675
27
97
154

This would return "NotFound"; the expected result would be "Not Found". – Joel Brighton Jun 22 '23 at 18:30

score 0 · Answer 6 · answered May 24 '23 at 08:48

0

if response is HttpResponseMessage from HttpClient...

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

answered May 24 '23 at 08:48

user21952319

1

Get HTTP status code descriptions in ASP.Net Core

6 Answers6

Linked