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

.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
15 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
23 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

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

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
13 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

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 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.