Model Validation in ASP.NET Web API

By | March 10, 2014
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInDigg thisPin on Pinterest

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.Validation in ASP.NET Web API

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.

You are designing an ASP.NET Web API application. You need to select an HTTP verb to allow blog administrators to moderate a comment. Which HTTP verb should you use?

  • A. GET
  • B. POST
  • C. DELETE
  • D. PUT

To further test your ASP.NET Web API skill, Take a Complete FREE Online Test or MCSD Practice Exam: 70-486 (Developing ASP.NET MVC Web Applications). Simply Click Here.

 Correct Answer: D

Let’s suppose if we post following JSON to our ASP.NET Web API service one by one:

  1. { “StudentID”:942, “FirstName”:”Imran”, “LastName”:”Ghani” }
  2. { “StudentID”:100, “FirstName”:”ImraaanAbdul”, “LastName”:”Ghani” }
  3. { “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. Follow the post for Limitations to Model Validation in ASP.NET Web API.

  • Learn ASP NET MVC 5 step by step [Maruti Makwana, Corporate Trainer] 28 Lectures, 2.5 Hours Video, Intermediate Level
    Very easy to learn video series on Asp.Net MVC 5 Specially for those who are familiar with Asp.Net Web forms.
  • AngularJS for ASP.NET MVC Developers [Brett Romero] 10 Lectures, 1 hour video, Intermediate Level
    The Fastest Way For .NET Developers To Add AngularJS To Their Resume
  • ASP.NET with Entity Framework from Scratch [Manzoor Ahmad, MCPD | MCT] 77 Lectures, 10 hour video, All Level
    Latest approach of web application development
  • Comprehensive ASP.NET MVC [3D BUZZ] 34 lectures, 14 Hours Video, All Levels
    From zero knowledge of ASP.NET to deploying a complete project to production.

More You Must Read about ASP.NET MVC & Related

Top 10 Interview Questions and Answers Series:

ASP.NET MVC Jobs in Dubai, United Arab Emirates [Updated Daily]

Top ASP.NET MVC Jobs

IT Software Developer
Source: Far Bank Enterprises
Details: Developing applications using Microsoft technologies, including C# and ASP.Net MVC. Far Bank Enterprise is seeking a Software Developer to join our IT team on...  More
15 days ago

Bainbridge Island, WA 04-February-2017

.Net Developer
Source: Ramsoft Systems, Inc.
Details: ASP.Net, MVC Framework, C#, Entity Framework. Hope you are doing well....  More
19 days ago

Richmond, VA 23229 31-January-2017

.NET Developer with Microsoft Active Directory
Source: Ramsoft Systems, Inc.
Details: ASP.Net, MVC Framework, C#, Entity Framework. Hope you are doing well....  More
22 days ago

Richmond, VA 23229 28-January-2017

Software Developer II
Source: Almac Group, Inc
Details: C#, .NET 4.5 or higher, Linq, ASP.NET MVC, Visual Studio 2013 or higher. Almac Group is a group of established businesses at the forefront of the Pharmaceutical...  More
3 days ago

Lansdale, PA 19446 17-February-2017

Junior Level .NET Developer
Source: Levi, Ray & Shoup, Inc.
Details: Time to get to work! LRS Consulting Services is seeking a Junior Level .NET Developer for a 3-6 month contract-to-hire opportunity with our client in Central  More
2 days ago

Illinois 17-February-2017

Software Developer
Source: Indeed
Details: Experience with Microsoft *Visual Studio 2013+* and *C# 4.5.* Experience creating *WCF* and *Web API* services. Understanding of *object oriented design* &   More
24 days ago

Redmond, WA 26-January-2017

Software Developer - Operations
Source: Hudl
Details: You’ll likely be working with technologies like React and Bootstrap, C# and ASP.NET MVC, MongoDB, and a number of AWS services....  More
12 days ago

Lincoln, NE 68508 07-February-2017

Junior .NET Developer
Source: SBG Technology Solutions
Details: Must have a clear understanding of ASP.NET MVC, and MVC application design pattern experience. At least five (5) years of development experience, including 4+...  More
5 days ago

Alexandria, VA 22314 14-February-2017

Software Developer
Source: Indeed
Details: *Michigan based applicants ONLY* Equal Opportunity Employer; E-Verify Participant _\*Please do not apply if you are not legally authorized to work in the  More
4 days ago

Lansing, MI 15-February-2017

Software Developer
Source: Indeed
Details: _Experience with Microsoft .NET C# and ASP.NET, MVC, & Entity Framework_. Intellicheck Mobilisa is a publicly-traded technology company located in Jericho, NY...  More
5 days ago

Jericho, NY 14-February-2017

Junior .NET Developer
Source: Publishers Clearing House
Details: Windows Forms, WCF, ASP.NET, MVC. Publishers Clearing House (PCH), headquartered in Port Washington, NY (soon to be Jericho, NY!)....  More
30+ days ago

Port Washington, NY 11050 12-December-2016

Software Developer
Source: Altruista Health
Details: Deep technology experience, including ASP.Net, MVC, C#.Net, SQL Server 2008, and SQL Server 2012. Altruista Health, Inc., is seeking an experienced professional...  More
12 days ago

Reston, VA 20190 07-February-2017

.Net Developer
Source: Indeed
Details: MVC:. Develop web, web services and back-office applications using the newest Microsoft stack of technologies including Net CORE, ASP.NET, MVC, Angular,...  More
2 days ago

Charlotte, NC 17-February-2017

ASP.NET/Angular Developer
Source: Intellisoft Technologies
Details: No new resumes ASP.NET/Angular Developer BlackHawk 700 State Hwy. 121 Bypass Suite 200 Lewisville, Texas 75067 6+ Month Contract Industry leading Client...  More
30+ days ago

Dallas, TX 05-January-2017

Certified Microsoft .NET Developer
Source: Indeed
Details: The project includes .Net MVC web applications with heavy use of JavaScript, jQuery and Kendo UI components....  More
4 days ago

Madison, WI 15-February-2017

.NET Developer
Source: NYC Careers
Details: Experience building full-featured software with ASP.NET MVC, WebForms, VB.NET, SQL and Javascript. The Kings County District Attorney's Office, located in the...  More
4 days ago

Brooklyn, NY 15-February-2017

.Net Developer
Source: Indeed
Details: ASP.NET MVC, JQuery, Entity framework, HTML programming. .Net MVC 4.0 and Strong experience in designing and developing layered web based applications with...  More
18 days ago

Bellevue, WA 01-February-2017

.NET DEVELOPER
Source: Indeed
Details: ASP.NET MVC, JQuery, Entity framework, HTML programming. .Net MVC 4.0 and Strong experience in designing and developing layered web based applications with...  More
18 days ago

Seattle, WA 01-February-2017

Software Engineer C# .Net Developer
Source: MorphoTrust
Details: Responsible for software design and implementation (C#/.Net, ASP.Net MVC, SQL Server, Javascript), testing, debugging, assurance testing, and creation of...  More
30+ days ago

Bloomington, MN 18-January-2017

Software Development Engineer I
Source: Apptio
Details: You: You are a software engineer who strives for excellence in the user’s experience as well as in your technical solutions. You have a curious mind and a...  More
30+ days ago

Bellevue, WA 05-January-2017

NET DEVELOPER - SENIOR (FULL-TIME CONTRACTUAL)
Source: State of Maryland
Details: ASP.NET MVC with Razor. SQL Server 2012, Visual Studio 2015, .NET 4.6 and MVC 5. Development, maintenance, trouble-shooting and debugging of .NET applications...  More
2 days ago

Baltimore, MD 17-February-2017

Developer - Full Stack ASP.NET MVC, C#, SQL Server
Source: Indeed
Details: ASP.NET MVC, C#, SQL Full Stack Server Developer (Austin, Tx)*. Who We Are ...*....  More
2 days ago

Austin, TX 78759 17-February-2017

Mid .Net Developer
Source: Indeed
Details: *Secret Clearance Required!!!!* Current contract until 2020! This highly responsible position involves using established work procedures to analyze, design,  More
5 days ago

Herndon, VA 20171 14-February-2017

Senior Developer
Source: Indeed
Details: Knowledge or experience in ASP.NET, MVC 3+, WCF, ADO.NET. NO C2C PLEASE*....  More
6 days ago

Chicago, IL 60654 13-February-2017

Software Engineer/Developer
Source: ITR (Information Technology Resources)
Details: Candidates demonstrating applied experience with ASP.NET MVC, Java, and Linux will be given extra consideration....  More
30+ days ago

Oak Ridge, TN 08-January-2017
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInDigg thisPin on Pinterest
Category: ASP.NET Web API Tags:

About IMRAN ABDUL GHANI

Imran Abdul Ghani is working as Software Developer(Senior) with extensive knowledge in Web development technologies especially C#, ASP.NET, MVC, WCF, Web API, ADO.NET Entity Framework, jQuery etc. He has several 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 www.webdevelopmenthelp.net, www.topwcftutorials.net, and www.sharepointfordummies.net.