Click here to Skip to main content
Click here to Skip to main content

CREATE RESTful WCF Service API Using POST: Step By Step Guide

, 25 May 2011 CPOL
Rate this:
Please Sign up or sign in to vote.
This article will help you to create RESTful WCF POST API. I have given Client and Server example which is really easy to understand.

Introduction

In my previous article, I tried to explain about WCF Restful service using HTTP Get method. This works well as long as you are sending small data as information to the service. But if want to deliver huge data, HTTP GET Method is not a good choice. In this article, we will create one WCF RESTFul POST API. I will also try to explain why and where to use POST method.

Why to use POST, not GET?

When I write any WCF service, I always use POST. The reason is the advantage of POST over GET. Using HTTP POST method, you can almost achieve everything which you can achieve from GET. Despite this, you will get some additional feature if using POST. We might say that "GET" is basically for just getting (retrieving) data whereas "POST" may involve anything, like storing or updating data, or ordering a product, or sending E-mail, etc.

POST

  1. Easy Character Encoding using application/x-www-form-urlencoded
  2. No Proxy by default so always actual data from web server
  3. Data length can be restricted by webserver, not by browser

GET

  1. Character encoding will reduce the amount of data that can be used because of URL encoding entities (i.e. three Japanese characters are converted to this: %26%2312454%3B%26%2312455%3B%26%2312502%3B)
  2. Running an HTTP request with GET can be cached on your web browser or a configured proxy server
  3. Maximum URL length is 2,083 characters in Internet Explorer (see MaxClientRequestBuffer: Use POST instead of GET to send large amounts of data in request)

and lot more...

Extremely long URLs are usually a mistake. URLs over 2,000 characters will not work in the most popular web browser. Sending long information via URL is not a good way of implementation and also it has many restrictions, i.e., max length of URL, information format, bla bla bla. For example, Internet Explorer has a limitation implemented at 2083 characters. URI is meant to be readable not to send information.

So if you are writing any REST service and your information is long enough, better to choose POST instead of GET method.

In this article, I am going to create WCF Restful service using POST method and access it using HTTP Request. So we will have client and server both in this example code. I am creating one service which accepts HTTP Post XML request and response request data in XML format.

Step by Step Guide

STEP 1

Launch Visual Studio 2010. Click FILE->NEW->PROJECT. Create new "WCF Service Application".

STEP 2

Once you create the project, you can see in solution that by default WCF service and interface file are already created. Delete by default created file as we will create our own interface and WCF service file.

Step-2

STEP 3

Now right click on solution and create one new WCF service file. I have given name to the service file as “RestServiceImpl.svc”.

STEP 4

We will create two DataContract classes for request and response purposes.

Step-4

RequestData will receive the request from the client and ResponseData response. One very important thing is that POST XML format to the service should be the same as RequestData. So the post XML request format can be like below:

Step-4

We must have to use namespace for the data contract in POST RESTFul service, which has multiple uses, i.e., reflects the current version of your code. The same namespace should use in XML to Post data. Here, I have given http://www.eysnap.com/mPlayer as namespace which can be changed.

STEP 5

Now we will write the OperationContract in IRestServiceImpl which is an interface. Below is the code for that.

As we can see in the above code, here Request and Response format is XML. We can change it to JSON also by changing the WebMessageFormat from WebMessageFormat.Xml to WebMessageFormat.Json.

STEP 6

Implementation of Auth OperationContract in RestServiceImpl.svc.cs here.

STEP-6

STEP 7

Now let’s move to the configuration part which is the last one. There will be two basic parts of the configurations file which we must have to understand.

Services

Behaviors

And that’s it. Our Restful WCF POST RESTful service is ready to test.

SERVICE IS READY

I have created one Test WebClient in C# which makes HTTP request with some XML data. My application is hosted on localhost and URL is http://localhost:35798/RestServiceImpl.svc/auth. I launched and invoked service using WebClient. Below is my XML response which is the correct one.

This service can be used by any language application (.NET, PHP, JAVA, etc.) and that is the major reason to use REST service in the application.

Hope the article is useful for the community. Comments, suggestions and criticisms are all welcome.
Thanks.

History

  • 25th May, 2011: Initial post

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

ashutosh k. shukla
Software Developer (Senior) http://mr-ashu.blogspot.com/
Singapore Singapore
A versatile person having 6.0 Years of IT Industry experience in software development on .NET Technology presently leading the team successfully.
Follow on   Twitter

Comments and Discussions

 
Questioncrd operations PinmemberMember 91711281-Jul-14 10:25 
QuestionSoapAction in RESTful WCF service API using POST Pinmemberriya__yari9-May-14 22:25 
GeneralCREATE RESTful WCF Service API Using Post... Wonderful guide! PinmemberLisaSnyder12-Mar-14 5:41 
Question[My vote of 1] : Not very good Pinmembermsdevtech6-Sep-13 17:05 
QuestionUnable to POST - Method Now Allowed PinmemberMember 1006724928-May-13 22:07 
GeneralMy vote of 4 Pinmemberrajeshpmarathe22-Feb-13 1:16 
Questionhow to call XMl file contain different tags PinmemberMember 98123935-Feb-13 20:41 
GeneralMy vote of 5 Pinmembereds.net28-Jan-13 6:46 
GeneralMy vote of 5 PinmemberSuperDuperPengu14-Jan-13 17:20 
GeneralMy vote of 1 PinmemberMember 813298511-Jul-12 21:48 
GeneralHow to call xml directly [modified] PinmemberAlpesh Dhanesha7-Jul-12 22:34 
GeneralRe: How to call xml directly PinmemberMember 98123935-Feb-13 20:54 
Questionnot working Pinmembermahesh152919-Apr-12 6:46 
AnswerRe: not working Pinmemberashutosh k. shukla19-Apr-12 6:59 
QuestionAshutosh need your help soon PinmemberMember 884729719-Apr-12 6:35 
AnswerRe: Ashutosh need your help soon Pinmemberashutosh k. shukla19-Apr-12 7:01 
GeneralRe: Ashutosh need your help soon PinmemberMember 884729719-Apr-12 7:17 
GeneralRe: Ashutosh need your help soon PinmemberMember 884729719-Apr-12 7:20 
QuestionAgain I need your Help Please (its urgent for me) PinmemberMaheshRastogi00513-Feb-12 4:40 
Questionparameter in url with out question mark PinmemberMaheshRastogi00512-Feb-12 3:57 
QuestionIs there a way to test a post directly from the URL of a browser? PinmemberlittleGreenDude3-Feb-12 10:58 
AnswerRe: Is there a way to test a post directly from the URL of a browser? Pinmemberashutosh k. shukla3-Feb-12 18:39 
SuggestionRe: Is there a way to test a post directly from the URL of a browser? Pinmemberps3645210-Feb-12 1:15 
GeneralRe: Is there a way to test a post directly from the URL of a browser? Pinmemberashutosh k. shukla10-Feb-12 1:17 
Questionplease help me its urgent [modified] PinmemberMaheshRastogi0051-Feb-12 5:21 
AnswerRe: please help me its urgent Pinmemberashutosh k. shukla1-Feb-12 5:24 
GeneralRe: please help me its urgent PinmemberMaheshRastogi0051-Feb-12 5:28 
GeneralRe: please help me its urgent Pinmemberashutosh k. shukla1-Feb-12 5:28 
QuestionCan I consume REST WCF via iPhone web app. Pinmemberkartikps_19795-Dec-11 11:54 
AnswerRe: Can I consume REST WCF via iPhone web app. Pinmemberashutosh k. shukla5-Dec-11 17:17 
QuestionGreat example PinmemberNaresh Mittal16-Nov-11 18:14 
AnswerRe: Great example Pinmemberashutosh k. shukla17-Nov-11 8:59 
Questioncan RequestData have more than one data contract? PinmemberSelveia15-Nov-11 5:27 
AnswerRe: can RequestData have more than one data contract? PinmemberNaresh Mittal16-Nov-11 18:18 
QuestionThe remote server returned an error: (405) Method Not Allowed. Pinmemberprof.seva13-Nov-11 10:53 
AnswerRe: The remote server returned an error: (405) Method Not Allowed. Pinmemberashutosh k. shukla13-Nov-11 16:50 
GeneralRe: The remote server returned an error: (405) Method Not Allowed. PinmemberSelveia14-Nov-11 0:19 
QuestionThanks and keep it up PinmemberRupeshKumar20-Oct-11 6:38 
QuestionCreate a POST to a REST WCF Service with Fiddler [modified] PinmemberMember 831979718-Oct-11 9:54 
QuestionPassing Derived Class in RESTFul WCF Service PinmemberAlexander B. Deyto12-Sep-11 20:01 
AnswerRe: Passing Derived Class in RESTFul WCF Service Pinmemberashutosh k. shukla12-Sep-11 22:11 
GeneralRe: Passing Derived Class in RESTFul WCF Service PinmemberAlexander B. Deyto13-Sep-11 20:46 
QuestionExcellent PinmemberSunasara Imdadhusen31-Aug-11 20:03 
AnswerRe: Excellent Pinmemberashutosh k. shukla31-Aug-11 20:57 
QuestionThanks Pinmemberhariharan.m8521-Aug-11 21:14 
AnswerRe: Thanks Pinmemberashutosh k. shukla21-Aug-11 21:16 
QuestionThanks PinmemberGaraus10-Aug-11 12:37 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.141223.1 | Last Updated 25 May 2011
Article Copyright 2011 by ashutosh k. shukla
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid