ModelState Patterns — Errors, Display and AJAX Validation

ModelState is the central validation state object in ASP.NET Core MVC. It accumulates validation results from model binding, DataAnnotations, and manual calls to AddModelError(). Knowing how to read, modify, and respond to ModelState — including partial validation, AJAX form submission, and manual error injection — covers every realistic form scenario. These patterns appear throughout the Web API and full-stack integration chapters.

ModelState API #

// ── Checking validity ─────────────────────────────────────────────────────
if (!ModelState.IsValid)
    return View(model);   // re-display form with errors

// ── Reading all errors ─────────────────────────────────────────────────────
foreach (var (key, state) in ModelState)
{
    foreach (var error in state.Errors)
    {
        Console.WriteLine($"{key}: {error.ErrorMessage}");
    }
}

// Errors as a dictionary (useful for AJAX responses)
var errors = ModelState
    .Where(ms => ms.Value!.Errors.Any())
    .ToDictionary(
        ms => ms.Key,
        ms => ms.Value!.Errors.Select(e => e.ErrorMessage).ToArray());

// ── Adding errors manually ────────────────────────────────────────────────
ModelState.AddModelError(nameof(model.Slug), "Slug is already taken.");
ModelState.AddModelError(string.Empty, "An unexpected error occurred.");  // model-level

// ── Removing errors selectively ───────────────────────────────────────────
// Remove an irrelevant field's errors (e.g., a field not shown in this form context)
ModelState.Remove(nameof(model.ConfirmPassword));
// Now ModelState.IsValid only considers other fields
if (!ModelState.IsValid) return View(model);

// ── Clearing ModelState for re-population ────────────────────────────────
ModelState.Clear();   // used when you want to re-render a clean form after partial save

AJAX Form Submission Pattern #

// ── Controller action that handles both regular and AJAX form submissions ──
[HttpPost, ValidateAntiForgeryToken]
public async Task<IActionResult> Create(CreatePostViewModel model)
{
    if (!ModelState.IsValid)
    {
        if (Request.Headers["X-Requested-With"] == "XMLHttpRequest")
        {
            // AJAX request — return JSON with validation errors
            var errors = ModelState
                .Where(ms => ms.Value!.Errors.Any())
                .ToDictionary(
                    ms => ms.Key,
                    ms => ms.Value!.Errors.Select(e => e.ErrorMessage).ToArray());

            return BadRequest(new { success = false, errors });
        }
        return View(model);   // regular form submit — re-display with errors
    }

    // Async business validation
    if (await _service.SlugExistsAsync(model.Slug))
    {
        ModelState.AddModelError(nameof(model.Slug), "Slug already exists.");
        if (Request.IsAjaxRequest())
            return BadRequest(new { success = false, errors = new { model.Slug } });
        return View(model);
    }

    var post = await _service.CreateAsync(model.ToRequest());

    if (Request.IsAjaxRequest())
        return Ok(new { success = true, postId = post.Id, redirectUrl = Url.Action(nameof(Details), new { post.Id }) });

    TempData["Success"] = "Post created!";
    return RedirectToAction(nameof(Index));
}

// ── Extension method for AJAX detection ──────────────────────────────────
public static bool IsAjaxRequest(this HttpRequest request)
    => request.Headers["X-Requested-With"] == "XMLHttpRequest";

Common Mistakes #

Mistake 1 — Using ModelState.Clear() to bypass validation errors #

❌ Wrong — clears all errors to make IsValid = true; proceeds with invalid data.

✅ Correct — fix validation logic or use ModelState.Remove() for specific intentionally excluded fields.

Mistake 2 — Returning JSON errors without the correct HTTP status code #

❌ Wrong — returning 200 OK with error content confuses client-side error handling:

return Ok(new { success = false, errors });   // 200 with errors — misleading!

✅ Correct — return BadRequest(new { errors }) so the client can check HTTP status (400) for failure.