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 Support Engineer
Source: Indeed
Details: Good knowledge of ASP DOT NET with C Sharp. .NET / Angular JS or KnockOut JS / ASP.NET MVC / C#.NET / SQL Server / Web API. .Net Support Engineer....  More
1 day ago

New York, NY 21-June-2017

Software Developer (.NET)
Source: Advantech
Details: Back-end coding skills using C#, ASP.NET MVC, Web API, MS-SQL / T-SQL. Responsibilities include design, new development, testing and maintaining MVC - based web...  More
29 days ago

Carol Stream, IL 60188 25-May-2017

C# .Net Developer (Locals Only)
Source: Indeed
Details: 3.AngularJS, ASP.NET MVC, JQuery, HTML5. 1.Good in C# and Microsoft .Net....  More
8 hours ago

Redmond, WA 22-June-2017

Software Engineer. Net
Source: Indeed
Details: JQuery, SSRS, Design Pattern, ASP.NET MVC, and UML, Microsoft Test Manager. C#, ASP.NET with MVC, SQL Database 2012/2014, and Business Analysis, Report Services...  More
1 day ago

Boca Raton, FL 33487 21-June-2017

.NET Software Engineer
Source: Indeed
Details: 5+ years experience in C#, Asp .Net, MVC. O MVC, MVVM, pub-sub pattern, factory pattern, IOC and client server systems....  More
2 days ago

Atlanta, GA 20-June-2017

.NET Developer
Source: Skills Provision Ltd
Details: O ASP.NET MVC 4+. O Telerik UI for ASP.Net MVC. Are you ready for your next challenge?...  More
30+ days ago

Houston, TX 04-May-2017

.Net Software Engineer
Source: Indeed
Details: Strong experience in developing Web Applications using C#.Net, ADO.NET/Asp.Net MVC, jquery, JavaScript, CSS, WEB APIs, SQL Server....  More
22 days ago

Sunnyvale, CA 31-May-2017

C# / .NET Developer
Source: Veterans Sourcing Group
Details: Web Development with JavaScript and ASP.NET MVC. C# / .NET Developer....  More
1 day ago

Jersey City, NJ 07310 22-June-2017

C# .Net Developer
Source: Indeed
Details: Net 4.5+, C#, SQL Server 2012, ASP.Net MVC, Visual Studio 2015. We are looking for c# full stack developer....  More
2 days ago

Fremont, CA 20-June-2017

Senior .Net Developer
Source: Indeed
Details: MVC:. The candidate also will work on the new custom modules/web sites developed in ASP.NET MVC C# platform. Job description (short):....  More
16 hours ago

Harrisburg, PA 22-June-2017

.NET/C#/JavaScript Web Programmer
Source: Indeed
Details: ASP.NET MVC Framework, especially MVC 4. INET is currently hiring detail oriented programmers to join our web development team....  More
1 day ago

Waukesha, WI 21-June-2017

C#/.Net/MVC Developer
Source: RevolutionInsure
Details: If you are a seasoned full stack .NET MVC developer interested in a startup. Experience developing within a Windows environment using Microsoft’s Visual Studio...  More
9 days ago

Austin, TX 13-June-2017

C# / .Net Developer
Source: Rumba Info Solutions
Details: Two+ (2) years HTML5, ASP.NET MVC, JavaScript, CSS, jQuery, Angular, Telerik, JSON, XML. C# / .Net Developer will guide, design and develop our next generation...  More
16 days ago

Detroit, MI 06-June-2017

C# .Net Developer
Source: Indeed
Details: Object-oriented analysis and design, .NET (C#, ADO.NET, Entity framework, ASP.NET MVC, LINQ, WinForms), SQL Server, XML, HTML, JavaScript, JQuery, CSS, MVC...  More
17 days ago

Malvern, PA 05-June-2017

Software / Support Engineer - Relocate OK
Source: PetDesk
Details: Experience developing web applications built on ASP.NET MVC. We’re PetDesk and we work in the best industry in the world....  More
5 days ago

San Diego, CA 18-June-2017

Mid-Level .Net Developer
Source: Centare
Details: We are currently looking to add a .Net Developer to our consulting team in Madison. This person will be responsible for contributing to local clients'  More
30+ days ago

Madison, WI 10-April-2017

C# .Net Developer
Source: Indeed
Details: Expertise in ASP.NET MVC 4 Framework · Working experience on HTML5 and CSS3 · Good understanding of .Net 4.5 · Experience working with REST and SOAP Web...  More
20 days ago

Washington, DC 02-June-2017

C# .Net Developer
Source: Indeed
Details: Web development using ASP.Net MVC, HTML5, CSS, JavaScript and JQuery. C# .NET DEVELOPER*....  More
21 days ago

Naperville, IL 01-June-2017

Entry or Junior C# .Net Developer
Source: Indeed
Details: Requirements: • BS degree in computer science, software engineering, or closely related field. • 1+ years of experience in software development. •  More
21 days ago

City Industry, CA 01-June-2017

Lead .Net Developer
Source: Indeed
Details: .NET MVC, Entity Framework, SQL, Front end, ASP.Net, C#*. Strong expertise with C#, ASP.Net MVC, Entity Framework, OOPS Concepts, Web API and WCF services....  More
6 hours ago

Orlando, FL 22-June-2017

ASP.Net C# Developer
Source: Career Evolutions
Details: Classic ASP (for conversion of legacy applications). 5+ years of ASP.NET, MVC and C# experience. Career Evolutions is looking for an ASP.Net C# Developer for a...  More
22 days ago

Scottsdale, AZ 85261 31-May-2017

.NET Software Engineer
Source: Indeed
Details: You have strong programming skills with .NET (C#) and related frameworks (ASP.NET, MVC, WebAPI, etc.). Gavant builds custom software to innovate and solve...  More
30+ days ago

Troy, NY 12180 04-May-2017

APPLICATION SYSTEMS PROGRAMMER II
Source: The State of Florida
Details: Visual Studio 2013/2015, TFS 2013, ASP.Net MVC, Single Page Applications, and Web Services. Highway Safety and Motor Vehicle....  More
7 days ago

Tallahassee, FL 32399 15-June-2017

Dot Net Developer
Source: Indeed
Details: ASP.NET MVC, JQuery, Entity framework, HTML programming. Develop enterprise web or desktop applications using *Microsoft .NET, ASP.NET, C#, application...  More
15 days ago

Redmond, WA 07-June-2017

Lead Developer
Source: Indeed
Details: XML, XSL, CSS, HTML, ASP/ASP.NET, MVC, JavaScript, Entity Framework, GIT as well as SQL Server, and other relational databases....  More
7 days ago

Cleveland, OH 15-June-2017
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInDigg thisPin on Pinterest
Category: ASP.NET Web API Tags:

About Web Development

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.