Create C# Restful Service and Consume in C# Restful Client, ASP.net Client

Question

3.67/5 (3 votes)

See more:

Hi Dear:
I have Created a Restful Service in C#, and Now i want to use my this Service in C# Restful Client. Client may be a Console Client, but Asp.net Client is preferred.
I have tried a lot more Tutorials, but no Success till now,
Please suggest me some Working Sample,

My Project code is as follow:
Here is the code of Web.Config File in Servie Project:

XML

<?xml version="1.0"?>
<configuration>

  <appSettings>
    <add key="aspnet:UseTaskFriendlySynchronizationContext" value="true" />
  </appSettings>
  <system.web>
    <compilation debug="true" targetFramework="4.5" />
    <httpRuntime targetFramework="4.5"/>
  </system.web>
  <system.serviceModel>

    <services>
      <service name="Restful.Restful" behaviorConfiguration="ServiceBehaviour">
        <endpoint address="" binding="webHttpBinding" contract="Restful.IRestful" behaviorConfiguration="web">

        </endpoint>
      </service>
    </services>

    <behaviors>
      <serviceBehaviors>
        <behavior name="ServiceBehaviour">
          <!-- To avoid disclosing metadata information, set the values below to false before deployment -->
          <serviceMetadata httpGetEnabled="true" httpsGetEnabled="true"/>
          <!-- To receive exception details in faults for debugging purposes, set the value below to true.  Set to false before deployment to avoid disclosing exception information -->
          <serviceDebug includeExceptionDetailInFaults="false"/>
        </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name ="web">
          <webHttp/>
        </behavior>
      </endpointBehaviors>
    </behaviors>
    <protocolMapping>
        <add binding="basicHttpsBinding" scheme="https" />
    </protocolMapping>
    <serviceHostingEnvironment aspNetCompatibilityEnabled="true" multipleSiteBindingsEnabled="true" />
  </system.serviceModel>
  <system.webServer>
    <modules runAllManagedModulesForAllRequests="true"/>
    <!--
        To browse web app root directory during debugging, set the value below to true.
        Set to false before deployment to avoid disclosing web app folder information.
      -->
    <directoryBrowse enabled="true"/>
  </system.webServer>

</configuration>

My IRestful.cs Code

My Project(Restful Service) Name is Restful,

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.Text;

namespace Restful
{
    [ServiceContract]
    public interface IRestful
    {
        [OperationContract]
        [WebInvoke(Method = "GET", ResponseFormat = WebMessageFormat.Xml, BodyStyle = WebMessageBodyStyle.Wrapped, UriTemplate = "name/id={id}")]
        string test(string id);

        [OperationContract]
        [WebInvoke(Method = "GET", ResponseFormat = WebMessageFormat.Xml, BodyStyle = WebMessageBodyStyle.Wrapped, UriTemplate = "xml/?id={id}")]
        string xdata(string id);

        [OperationContract]
        [WebInvoke(Method = "GET", ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, UriTemplate = "json/?id={id}")]
        string jdata(string id);

        [OperationContract]
        [WebInvoke(Method = "GET", ResponseFormat = WebMessageFormat.Xml, BodyStyle = WebMessageBodyStyle.Wrapped, UriTemplate = "sum/?a={a}&b={b}")]
        string sum(int a, int b);
    }
}

My Restful.svc.cs Code:

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.Text;

namespace Restful
{
    public class Restful : IRestful
    {
        #region IRestService Members

        public string test(string id)
        {
            return "Testing Phase is Continued. :" + id;
        }
        public string xdata(string id)
        {
            return "Your Requested XML Product is :" + id;
        }

        public string jdata(string id)
        {
            return "Your Requested XML Product is :" + id;
        }

        public string sum(int a, int b)
        {
            return "Sum of Numbers is: " + (a + b);
        }

        #endregion
    }
}

I have Tried to Consume Service using ASP.net, My ASP.net project name is WebClient
Here is the code of WebForm.aspx.cs File:

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Net;
using System.Net.Http;

namespace WebClient
{
    public partial class WebForm : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {

        }
        protected void Button1_Click(object sender, EventArgs e)
        {
            HttpClient client = new HttpClient();
            HttpResponseMessage msg = client.GetAsync("http://localhost:27629/Restful.svc/sum/?a=23&b=90").ContinueWith<httpresponsemessage>;
            HttpContent strm = msg.Content();
            var data = strm.ReadAsStreamAsync();
            Label1.Text = Convert.ToString(data.Result);
        }
    }
}

Here is the code of WebForm.aspx file:

XML

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm.aspx.cs" Inherits="WebClient.WebForm" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
        <asp:Button ID="Button1" runat="server" OnClick="Button1_Click" Text="Button" />
        <br />
        <br />
        <asp:Label ID="Label1" runat="server" Text=""></asp:Label>
    <div>

    </div>
    </form>
</body>
</html>

Please refer me tos solution, that may lead to get rid of this problem....
Thanks In Advance...

Posted 11-Sep-13 3:34am

Member 8775683

Updated 11-Sep-13 8:04am

H.Brydon

v2

Add a Solution

Comments

Eytukan 12-Sep-13 5:41am

Why is this under C++ questions? :suss:

2 solutions

Solution 2

Dear Member 8775683 i understand you, i also learnt this some days ago. If i did the coding to you means you dont get learnt on yourself.
So i just gave you clear idea soon i will write an article so that help you.

This is my service,

C#

[OperationContract]
[WebInvoke(Method = "POST", ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.WrappedRequest, UriTemplate="CheckLogin/{userName}/{password}")]
string CheckLogin(string userName,string password);

I checked the data and returns a string value only in json format.

C#

public string CheckLogin(string userName, string password)
        {
            try
            {
                ds = null;
                data = "";
                integerValue = dbServices.CheckLogin(userName, password);
                if (integerValue >= 1)
                {
                    Status= "SUCCESS";
                }
                else
                    Status= "FAILED";
            }
            catch (Exception ex)
            {
            }
            return Status;
        }

and i consume it at the client side as following,

HttpWebRequest webrequest = (HttpWebRequest)WebRequest.Create(url + "CheckLogin" + "/" + txtUserName.Text.Trim().ToString() + "/" + txtPassword.Text.Trim().ToString());
                   webrequest.Method = "POST";
                   webrequest.ContentType = "application/json";
                   webrequest.ContentLength = 0;
                   Stream stream = webrequest.GetRequestStream();
                   stream.Close();
                   string result;
                   using (WebResponse response = webrequest.GetResponse())
                   {
                       using (StreamReader reader = new StreamReader(response.GetResponseStream()))
                       {
                           result = reader.ReadToEnd();
                       }
                   }
                   result = result.Substring(1, result.Length - 2);

i just hand code the string result value to get my need.
you may JSON serialize and deserialize methods to get the data as you need.

You may get that JSON methods from the following link.
http://james.newtonking.com/projects/json-net.aspx[^]

It may help you

and to answer the error you got faced is occured during the consumption
look these following links you may get some ideas
how-to-consume-or-use-wcf-service[^]
how-to-consume-wcf-service-in[^]
http://technetsharp.wordpress.com/2012/04/18/use-wcf-service-in-web-application-for-beginners/[^]

Posted 11-Sep-13 22:33pm

Manikandan Sekar

Comments

rishi_hamza 21-Nov-15 9:04am

thanks Man, Your code help me to find my solution after 1.5 days :-) Best Regards

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

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

Manikandan Sekar · Accepted Answer · 2013-09-11T05:51:00

There are two ways to get the data from service one is XML and other one is JSON.
you chose xml the data you received is in the format of XML schema you only have to convert it into required format.
I just give you an example,

HttpWebRequest webrequest = (HttpWebRequest)WebRequest.Create("your url with args");
webrequest.Method = "POST";
webrequest.ContentType = "application/json";
webrequest.ContentLength = 0;
Stream stream = webrequest.GetRequestStream();
stream.Close();
string result;
using (WebResponse response = webrequest.GetResponse())
{
using (StreamReader reader = new StreamReader(response.GetResponseStream()))
{
result = reader.ReadToEnd();
}
}

The result variable contains xml schema as string
So, now convert into as per your need.

For that you need to send the data into your required need like string, list or dataset
from the service.
The difficult one is retreiving the dataset from the service which contains a list of records with number of columns.
I just give you the core snippet

DataSet ds = new DataSet();
ds.Tables.Clear();
XmlElement exelement;
XmlDocument doc = new XmlDocument();
doc.LoadXml(result);//Load the XML schema string into a XML document
exelement = doc.DocumentElement;//Get the XML element from the document
if (exelement != null)
{
XmlNodeReader nodereader = new XmlNodeReader(exelement);/read the nodes in the XML element
ds.ReadXml(nodereader, XmlReadMode.Auto);//Read the XML nodes and load it in the dataset
}

Hope it helps...!