I'm writing a web service as code below:
[OperationContract]
[WebInvoke(Method = "GET",
ResponseFormat = WebMessageFormat.Json,
RequestFormat = WebMessageFormat.Json,
// BodyStyle = WebMessageBodyStyle.Wrapped,
UriTemplate = "/BudgetBalance/{userlogin}/{prnumber=null}")]
Budget BudgetBalance(string userlogin, string prnumber);
As you can see at the code above, the second parameter can be filled or keeped null. By doing this, I can access the service by two different urls.
http://localhost:44880/Service1.svc/BudgetBalance/nurul.widiyanti
http://localhost:44880/Service1.svc/BudgetBalance/nurul.widiyanti/PRM-000114
If the second parameter is filled with some data, the service will return a different value. The problem is when I want to consume this webservice. Here's the code I've tried to call this service.
WebClient proxy = new WebClient();
string serviceUrl = string.Format("http://localhost:1089/Service1.svc/BudgetBalance/Nurul.Widiyanti/PRM-000114");
byte[] data = proxy.DownloadData(serviceUrl);
Stream _mem = new MemoryStream(data);
var reader = new StreamReader(_mem);
var result = reader.ReadToEnd();
var model = JsonConvert.DeserializeObject<Budget>(result);
This doesn't work and make an error. I realize that this code will work if I change the UriTemplate within OperationContract to something like this:
UriTemplate = "/BudgetBalance/{userlogin}/{prnumber}"
But if I do this, it doesn't suit my requirement. I need to create a webservice which allow one of the parameters remains empty (null). Is this possible accomplish this requirement? If so, please guide me to find the answer.
I think you want something like this ...
...
UriTemplate = "/BudgetBalance/{userlogin}")]
UriTemplate = "/BudgetBalance/{userlogin}/{prnumber}")]
Budget BudgetBalance(string userlogin, string prnumber = null) { .. }
Related
I Create a simple WCF service and he works fine.
The configuration are below
The interface have this configuration
[OperationContract]
[WebInvoke(Method = "GET",
ResponseFormat = WebMessageFormat.Json,
BodyStyle = WebMessageBodyStyle.Bare,
UriTemplate = "checkSymbolExistJson/{pSymbol}")]
string checkSymbolExistJson(string pSymbol);
The implementation is this
public string checkSymbolExistJson(string pSymbol)
{
Person p = new Person();
p.name = pSymbol;
p.age = 15;
string json = JsonConvert.SerializeObject(p);
return json;
}
if I enter URL in browser "http://localhost/MetaTraderWcf/rzManageQuotes.svc/checkSymbolExistJson/testename" in brower I Get this result in Browser
"{\"name\":\"testename\",\"age\":15}"
After I make a win 32 application to get http result of this WCF service.
I use this code to read a HTML page
public string readUrl(string pUrl)
{
WebClient client = new WebClient { Encoding = System.Text.Encoding.UTF8 };
return client.DownloadString(pUrl);
}
I use this code to read a JSON dinamic TAG
private void button2_Click(object sender, EventArgs e)
{
string tmpToken = readUrl(url.Text);
// string tmpToken = "{\"name\":\"testename\",\"age\":15}";
JToken token = JObject.Parse(tmpToken);
string page = (string)token.SelectToken("name");
jSONResult.Text = page;
}
if I Runing code above with fixed code below
string tmpToken = "{\"name\":\"testename\",\"age\":15}";
The result is correct and I get result as "testename".
But when I Debug the read a Html page I receive tha value of tmpToken with this string
"\"{\\"name\\":\\"testename\\",\\"age\\":15}\""
And I get a error when I read dinamic value of name
An unhandled exception of type 'Newtonsoft.Json.JsonReaderException' occurred in Newtonsoft.Json.dll
Additional information: Error reading JObject from JsonReader. Current
JsonReader item is not an object: String. Path '', line 1, position
37.
If I change interface to return a XML page like this code
[OperationContract]
[WebInvoke(Method = "GET",
ResponseFormat = WebMessageFormat.Xml,
BodyStyle = WebMessageBodyStyle.Bare,
UriTemplate = "checkSymbolExistJson/{pSymbol}")]
string checkSymbolExistJson(string pSymbol);
I get the follow result in browser
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">{"name":"testename","age":15}</string>
And I get Read JSON value of name correct after remove tag from XML result.
The Question is
There is some way of read a string in pure JSON format in c# like a read in a Browser format
like this
{"name":"testename","age":15}
and not like this format
"\"{\\"name\\":\\"testename\\",\\"age\\":15}\""
there is a simple solution for that. just return stream except string.
public stream checkSymbolExistJson(string pSymbol)
{
Person p = new Person();
p.name = pSymbol;
p.age = 15;
string json = JsonConvert.SerializeObject(p);
return new MemoryStream(Encoding.UTF8.GetBytes(json));
}
or i suggest use web API instead WCF.
Hopefully a simple question, but I have a simple app that is self-hosted (which works fine), and I can hit the requested method using a POST without parameters from the body (which hits the method but defaults the parameter to null), but when I try to pass the named parameter in the BODY of the POST request in raw JSON format, it receives a 400 response, and never hits the method for some reason...
Any advice is appreciated.
[Environment: Visual Studio 2015, C#, self hosted REST application]
[Code Details]
(Web service hosting code for Self Hosted app)
WebServiceHost host = new WebServiceHost(typeof(CalculatorServiceREST), new Uri("http://localhost:8000"));
ServiceEndpoint ep = host.AddServiceEndpoint(typeof(ICalculator), new WebHttpBinding(), "");
ServiceDebugBehavior stp = host.Description.Behaviors.Find<ServiceDebugBehavior>();
stp.HttpHelpPageEnabled = false;
host.Open();
Console.WriteLine("Service is up and running");
Console.WriteLine("Press enter to quit ");
Console.ReadLine();
host.Close();
(The contracts implementation class: CalculatorServiceRest.cs)
public class CalculatorServiceREST : ICalculator
{
[WebInvoke(Method = "POST")] // POST to: /RoundUp (with BODY item of 'number' in the request)
public int RoundUp(double number)
{
return Convert.ToInt32(Math.Round(number));
}
[HttpPost] // POST to: /GetName (with BODY item of 'number' in the request)
public string GetName(string name)
{
return name;
}
}
It appears that I have to add the following attribute values to the POST method so that I can pass JSON data in the BODY for it to pick it up (which is different from how I am use to being able to just put [HttpPost] attribute for MVC and it just knows how to pick it up. Can anyone provide some insight on why it is different?
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.WrappedRequest, ResponseFormat = WebMessageFormat.Json, RequestFormat = WebMessageFormat.Json)]
I use WCF (by means of using the WebChannelFactory) to invoke some services that are outside of my control, implemented in a variety of technologies. From the WCF perspective, my interface only has one method, let's call it "get-stuff". So, the same method can be implemented by these services as http://www.service-a.com/get-stuff, or as http://www.service-b.com/my-goodies/, or as http://www.service-c.com/retrieve-thing.php
In all examples I've seen the method binding to a particular URI is accomplished via the UriTemplate member of the WebGet/WebInvoke attribute. But this means, all the URIs for the "get-stuff" method must follow a fixed template. For, example, I can create a UriTemplate = "/get-stuff", so that my method will always be bound to /get-stuff.
However, I want my method to bind to any arbitrary URI. BTW, the parameters are passed as a POST data, so I do not need to worry about binding URI to parameters of the method.
why don't you do something like this
EndpointAddress endpointAddress = new EndpointAddress("any service url");
ChannelFactory<IMyService> channelFactory = new ChannelFactory<IMyService>(binding, endpointAddress);
IMyServiceclient = channelFactory.CreateChannel();
client.GetStuff();
OK, I have found a solution to the problem, by patching the UriTemplate of the WebInvokeAttribute at run-time. My single-method WCF interface is:
[ServiceContract]
interface IGetStuff
{
[OperationContract]
[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
ResponseData GetStuff(RequestData request);
}
Here is how I get the handle to the interface:
//Find the last portion of the URI path
var afterLastPathSepPos = uri.LastIndexOf('/', uri.Length - 2) + 1;
var contractDesc = ContractDescription.GetContract(typeof(IGetStuff));
foreach (var b in contractDesc.Operations[0].Behaviors)
{
var webInvokeAttr = b as WebInvokeAttribute;
if (webInvokeAttr != null)
{
//Patch the URI template to use the last portion of the path
webInvokeAttr.UriTemplate = uri.Substring(afterLastPathSepPos, uri.Length - afterLastPathSepPos);
break;
}
}
var endPoint = new ServiceEndpoint(contractDesc, new WebHttpBinding(), new EndpointAddress(uri.Substring(0, afterLastPathSepPos)));
using (var wcf = new WebChannelFactory<I>(endPoint))
{
var intf = wcf.CreateChannel();
var result = intf.GetStuff(new RequestData(/*Fill the request data here*/)); //Voila!
}
I have below OperationContract in my WCF web service.
[OperationContract]
[WebGet(UriTemplate = "/publisheddata/{number}/{*publication}")]
Message GetPublished(String number, String publication);
[OperationContract]
[WebGet(UriTemplate = "/unpublisheddata/{number}/{*publication}")]
Message GetUnPublished(String number, String publication);
I want to call one common method for above both OperationContract, means in the Service implementation code I will call the Stored Procedure on the basis UriTemplate called, I know i can easily do by adding extra attribute in above url, I don't want to ask user to put it from the url.
Here I want to write condition on the basis of UriTemplate called, so my above code become as below:
[OperationContract]
[WebGet(UriTemplate = "/publisheddata/{number}/{*publication}")]
Message GetData(String number, String publication);
[OperationContract]
[WebGet(UriTemplate = "/unpublisheddata/{number}/{*publication}")]
Message GetData(String number, String publication);
In my Service implementation, I want to check if unpublisheddata then GetUnPublished else if publisheddata then GetPublisheddata
Is it possible or suggest better ways to implement it?
firstly, -probably- you'll get exception because of your method names. you can't use same method names like yours, but you can use OperationContract property "Name"
[OperationContract(Name="GetPublished")]
Message GetData(String number, String publication);
[OperationContract(Name="GetUnPublished")]
Message GetData(String number, String publication);
if you prefer single method, you can modify your method like this
[OperationContract]
[WebGet(UriTemplate = "/{publicationType}/{number}/{*publication}")]
Message GetData(string publicationType, string number, string publication);
and in your method you check "publicationType" parameter and do your logic
if I understand truly, you want provide access only single method. I'm using a structure like this in my project
[WebInvoke(Method="POST", UriTemplate ="/customers", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json), Description("Save a customer information")]
OperationResult CustomerSave(Request<Customer> customerRequest);
and also I have 2 different methods -not show in WCF interface / contract- that names "Create" and "Update"
in my wcf method (CustomerSave), I'm doing process like this
if(customerRequest.Id != Guid.Empty)
{
Update(customerRequest);
}
else
{
Create(customerRequest);
}
and my users can not see Create / Update methods
I'm building a plugin to a windows service I've made (it's C#, uses plugins to do certain functionality). This new plugin will be using Web Services to make calls to a web-service and get some information.
Unfortunately, the web-service URL is different for my DEV, QC, and PRODUCTION environments. I'd like to make that end-point URL be configurable (the plugin will look into the database and get the URL).
How, exactly, do I set up a web-service caller in my code so that it can use a dynamic endpoint?
I can add a service and point to the existing one in DEV - and that builds up my proxy class - but how can I make it so it's not "hard locked" with the URL - so the plugin works in any environment (based on the URL in the database it pulls out)? I'd like to be able to change that on the fly in the code, so to speak.
Basically you can call this to create your WCF Service client:
MyClient = new MyWCFClient(new BasicHttpBinding("CustomBinding"), new EndpointAddress(GetEndpointFromDatabase()));
Where GetEndpointFromDatabase() returns a string - the endpoint.
I made an end to end sample which runs in LINQPad. This is for a completely self-hosted scenario, and enables exploring various bindings, etc (for both the client and the server). Hope it's not over the top and posted the entire sample in case you find any of the other aspects helpful later on.
void Main()
{
MainService();
}
// Client
void MainClient()
{
ChannelFactory cf = new ChannelFactory(new WebHttpBinding(), "http://localhost:8000");
cf.Endpoint.Behaviors.Add(new WebHttpBehavior());
IService channel = cf.CreateChannel();
Console.WriteLine(channel.GetMessage("Get"));
Console.WriteLine(channel.PostMessage("Post"));
Console.Read();
}
// Service
void MainService()
{
WebServiceHost host = new WebServiceHost(typeof(Service), new Uri("http://localhost:8080"));
ServiceEndpoint ep = host.AddServiceEndpoint(typeof(IService),new WebHttpBinding(), "");
ServiceDebugBehavior stp = host.Description.Behaviors.Find();
stp.HttpHelpPageEnabled = false;
stp.IncludeExceptionDetailInFaults = true;
host.Open();
Console.WriteLine("Service is up and running");
Console.ReadLine();
host.Close();
}
// IService.cs
[ServiceContract]
public interface IService
{
[OperationContract]
[WebInvoke(Method="GET", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
string GetMessage(string inputMessage);
[OperationContract]
[WebInvoke(Method="POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
string PostMessage(string inputMessage);
[OperationContract]
[WebInvoke(Method="POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
System.IO.Stream PostJson(System.IO.Stream json);
}
// Service.cs
public class Service : IService
{
public string GetMessage(string inputMessage){
Console.WriteLine(inputMessage);
return "Calling Get for you " + inputMessage;
}
public string PostMessage(string inputMessage){
Console.WriteLine(inputMessage);
return "Calling Post for you " + inputMessage;
}
public System.IO.Stream PostJson (System.IO.Stream json) {
Console.WriteLine(new System.IO.StreamReader(json).ReadToEnd());
return json;
}
}
Can't you just put the URI inside the .config file? You can just change the URI when it's debug or release by having different URI inside .debug.config and .release.config.
Just set the url point
TheWebservice.Url = TheUrlFromTheDatabase;