5 simple steps for using Web API with ASP.NET Web Forms Application

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

I have seen this question more than once while going through different ASP.NET forums that “Is it possible to use Web API with ASP.NET Web Forms Application?” Simple answer to the question is “YES, we can“.

Let’s discuss about it in more details. As we already know that Microsoft released ASP.NET MVC 4 with lots of new and exciting features including ASP.NET Web API Tutorial which is basically a framework for building HTTP services that reaches broader range of clients including browsers as well as mobile devices. But it’s flexible enough to be used with ASP.NET Web Forms applications. In this ASP.NET Tutorial, we are using a step by step approach for using Web API with ASP.NET Web Forms. For a good comparison of features released in each version of ASP.NET MVC, click here.

ASP.NET Web Forms and Web API Tutorial

I have already implemented an HTTP service using ASP.NET Web API in one of my previous post that you can refer here. Adding a Model and a Controller is same but the difference is that we are adding it to ASP.NET Web Forms Application. So, let follow the steps as below:

  1. Create a New Web Forms Application.
  2. Add Model to Web Forms Application.
  3. Add Controller to Application.
  4. Add Routing Info to Global.asax.
  5. Making a Client Call.
For the purpose of implementation, I am using Visual Studio Express 2013 for Web here.

1. Create a New Web Forms Application

  • Open Visual Studio and create “New Project” i.e. File -> New Project.
  • Choose “ASP.NET Web Application” template and name project as “WebAPIwithWebForms”.
  • When you click “OK” button, a new window will appear for selecting a sub-template.
    Note: You may not get window for sub-template in older versions of Visual Studio.
  • Choose “Web Forms” and click “OK”.
Using Web API with Web Forms
  • An ASP.NET Web Forms template project is created.

2. Add Model

Now we need to add a new class that acts as a Model in our application as follows:
ASP.NET Web API Model
Web API Model
Following is the code for Student Model

ASP.NET Web API 2 Hands On
Building RESTful Web Service using ASP.NET Web API2 taking from beginner level and learn how to use the new features of Web API2 i.e. Attribute Routing etc. More Details

3. Add Controller class

Controller class has special importance because request coming from client reaches the controller first. Then the controller decides which model to use in order to serve the incoming request.
Right click on the project and choose “Web API Controller” under “Add” from the context menu as shown in figure.
ASP.NET Web API Controller
Web API Controller
Name the controller as “StudentsController” and press “OK” button.
For the purpose of simplicity, I’ll load the model with data inside our “StudentsController” instead of loading directly from database. Following is the code for StudentsController inheriting from ApiController class.

4. Add Routing Info to Global.asax

In order to route incoming request directly to our StudentsController, we need to add Route Information to Application_Start method of Global.asax as given below:

Now, if you run your application and try to access the following URL, you will get a JSON response of student data from api controller. Try to access the following URL and see:

     http://localhost:xxxx/api/Students

Note: Don’t forget to add “using System.Web.Http” in Global.asax.cs file.

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

5. Make a Client Call

As you have already see above your ASP.NET Web API returning data in JSON format. Now, let’s call it from your Web Form using jQuery and display it on your Web Form page.
Create a new Web Form page “WebFormClient” and add the following code to call your ASP.NET Web API Controller i.e. “StudentsController” using jQuery.Main content area will contain the following HTML for rendering Students data.

using jQuery, make a call to our controller and fetch data as follows:
// GET ALL


Hopefully, above step by step approach will be helpful in building Web API with ASP.NET Web Forms Application.

Other Related Web Development Articles:

Top 10 Interview Questions and Answers Series:

Latest Developers Jobs

Top ASP.NET MVC Jobs

Programmer
Source: Indeed
Details: MVC:. ASP.NET MVC, ASP.NET AJAX,C#, C++, SSIS, Object Oriented Programming, T-SQL, JAVA, Telerik Controls, Javascript....  More
3 days ago

Guaynabo, PR 17-August-2017

Programmer
Source: Indeed
Details: Experience in developing web applications using ASP.NET, MVC, Javascript, JQuery. CorTrust Bank is looking for a talented programmer to create secure and...  More
9 days ago

Mitchell, SD 11-August-2017

ASP.NET MVC Web Developer
Source: Cardinal Intellectual Property
Details: ASP.NET MVC Web Developer. Strong or expert knowledge of C#, JQuery, JavaScript, Knockout JS, ASP.NET MVC, MSSQL....  More
2 days ago

Dallas, TX 19-August-2017

Senior Software Engineer, .net, MVC
Source: Indeed
Details: Experience in MVC, preferably ASP.NET MVC 4. Alteso is looking to add a developer to our technology team building cutting edge software for the Auto Re...  More
4 days ago

Trevose, PA 19053 17-August-2017

Full Stack.net Web Application Developer
Source: Indeed
Details: 4+ years of experience building ASP.NET MVC web applications using C# and JavaScript. Thrift Books is looking for a Full Stack Application Developer to help...  More
25 days ago

Seattle, WA 26-July-2017

ASP.NET MVC Web Developer
Source: Cardinal Intellectual Property
Details: ASP.NET MVC Web Developer. Strong or expert knowledge of C#, JQuery, JavaScript, Knockout JS, ASP.NET MVC, MSSQL....  More
5 days ago

Houston, TX 16-August-2017

Full Stack .NET Web Developer
Source: Ursus Incorporated
Details: 3+ Years working with C#, ASP.NET MVC, HTML, CSS, JavaScript. Full Stack .NET Web Developer....  More
9 days ago

Davis, CA 95618 11-August-2017

.NET Web Developer
Source: MIS Choice
Details: Moderate knowledge of ASP.NET MVC, HTML5, JavaScript. .NET Web Developer for Aviation Industry Software Leader....  More
10 days ago

Mount Prospect, IL 60056 11-August-2017

ASP.NET MVC Web Developer
Source: Cardinal Intellectual Property
Details: ASP.NET MVC Web Developer. Strong or expert knowledge of C#, JQuery, JavaScript, Knockout JS, ASP.NET MVC, MSSQL....  More
5 days ago

Evanston, IL 16-August-2017

Web Developer Full Stack C# .Net, MVC, SQL, JavaScript, jQuery, Kendo
Source: Indeed
Details: 5+ years ASP.NET MVC 3/4/5. Translate storyboards and use cases into applications/services....  More
16 days ago

Westlake Village, CA 91362 04-August-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
18 days ago

Irvine, CA 02-August-2017

ASP.NET MVC Web Developer
Source: Professional Technology Integration, Inc.
Details: ASP.NET MVC - 5 Years. ASP.NET MVC (Required 3 Years). C#, ASP.NET MVC, ADO.NET, AJAX, jQuery, JavaScript, XML, CSS and Visual Studio 2013/2015....  More
20 days ago

Harrisburg, PA 31-July-2017

c# asp.net web mvc/webapi software developer
Source: Indeed
Details: C#, ASP.NET MVC, ASP.NET Razor. Firestorm Technologies is looking for an experienced C# asp.net MVC / WebAPI developer....  More
23 days ago

Oak Park, MI 48237 28-July-2017

Programmer
Source: Indeed
Details: ASP.NET MVC, JavaScript, HTML5, CSS3, and Bootstrap. Purpose of Position*....  More
30+ days ago

Plano, TX 75024 27-June-2017

.Net Engineer
Source: Employee Navigator
Details: Our engineers are responsible for building new products that provide a simple user experience for complicated business processes. This includes insurance  More
2 days ago

Gaithersburg, MD 19-August-2017

Web Developer - .NET
Source: Meridian Technology Group
Details: Required technical skills include C#, ASP.NET MVC, HTML, XML, Java Script, Visual Studio, PL/SQL, GIT, SOAP Web Services, Unit Testing with NUnit or MSTest,...  More
30+ days ago

Tualatin, OR 06-July-2017

.Net Web Developer
Source: COMPAS
Details: ASP.NET MVC, C#. Our Web Developers are at the core of what makes us unique....  More
30+ days ago

San Francisco, CA 13-July-2017

.NET Developer- Data Structure
Source: Indeed
Details: Middle tier (ASP.NET MVC / Java). Familiar with MVC, Entity Framework, ASP.NET,. Very strong knowledge in data structures and proven record in using the best...  More
3 days ago

Redmond, WA 17-August-2017

Full Stack .NET Software Engineer
Source: Indeed
Details: Firm understanding of MVC web applications – we use ASP.NET MVC, AngularJS and Bootstrap. National Decision Support Company (NDSC) is currently seeking talented...  More
11 days ago

Madison, WI 09-August-2017

Junior .Net Developer Job
Source: SAIC
Details: A successful candidate will provide ASP.NET MVC, VB.NET, LINQ, AngularJS, Bootstrap, JQuery, CSS, IIS, and SQL Server programming support and work with an...  More
2 days ago

Houston, TX 18-August-2017

.NET Developer
Source: Charles Schwab
Details: 2+ years of ASP.NET MVC experience. Lone Tree - CO, DENR3, 9800 Schwab Way, 80124....  More
2 days ago

Lone Tree, CO 80124 19-August-2017

.Net Developer - Seattle Locals only
Source: Indeed
Details: Middle tier (ASP.NET MVC / Java). Familiar with MVC, Entity Framework, ASP.NET. Very strong knowledge in data structures and proven record in using the best...  More
6 days ago

Redmond, WA 14-August-2017

Full-Stack .NET Developer
Source: Intellisoft Technologies
Details: ASP.NET MVC and WebAPI. Need candidates who can work on our W2....  More
10 days ago

Dallas, TX 11-August-2017

Jr .Net Developer
Source: Indeed
Details: Asp.net MVC Framework 6.0, AJAX, Angular 2, Bootstrap, CSS, 3rd party controls(Mandatory). Good communication and coordination skills working in onshore and...  More
6 days ago

Seattle, WA 14-August-2017

Junior Software Developer
Source: Metro IT Resources
Details: ASP.NET MVC, ASP.NET AJAX,C#, C++, SSIS, Object Oriented Programming, T-SQL, JAVA, Telerik Controls, Javascript....  More
10 days ago

Puerto Rico 11-August-2017
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInDigg thisPin on Pinterest
Category: ASP.NET Web API ASP.NET Web Forms 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.