Learn More





DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.

Calling a Web Service from your DotNetNuke Module

There are times when you’d like to make a call to an external web service from your DotNetNuke module to process or get some data. It’s a pretty straightforward process to do so….

1) add a service reference to your module project

2) this will generate a web.config file in your module folder. Copy the contents of this web.config file and paste it into the web.config file in your web site root folder.

3) in your code-behind, initialize an instance of the service

4) call the method or methods you want to using your service instance

5) process the results

That’s all there is to it. So, with those steps in mind, let’s add a call to a simple public weather web service.

Add a Service Reference to your Module Project

In your module solution, right-click on the “References”, folder and select “Add Service Reference…


The “Add Service Reference” dialog will open, paste the URL of the web service you want to access in the Address field and click the “Go” button.  If the service is available, you will see the publicly available services listed in the “Services” list box on the left.


At the bottom of the dialog box, enter a namespace that you will be using to reference the service. In this example, I enter “WeatherService”.  Later on , I will be using that Namespace and the Service name as shown in the dialog to create a client proxy that I can use to execute the functions exposed by the service. Click the “OK” button to have Visual Studio add the reference to your project.


Now, back at our project, you will see the “WeatherService” listed under the “Service References” folder.


Copy the web.config generated settings to the root web.config of your DNN site

You’ll also notice that a new web.config file has been added to your project. Open the web.config file and you’ll see a bunch of settings that your DNN web site needs in order to be able to access the web service. However, these settings need to be in the web.config that resides in the root folder of your DNN web site. So copy the system.serviceModel section from the web.config in your project folder and paste it at the end of the web.config file in your DNN web site root folder, just after the closing </dotnetnuke>  tag, and before the closing </configuration> tag.

If the web.config in your DNN root folder already has a system.serviceModel section, you’ll have to “merge” the tags from your module into the root config file.

NOTICE: In the <client> section, take a look at the client endpoint configuration data, in particular, the “name” property. You’ll need that name later on, so you might want to copy it to your clipboard for later use.

  <endpoint address=""
    name="WeatherForecastSoap" />

Once you’ve pasted the web.config settings into the root web.config, Delete the web.config file from your project folder.

Write the code-behind to access the web service

That’s all we need to do to be able to access a web service from our module. So, for this example, we’ll use the service to lookup a town name based on a zip code. The service exposes a method

At the top of our module, add a using statement and pull in the namespace of the web service

using DNNws.WeatherService;


In this simple example, I have a div named hw_content on my module’s ascx page. In the Page_Load() method, we’ll make a call to the web service, pass in a zip code, and grab the City name (PlaceName) from the results of the service call.

  1: private void Page_Load(object sender, System.EventArgs e)
  2: {
  3:     try
  4:     {
  5:         using (var svc = new WeatherForecastSoapClient("WeatherForecastSoap"))
  6:         {
  7:             var results = svc.GetWeatherByZipCode("07871");
  8:             hw_content.InnerHtml = string.Format("Hello {0}", results.PlaceName);
  9:         }
 10:     }
 11:     catch (Exception exc) //Module failed to load
 12:     {
 13:         Exceptions.ProcessModuleLoadException(this, exc);
 14:     }
 15: }


On line 5, we create a proxy object that we’ll be using to access the service.

When Visual Studio added the service reference to our project, it also created a proxy class named “WeatherForecastSoapClient” that we will use. We need to pass the endpoint “name” that we want to use to access the service, so pass the value of the “name” property from the web.config client tag you copied earlier.

Once we have a service proxy object (svc), we simply call the method “GetWeatherByZipCode” and pass the required zip code parameter.  NOTE: Intellisense makes method discovery very easy, just start typing svc, period and you’ll see a list of the available methods and their signatures.

The call is made on line 7, and on line 8, we take the “PlaceName” property of the result and we create a string and set it inside our div on our ascx file.

Running our DNN site and placing an instance of our module on a page, results in the view being displayed, during Page_Load(), an instance of the web service proxy is created and we use that proxy to connect to the web service, execute the GetWeatherByZipCode method, pass in a zip code and the PlaceName property is used to construct a welcome message, which looks like this…



So, this was a very simple example, but a more complex example starts with the same steps …

1) add a service reference to your module project

2) this will generate a web.config file in your module folder. Copy the contents of this web.config file and paste it into the web.config file in your web site root folder.

3) in your code-behind, initialize an instance of the service

4) call the method or methods you want to using your service instance

5) process the results

Hopefully, this will help you make service calls to external web services from within your DNN modules.


Yousra Reda
thanks for this useful article :)

And I want to know if there is an option to include the service configuration endpoint automatically when installing module instead of manual editing in the main web config?
Yousra Reda Thursday, January 15, 2015 2:53 AM (link)

Comment Form

Only registered users may post comments.


2sic Daniel Mettler (124)
Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (21)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (203)
Chris Paterra (55)
Clinton Patterson (28)
Cuong Dang (21)
Daniel Bartholomew (2)
Dave Buckner (2)
David Poindexter (3)
David Rodriguez (2)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (269)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (52)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (37)
Will Strohl (163)
William Severance (5)
Try Evoq
For Free
Start Free Trial
a Demo
See Evoq Live
Need More Information?