Create custom HttpStatusCode

Question

I am developing webapi in mvc4. I want to create a class which contains Custom HttpStatusCode which inherits HttpStatusCode class. Let's suppose I have one signup api which require user details like Firstname, Lastname, email, password etc. Suppose user enter email abc@abc.com and I check if user already exists. If this email is already exists I want to return Custom HttpStatusCode. Suppose I have created 1001 HttpStatusCode for email already exists.

I tried some thing like this

return new System.Web.Http.Results.ResponseMessageResult(
            Request.CreateErrorResponse(
                (HttpStatusCode)1001,
                new HttpError("Email is already exists.")
            )
        );

But I don't know is it a correct way or not. When we use return Unauthorized(); it means it's an unauthorized access which returns 401 error code. In same way I want to create a custom response and status code. In my case suppose email id already exists then I should return something like this return AlreadyExists() which return 1001 status code. Can I implement such a way? if yes, How can I implement this? can someone please help me?

Why are you inventing HTTP status codes? What do you expect the caller/client to do when it receives your weird 1001 status code? — Ben Robinson, Jan 05 '15 at 11:28
@BenRobinson The one implementing the API should handle the new status codes then. Custom status codes help for specific errors, imho. — Benjamin Diele, Jan 05 '15 at 11:29
You should not invent your own HTTP Status codes! - Find one that fits! — BenjaminPaul, Jan 05 '15 at 11:40

score 6 · Answer 1 · edited Oct 07 '21 at 08:46

6

You shouldn't go about inventing new HTTP status codes. I'd say that at best it violates the Principle of Least Astonishment.

How about returning a response with an HTTP status code of 400 (Bad Request), and an error object that contains your application's error code and message?

Alternatively, you could use the overload of CreateErrorResponse that takes an exception argument.

Request.CreateErrorResponse(
    HttpStatusCode.BadRequest,
    new Exception("Email already exists.")
));

This results in the following JSON being returned from your endpoint:

{
    "Message":"An error has occurred.",
    "ExceptionMessage":"Email already exists.",
    "ExceptionType":"System.Exception",
    "StackTrace":null
}

edited Oct 07 '21 at 08:46

Community

1
1

answered Jan 05 '15 at 11:30

Richard Ev

52,939
59
191
278

Thank you reply. can I inherits HttpStatusCode class in c#? – Ajay Jan 05 '15 at 11:59
[`HttpStatusCode`](http://msdn.microsoft.com/en-us/library/system.net.httpstatuscode(v=vs.110).aspx) is not a class, it is an enumeration (so you cannot inherit from it). – Richard Ev Jan 05 '15 at 12:13
If you _really_ _really_ want to then you can use the [unassigned HTTP status codes](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) like 432-450 range for ClientError. You'll need to create HTTPResponseMessage and set its status code. – GiriB May 08 '18 at 14:54

score 5 · Answer 2 · answered Jan 05 '15 at 11:30

5

When we use return Unauthorized() [...] In my case suppose email id already exists then I should return something like this return AlreadyExists()

Unauthorized() is just a method in the base controller, you can add methods to your own controller:

public IHttpActionResult AlreadyExists()
{
    return new System.Web.Http.Results.ResponseMessageResult(
        Request.CreateErrorResponse(
            (HttpStatusCode)409,
            new HttpError("Already exists")
        )
    );
}

If you want to reuse it, add your own controller base class and let your controllers inherit from that:

public class MyApiController : ApiController
{
    public IHttpActionResult AlreadyExists()
    {
        return new System.Web.Http.Results.ResponseMessageResult(
            Request.CreateErrorResponse(
                (HttpStatusCode)409,
                new HttpError("Already exists")
            )
        );
    }
}

public class RegisterController : MyApiController
{
    // ...
}

And like the others said, don't go invent your own HTTP status codes.

answered Jan 05 '15 at 11:30

CodeCaster

147,647
23
218
272

Thank you for reply. When I call `return AlreadyExists();` So it will return 409 status code right ? – Ajay Jan 05 '15 at 11:34
Yesterday I tried `1001`. It gives me an error related to range. – Ajay Jan 05 '15 at 11:37
1

That is because `1001` is not a valid HTTP status code. – CodeCaster Jan 05 '15 at 11:38
If I use `409` it is not conflict. Because it is already there. – Ajay Jan 05 '15 at 11:40
1

@AjayPunekar, find one that fits then... but either way, DO NOT TRY AND CREATE YOUR OWN!! – BenjaminPaul Jan 05 '15 at 11:41
1

I am not opening the can of worms that is the discussion of _"Which HTTP status code is the most appropriate in situation X"_, and that was not your question. – CodeCaster Jan 05 '15 at 11:41
@CodeCaster can I inherits HttpStatusCode class? – Ajay Jan 05 '15 at 11:59
@AjayPunekar why would you want to do that? And [no, you can't, it's an enum](http://stackoverflow.com/questions/757684/enum-inheritance). – CodeCaster Jan 05 '15 at 12:02

Create custom HttpStatusCode

2 Answers2