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

Application Developer, 4 Days Remote, 1 Day in Office
Source: Indeed
Details: Designing and developing user interfaces using ASP.NET web forms and ASP.NET MVC. .NET Framework, Ajax, ASP.NET web forms, ASP.NET MVC, jQuery, nHibernate,...  More
30+ days ago

Des Moines, IA 04-November-2016

Developer, 4 Days Remote, 1 Day in Office
Source: Indeed
Details: Designing and developing user interfaces using ASP.NET web forms and ASP.NET MVC. .NET Framework, Ajax, ASP.NET web forms, ASP.NET MVC, jQuery, nHibernate,...  More
30+ days ago

Iowa City, IA 04-November-2016

.Net Developer
Source: Indeed
Details: .Strong Experience developing MVC applications using ASP.Net MVC. .4+ years experience in software engineering....  More
30+ days ago

Redmond, WA 30-November-2016

.NET Developer (Remote)
Source: Indeed
Details: ASP.NET MVC using C#. 3+ years of experience building web-based applications using ASP.NET MVC – C#. This is a full-time remote position....  More
6 days ago

Nashville, TN 13-January-2017

.NET Developer
Source: TS Solutions
Details: ASP.NET MVC (4), C#, Azure, SQL Server. TokuSaku (TS) Solutions is looking for .NET developer with numerous bolt-on skill sets to help with our list of direct...  More
19 hours ago

Seattle, WA 19-January-2017

ASP.NET / C# Software Developer (Web Services & API)
Source: Indeed
Details: C#, ASP.NET, MVC or better required, Java/Node.js a plus. The Software Developer is an experienced engineer that uses C#, ASP.NET, MVC to build web services,...  More
4 days ago

Tacoma, WA 16-January-2017

Senior Software Engineer (.Net)
Source: SmartDrive Systems, Inc.
Details: Expertise in C#, ASP.Net MVC, WCF, Web API, Angular JS and SQL Server. Architect, design and develop high performing web sites, mobile applications and scalable...  More
30+ days ago

San Diego, CA 18-October-2016

UX Developer
Source: Indeed
Details: Atleast 3+years of experience in development using .NET Framework technologies like C#, ASP.NET, MVC etc. • Excellent written and verbal communication skills •...  More
6 days ago

Redmond, WA 13-January-2017

Senior C# .NET Software Engineer
Source: Clark Associates
Details: Join one of Pennsylvania’s fastest growing companies today! WebstaurantStore, a division of Clark Associates, is looking for Senior C# .NET Software Engineer  More
9 days ago

Lititz, PA 17543 10-January-2017

C# ASP.Net Web Developer
Source: Indeed
Details: Experience with various web technologies, such as HTML, CSS, AJAX, JQuery, JavaScript, AngularJS, Bootstrap, XML, ASP.NET, MVC, WebForms, Web Services, IIS....  More
7 days ago

Irvine, CA 12-January-2017

Asp.net C# developer
Source: Indeed
Details: Asp.net MVC web development experience. 2-3 year C# and .net experience....  More
8 days ago

Indianapolis, IN 12-January-2017

Developer - Web
Source: Geocaching
Details: Proficient with ASP.NET, MVC, REST, WCF, Web API and scalable service oriented architectures. About Geocaching HQ....  More
13 days ago

Seattle, WA 98103 07-January-2017

C# Software Developer (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
7 days ago

Seattle, WA 12-January-2017

Sr. ASP.NET Developer
Source: Indeed
Details: *ABSOLUTELY NO 3RD PARTIES FOR THIS POSITION* Participate and collaborate in design sessions ·Code / refactor one or multiple front-end web applications   More
14 days ago

Dallas, TX 75251 05-January-2017

ASP.NET MVC Web Developer
Source: Indeed
Details: 3+ years of C#, ASP.Net MVC, Entity Framework, HTML, JavaScript, JQuery, AJAX. We are in the process of switching applications from ASP.NET web forms into MVC 5...  More
15 days ago

Tigard, OR 04-January-2017

Jr .Net Developer
Source: Indeed
Details: Familiar with Web-API and REST in the ASP.NET MVC world. Professional job experience with C# and ASP.NET MVC (not just ASP.NET web forms). Full time/Long Term*....  More
21 days ago

Redmond, WA 29-December-2016

Technical Lead
Source: Morgan Stanley
Details: Must be experienced in AngularJS, client-side MVC, HTML5, CSS3, JavaScript,. Must have hands-on recent expertise in C#, ASP.NET, MVC, Web API, Rest Service....  More
30+ days ago

New York, NY 10032 19-December-2016

.NET Developer
Source: Indeed
Details: Web development using ASP.NET MVC. CANDIDATE MUST BE AVAILABLE FOR IN-PERSON INTERVIEW\*\*\*\*\*....  More
1 hour ago

Minneapolis, MN 20-January-2017

Developer Sr.
Source: Adroit Partners, LLC
Details: Use technologies, such as C#, ASP.NET, MVC, SQL, No-SQL (Couchbase, MongoDB), Enterprise Service Bus, to develop technical solutions to complex problems that...  More
6 hours ago

Houston, TX 20-January-2017

Software Developer
Source: Cortland Capital Market Services
Details: ASP.NET/MVC, HTML, Ajax, JQuery, JSON, JavaScript, XML/XSLT, CSS, NET 3.5/4.0/4.5 . A unique opportunity for a skilled and career-minded software engineer with...  More
8 hours ago

Brea, CA 20-January-2017

C#.Net Application Developer(Local: F2F)
Source: Indeed
Details: Web development using ASP.NET MVC. C#.Net Applications Developer*....  More
14 hours ago

Eden Prairie, MN 20-January-2017

.NET Developer
Source: Indeed
Details: C# .NET, ASP.NET, MVC, HTML 5, JQUERY, ANGULAR, JSON, RESTFUL WEB SERVICES, ENTITY FRAMEWORK, LINQ, RESPONSIVE WEB DESIGN, MS SQL and MOBILE....  More
16 hours ago

Rockville, MD 19-January-2017

C#.Net Developer
Source: Indeed
Details: Experience building web based applications with ASP.NET, MVC, Web Forms, HTML, CSS, JavaScript, jQuery and other client-side scripting technologies....  More
17 hours ago

Winter Springs, FL 19-January-2017

Sr. Full Stack C#/.NET Developer (10+ Years experience)
Source: Indeed
Details: MVC:. Expertise in most of the following - REACT.JS, Web API (MS ASP.Net), MVC, WCF, HTML5, CSS, JavaScript, JSON, SOAP, REST, JQuery, .Net Framework, C#, Web...  More
1 day ago

Austin, TX 18-January-2017

UI developer w/ .NET background
Source: Avani Tech Solutions
Details: MVC. ASP MVC/Web API. 5 years developing applications using ASP.NET MVC. UI developer w/ .NET background....  More
1 day ago

Houston, TX 18-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.