Click here to Skip to main content
Click here to Skip to main content

Model Validation in ASP.NET Web API

, 10 Mar 2014
Rate this:
Please Sign up or sign in to vote.
In my previous articles, I discussed about MVC (Model-View-Controller) architecture as well as its implementation in details. I am expecting that the reader of this article already understand about the role of Model in an ASP.NET MVC application. Model in MVC is basically a representation of our dat

In my previous articles, I discussed about MVC (Model-View-Controller) architecture as well as its implementation in details. I am expecting that the reader of this article already understand about the role of Model in an ASP.NET MVC application. Model in MVC is basically a representation of our data structure. So, here in this article, we are going to understand and implement the data annotation technique for applying validation on a model class for an ASP.NET Web API application.

In our ASP.NET Web API article series, we already have created an application that is performing all CRUD (Create, Retrieve, Update, Delete) operations using Web API. Here we will take the same domain model class i.e. "Student.cs" and apply validation on it using data annotation method. In order to better understand with more validation rules, I modified it a bit. So, here is our Model class:

public class Student
{
        [Range(1, 500)]
        public int StudentID { get; set; }
[Required] [MaxLength(10)] public string 
                FirstName { get; set; } public string LastName 
                { get; set; } }

We have applied some validation to our model class properties in the same manner as a database table's fields have associated validation rules. We have applied the attributes to model properties using System.ComponentModel.DataAnnotations namespace.

Our Model class i.e. Student has following validation rules.

  • StudentID value must be between 1 and 500.
  • FirstName is also required with maximum length of 10.
  • LastName has no associated rule.
We will check the validity of Model against the defined validation rules in controller class i.e. StudentController.
1 public class StudentsController 
                : ApiController
2 {
3 public HttpResponseMessage Post(Student Student)
4 {
5 if (ModelState.IsValid)
6 {
7 // Valid scenario code here...
8 return new HttpResponseMessage(HttpStatusCode.OK);
9 }
. else
. {
. return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState);
. }
. }
. }

Now, when the client will send a POST request in JSON format, its being converted to Student object instance and that instance will be validated against the rules defined in Model class. In above code sample, line # 5, Student instance state is validated and accordingly response is generated. Let's suppose if we post following JSON to our ASP.NET Web API service one by one:

    { "StudentID":942, "FirstName":"Imran", "LastName":"Ghani" }
    { "StudentID":100, "FirstName":"ImraaanAbdul", "LastName":"Ghani" }
    { "StudentID":101, "FirstName":"Imran", "LastName":"Ghani" }

JSON representation 1 & 2 will return with the message "Bad Request....Request is Invalid...." because:

  1. StudentID value not between the defined validation range (1 to 500).
  2. FirstName maximum defined length exceeded.

JSON representation 3 is valid and response with status code of 200 will be returned.

Data annotation technique for Model validation is really helpful because it validates data before involving in any further processing. But there are some limitations associated with this approach i.e. Under-Posting and Over-Posting. Hopefully, will try to discuss these concepts in more details in separate post.

Reader of this article might also be interested in:

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Imran Abdul Ghani
Software Developer (Senior)
United Arab Emirates United Arab Emirates
Imran Abdul Ghani has more than 10 years of experience in designing/developing enterprise level applications. He is Microsoft Certified Solution Developer for .NET(MCSD.NET) since 2005. You can reach his blogging at WCF Tutorials, Web Development.
Follow on   Twitter   Google+   LinkedIn

Comments and Discussions

 
-- There are no messages in this forum --
| Advertise | Privacy | Mobile
Web03 | 2.8.140709.1 | Last Updated 10 Mar 2014
Article Copyright 2014 by Imran Abdul Ghani
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid