Get error message if ModelState.IsValid fails?

Question

I have this function in my controller.

[HttpPost]
public ActionResult Edit(EmployeesViewModel viewModel)
{
    Employee employee = GetEmployee(viewModel.EmployeeId);
    TryUpdateModel(employee);

    if (ModelState.IsValid)
    {
        SaveEmployee(employee);
        TempData["message"] = "Employee has been saved.";
        return RedirectToAction("Details", new { id = employee.EmployeeID });
    }

    return View(viewModel); // validation error, so redisplay same view
}

It keeps failing, ModelState.IsValid keeps returning false and redisplaying the view. But I have no idea what the error is.

Is there a way to get the error and redisplay it to the user?

it has been solved before https://stackoverflow.com/questions/1352948/how-to-get-all-errors-from-asp-net-mvc-modelstate — Hamzeh.Ebrahimi, Jan 27 '19 at 11:20
Does this answer your question? [How to get all Errors from ASP.Net MVC modelState?](https://stackoverflow.com/questions/1352948/how-to-get-all-errors-from-asp-net-mvc-modelstate) — Michael Freidgeim, Apr 05 '23 at 20:42

Captain Kenpachi · Answer 1 · 2019-02-14T11:07:11.017

Try this

if (ModelState.IsValid)
{
    //go on as normal
}
else
{
    var errors = ModelState.Select(x => x.Value.Errors)
                           .Where(y=>y.Count>0)
                           .ToList();
}

errors will be a list of all the errors.

If you want to display the errors to the user, all you have to do is return the model to the view and if you haven't removed the Razor @Html.ValidationFor() expressions, it will show up.

if (ModelState.IsValid)
{
    //go on as normal
}
else
{
    return View(model);
}

The view will show any validation errors next to each field and/or in the ValidationSummary if it's present.

JohnnyHK · Answer 2 · 2016-07-22T16:12:16.340

111

If you're looking to generate a single error message string that contains the ModelState error messages you can use SelectMany to flatten the errors into a single list:

if (!ModelState.IsValid)
{
    var message = string.Join(" | ", ModelState.Values
        .SelectMany(v => v.Errors)
        .Select(e => e.ErrorMessage));
    return new HttpStatusCodeResult(HttpStatusCode.BadRequest, message);
}

edited Jul 22 '16 at 16:12

answered Jun 12 '14 at 15:58

JohnnyHK

305,182
66
621
471

12

Sometimes the `ErrorMessage` is not provided, e.g. if a required `DateTime` field is not set. In this case, look for the exception message, e.g. `e.Exception.Message`. – WhatIsHeDoing Apr 09 '15 at 12:43
Sometimes that's not provided either! I've got a `ModelState` with 5 Errors each with a null `Exception` and empty string for the `ErrorMessage` whilst other entries on the `ModelState` simply have no `Errors` associated with them. – Matt Arnold Jan 16 '19 at 14:22

score 41 · Accepted Answer · answered Mar 06 '11 at 17:54

41

You can do this in your view without doing anything special in your action by using Html.ValidationSummary() to show all error messages, or Html.ValidationMessageFor() to show a message for a specific property of the model.

If you still need to see the errors from within your action or controller, see the ModelState.Errors property

answered Mar 06 '11 at 17:54

Daniel Schaffer

56,753
31
116
165

12

There is no ModelState.Errors property?! – niico Nov 19 '17 at 15:10
@niico I think he means the property of the type `ModelState", whereas the Controller.ModelState property is of type ModelStateDictionary. – devlord Mar 02 '18 at 17:24
4

@niico ModelState.Errors only exists for MVC, not WebAPI – stuzor Nov 23 '18 at 14:33

Sachin T Sawant · Answer 4 · 2016-02-25T13:07:21.307

If Modal State is not Valid & the error cannot be seen on screen because your control is in collapsed accordion, then you can return the HttpStatusCode so that the actual error message is shown if you do F12. Also you can log this error to ELMAH error log. Below is the code

if (!ModelState.IsValid)
{
              var message = string.Join(" | ", ModelState.Values
                                            .SelectMany(v => v.Errors)
                                            .Select(e => e.ErrorMessage));

                //Log This exception to ELMAH:
                Exception exception = new Exception(message.ToString());
                Elmah.ErrorSignal.FromCurrentContext().Raise(exception);

                //Return Status Code:
                return new HttpStatusCodeResult(HttpStatusCode.BadRequest, message);
}

But please note that this code will log all validation errors. So this should be used only when such situation arises where you cannot see the errors on screen.

Would it be possible to get name/message pairs so we know which field had the error? — Matt, Jun 19 '20 at 15:51

score 6 · Answer 5 · answered Feb 14 '19 at 00:23

6

If anyone is here for WebApi (not MVC) you just return the ModelState object:

return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);

answered Feb 14 '19 at 00:23

codeMonkey

4,134
2
31
50

score 3 · Answer 6 · answered Sep 03 '18 at 16:04

It is sample extension

public class GetModelErrors
{
    //Usage return Json to View :
    //return Json(new { state = false, message = new GetModelErrors(ModelState).MessagesWithKeys() });
    public class KeyMessages
    {
        public string Key { get; set; }
        public string Message { get; set; }
    }
    private readonly ModelStateDictionary _entry;
    public GetModelErrors(ModelStateDictionary entry)
    {
        _entry = entry;
    }

    public int Count()
    {
        return _entry.ErrorCount;
    }
    public string Exceptions(string sp = "\n")
    {
        return string.Join(sp, _entry.Values
            .SelectMany(v => v.Errors)
            .Select(e => e.Exception));
    }
    public string Messages(string sp = "\n")
    {
        string msg = string.Empty;
        foreach (var item in _entry)
        {
            if (item.Value.ValidationState == ModelValidationState.Invalid)
            {
                msg += string.Join(sp, string.Join(",", item.Value.Errors.Select(i => i.ErrorMessage)));
            }
        }
        return msg;
    }

    public List<KeyMessages> MessagesWithKeys(string sp = "<p> ● ")
    {
        List<KeyMessages> list = new List<KeyMessages>();
        foreach (var item in _entry)
        {
            if (item.Value.ValidationState == ModelValidationState.Invalid)
            {
                list.Add(new KeyMessages
                {
                    Key = item.Key,
                    Message = string.Join(null, item.Value.Errors.Select(i => sp + i.ErrorMessage))
                });
            }
        }
        return list;
    }
}

score 3 · Answer 7 · edited Jun 06 '19 at 16:17

3

ModelState.Values.SelectMany(v => v.Errors).ToList().ForEach(x => _logger.Error($"{x.ErrorMessage}\n"));

edited Jun 06 '19 at 16:17

Zoe

27,060
21
118
148

answered Jun 06 '19 at 16:15

user781861

89
5

score 3 · Answer 8 · answered Mar 02 '21 at 05:48

Here's a useful snippet I can copy/paste into my OnPostASync() handler to quickly identify the failing validation item(s):

public async Task<IActionResult> OnPostAsync(string editButton)
    {
        if (!ModelState.IsValid)
        {
            var errors = 
                from value in ModelState.Values
                where value.ValidationState == ModelValidationState.Invalid
                select value;  
            return Page();  // <-- I set a breakpoint here, and examine "errors"
        }
        ...

Unlike some of the other solutions above, I can see both

The error message text (ErrorMessage) ... AND ...
The specific field that caused the error

score 2 · Answer 9 · edited Apr 30 '17 at 12:26

2

Ok Check and Add to Watch:

Do a breakpoint at your ModelState line in your Code
Add your model state to your Watch
Expand ModelState "Values"
Expand Values "Results View"

Now you can see a list of all SubKey with its validation state at end of value.

So search for the Invalid value.

edited Apr 30 '17 at 12:26

kenorb

155,785
88
678
743

answered Apr 29 '17 at 18:50

Mostafa Basha

45
2

score 2 · Answer 10 · answered Jul 21 '22 at 19:48

I like creating a ModelState extension method

public static class ModelStateExtensions
{

    public static BadRequestObjectResult As<BadRequestObjectResult>(this ModelStateDictionary modelState) 
    {
        var message = string.Join("\r\n", modelState.Values
                                           .SelectMany(v => v.Errors)
                                           .Select(e => e.ErrorMessage));
        return (BadRequestObjectResult)Activator.CreateInstance(typeof(BadRequestObjectResult), message)!;
    }
}

Then use it like

        if (!ModelState.IsValid)
        {
            return ModelState.As<BadRequestObjectResult>();
        }

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). — Community, Jul 22 '22 at 23:51

score 1 · Answer 11 · answered Jun 17 '21 at 15:29

i use this method as a generic way to get errors

 public static List<string> GetModelErrros(ModelStateDictionary modelState)
        {
            var errors = modelState.Values.Where(E => E.Errors.Count > 0)
                         .SelectMany(E => E.Errors)
                         .Select(E => E.ErrorMessage)
                         .ToList();

            return errors;
        }

and you may use it

logger.LogInformation("ID {0} input Error  ", string.Join(",", SiteUtils.GetModelErrros(ModelState)));

score 0 · Answer 12 · answered Jun 20 '20 at 12:28

publicIHttpActionResultPost(Productproduct) {  
    if (ModelState.IsValid) {  
        //Dosomethingwiththeproduct(notshown).  
        returnOk();  
    } else {  
        returnBadRequest();  
    }  
}

OR

public HttpResponseMessage Post(Product product)
        {
            if (ModelState.IsValid)
            {
                // Do something with the product (not shown).

                return new HttpResponseMessage(HttpStatusCode.OK);
            }
            else
            {
                return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);
            }
        }

score -1 · Answer 13 · answered Feb 13 '19 at 16:15

-1

Try

ModelState.Values.First().Errors[0].ErrorMessage

answered Feb 13 '19 at 16:15

Delmirio Segura

1,651
1
9
5

This gets only first fields first error. try look at @johnnyHK answer above. – Janne Harju Apr 12 '19 at 13:59

score -1 · Answer 14 · answered Nov 20 '11 at 23:30

I have no idea if this is your problem, but if you add a user and then change the name of your application, that user will remain in the database (of course), but will be invalid (which is correct behavior). However, there will be no error added for this type of failure. The error list is empty, but ModelState.IsValid will return false for the login.

Get error message if ModelState.IsValid fails?

14 Answers14

Linked

Related