welcome to XRM blog

Keep in touch with latest CRM/ERP articles

To remain competitive your organisation must be efficient across the business process spectrum. To do so you need to take sound decisions based on a balance between the cost and risk. To do so you will be heavily dependent on your content management in itself needs...

image
Blog

How Can we use Web API In DotNetNuke?

By Rajesh on 1/18/2014

What Is Web API: Web API is an open source and ideal platform for building REST-ful services over the .NET Framework. This is the new framework for building HTTP services with easy and simple way. It uses the full features of HTTP (like URIs, request/response headers, caching, versioning, various content formats) It can be hosted with in the application or on IIS.

When to use Web API:  when you want to expose your service to a broad range of clients including browsers, mobiles, iphone and tablets or you want to use MediaType Formatter into JSON, XML or whatever format you want to add as a MediaTypeFormatter. It is light weight architecture and good for devices which have limited bandwidth like smart phones.

 

How Implement Web API in DNN

 

We need to include few reference of DLL

  •  Dotnetnuke.dll
  •  Dotnetnuke.web.dll
  •  System.net.Http.dll
  •  System.net.http.formatting.dll
  •  System.web.http.dll
  •  System.web.dll

These dlls are  present inside the bin folder in DNN Site.

Now Lets start with some coding

First of all we create a class named TestingWebApiController.cs  Let’s see the code that display Email name of current user

  

 

 

One more important thing you should keep in mind the permissions

  • [AllowAnonymous] : its sets permission that any user can access this method.
  • [DnnAuthorize = " "] : type of dnn  user is allowed to access the API

Note: whilst GET and POST are the two most commonly used verbs there are others, particularly if you are looking to use a RESTful approach. Typically a REST based service implementation will use the following verbs:

GET– Used when a browser is requesting data from the server

PUT– Typically used when updating an item

POST – Typically used when creating a new item

      DELETE – Used when deleting an item

 

Now we create Another Class “RouteMapper.cs ” with following code

 

 

 

After That Build the dll  of Main Class and post the bin folder in dnn site

Now we can use  following path of url

Error! Hyperlink reference not valid.

 

Get Display data in Json Format

 

{"UserId":"host@change.me","Name":"SuperUser"} 

 

 

KeyWord:Webapi asp.net,Dnn Web api,C# Web API.

 

Conclusion: if you want to make your service to a broad range of clients including browsers, mobiles, iphone and tablets,best option is web API.


 

DotNetNuke
API In DotNetNuke
Author
Blog Calendar
Blog Calendar List
2018 Nov  26  3
2018 Oct  7  3
2018 Sep  13  11
2018 Aug  2  2
2018 Jun  11  1
2018 Jan  41  2
2017 Sep  348  5
2017 Aug  14  1
2017 Jul  15  2
2017 Jun  36  2
2017 May  17  1
2017 Apr  31  2
2017 Mar  104  4
2017 Feb  269  4
2016 Dec  171  3
2016 Nov  267  8
2016 Oct  197  10
2016 Sep  341  6
2016 Aug  38  1
2016 Jun  1580  6
2016 May  102  3
2016 Jan  68  2
2015 Dec  373  6
2015 Nov  3  1
2015 Oct  11  1
2015 Sep  1105  6
2015 Aug  10  1
2015 Jul  101  2
2015 Jun  7  1
2015 May  20  1
2015 Apr  21  2
2015 Mar  67  3
2015 Jan  4998  4
2014 Dec  14  1
2014 Nov  2159  4
2014 Oct  74  2
2014 Sep  95  2
2014 Aug  2848  1
2014 Jul  40  2
2014 Apr  2401  12
2014 Mar  268  19
2014 Feb  216  8
2014 Jan  1490  16
2013 Dec  21  2
2013 Nov  607  2
2013 Oct  239  3
2013 Sep  10  1
2013 Aug  29  3
2013 Jul  202  1
2013 Apr  43  6
2013 Mar  1634  10
2013 Feb  272  4
2013 Jan  244  2
2012 Nov  24  2
2012 Oct  394  10
Tag Cloud
Interested in our services? Still not sure about project details? get a quote