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

.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
24 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
24 days ago

Seattle, WA 01-February-2017

.Net Developer
Source: Indeed
Details: C#.NET, VB.NET and/or ASP.NET MVC, TFS.Web development tools including HTML5, JavaScript, jQuery, AJAX, LINQ, CSS,....  More
21 days ago

Rockwell, MD 03-February-2017

.NET Developer, Junior
Source: Booz Allen Hamilton
Details: 1+ years of experience with ASP.NET, MVC, or Web forms development. Booz Allen Hamilton has been at the forefront of strategy and technology for more than 100...  More
15 hours ago

Atlanta, GA 25-February-2017

Senior Software Developer #17-043
Source: Indeed
Details: Experience building web applications using Google Web Toolkit (GWT) or frameworks such as ASP.NET MVC, Spring MVC, Angular, Ember, or React....  More
3 days ago

Arlington, VA 22-February-2017

.NET / Mobile Application Developer, Junior
Source: Booz Allen Hamilton
Details: 1+ years of experience with ASP.NET, MVC, or Web forms development. Booz Allen Hamilton has been at the forefront of strategy and technology for more than 100...  More
2 days ago

Atlanta, GA 22-February-2017

Application Developer -- C#, ASP.NET Web Forms/MVC
Source: Indeed
Details: .NET framework (3.5 or newer) -- especially with .NET Web Services, ASP.NET MVC, ASP.NET Web Forms and LINQ. We have a fulltime programmer position open for an...  More
2 days ago

Golden Valley, MN 23-February-2017

Software Developer (.NET Web Services & API)
Source: Indeed
Details: C#, ASP.NET, MVC or better required, Java/Node.js a plus. If you’re looking for a rewarding career with a dynamic and fast-growth healthcare software company,...  More
3 days ago

Tucson, AZ 22-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
8 days ago

Illinois 17-February-2017

.NET Software Developer
Source: Indeed
Details: ASP.NET, Entity Framework, MVC, Ajax, jQuery, Bootstrap. Web application development using Visual Studio (2013, 2015) C# and ASP.NET MVC, JavaScript, Ajax, LINQ...  More
3 days ago

Fairfax, VA 22030 21-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
11 days ago

Alexandria, VA 22314 14-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
7 days ago

Charlotte, NC 17-February-2017

Senior Software Engineer
Source: Indeed
Details: Web based user interface software development using Angular2, JavaScript, Bootstrap, Web API, ASP.NET MVC, etc....  More
15 days ago

Tucson, AZ 09-February-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
9 days ago

Madison, WI 15-February-2017

Front End Developer
Source: Indeed
Details: Experience with ASP.NET MVC, Web APIs, C#, and the .NET Framework. Rational is a full service, integrated agency with proven ability to deliver across digital,...  More
1 day ago

Redmond, WA 23-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

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
7 days ago

Austin, TX 78759 17-February-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
7 days ago

Baltimore, MD 17-February-2017

NET DEVELOPER - JUNIOR (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
7 days ago

Baltimore, MD 17-February-2017

.Net Developer
Source: Indeed
Details: ASP.NET MVC and WebForms. Net Developer- Las Vegas, NV. Must be authorized to work in the USA.*....  More
30+ days ago

Las Vegas, NV 06-December-2016

Full Stack Developer IV
Source: Indeed
Details: Minimum 4 years experience with writing WebAPI/RESTFul API and working in an ASP.NET MVC environment. Keyventer is seeking a *Full Stack Web*....  More
2 days ago

Seattle, WA 22-February-2017

Full Stack Web Developer
Source: Indeed
Details: C# / ASP.NET MVC. Opportunity to play with a modern Microsoft-oriented web stack (C# 7, Typescript, ASP.NET MVC, EF/LINQ, React/Redux, HTML5, Sass, VS2017,...  More
3 days ago

Seattle, WA 22-February-2017

.Net Developer
Source: Indeed
Details: *Job Functions and Responsibilities: * Looking for a multi-talented software/web developer to add to ITCON Services dynamic team supporting a highly visible  More
30+ days ago

Washington, DC 02-November-2016

AWS Developer
Source: Indeed
Details: Amazon experience is amust *Ruby-on-rails* and *Java* for a Amazon’s new project,. Requirement is simply three: * JavaScript: 3-5 years * Ruby on rails -...  More
8 days ago

Redmond, WA 16-February-2017

Web Developer - 3888
Source: Indeed
Details: 3-5+ years development with Microsoft ASP.NET MVC (including jQuery, Knockout/Angular). ISoftStone North America is looking for a Web Developer to join our...  More
10 days ago

Redmond, WA 14-February-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.