Client to send SOAP request and receive response

Question

Trying to create a C  client  will be developed as a Windows service  that sends SOAP requests to a web service  and gets the results    From this question I saw this code   protected virtual WebRequest CreateRequest ISoapMessage soapMessage        var wr   WebRequest Create soapMessage Uri       wr ContentType    text xml charset utf-8       wr ContentLength   soapMessage ContentXml Length       wr Headers Add  SOAPAction   soapMessage SoapAction       wr Credentials   soapMessage Credentials      wr Method    POST       wr GetRequestStream   Write Encoding UTF8 GetBytes soapMessage ContentXml   0  soapMessage ContentXml Length        return wr     public interface ISoapMessage       string Uri   get        string ContentXml   get        string SoapAction   get        ICredentials Credentials   get        Looks nice  anyone knows how to use it and if it is the best practice

User · Answer

Call SOAP webservice in c      using  var client   new UpdatedOutlookServiceReferenceAPI OutlookServiceSoapClient  OutlookServiceSoap          ServicePointManager SecurityProtocol   SecurityProtocolType Ssl3   SecurityProtocolType Tls12      var result   client UploadAttachmentBase64 GUID  FinalFileName  fileURL        if  result    true                resultFlag   true            else               resultFlag   false            LogWriter LogWrite1  resultFlag       resultFlag

User · Answer

I normally use another way to do the same  using System Xml  using System Net  using System IO   public static void CallWebService         var  url    http   xxxxxxxxx Service1 asmx       var  action    http   xxxxxxxx Service1 asmx op HelloWorld        XmlDocument soapEnvelopeXml   CreateSoapEnvelope        HttpWebRequest webRequest   CreateWebRequest  url   action       InsertSoapEnvelopeIntoWebRequest soapEnvelopeXml  webRequest           begin async call to web request      IAsyncResult asyncResult   webRequest BeginGetResponse null  null           suspend this thread until call is complete  You might want to        do something usefull here like update your UI      asyncResult AsyncWaitHandle WaitOne            get the response from the completed web request      string soapResult      using  WebResponse webResponse   webRequest EndGetResponse asyncResult                 using  StreamReader rd   new StreamReader webResponse GetResponseStream                           soapResult   rd ReadToEnd                      Console Write soapResult                    private static HttpWebRequest CreateWebRequest string url  string action        HttpWebRequest webRequest    HttpWebRequest WebRequest Create url       webRequest Headers Add  SOAPAction   action       webRequest ContentType    text xml charset   utf-8         webRequest Accept    text xml       webRequest Method    POST       return webRequest     private static XmlDocument CreateSoapEnvelope         XmlDocument soapEnvelopeDocument   new XmlDocument        soapEnvelopeDocument LoadXml         lt SOAP-ENV Envelope xmlns SOAP-ENV   http   schemas xmlsoap org soap envelope                    xmlns xsi   http   www w3 org 1999 XMLSchema-instance                   xmlns xsd   http   www w3 org 1999 XMLSchema   gt           lt SOAP-ENV Body gt               lt HelloWorld xmlns   http   tempuri org                     SOAP-ENV encodingStyle   http   schemas xmlsoap org soap encoding    gt                   lt int1 xsi type   xsd integer   gt 12 lt  int1 gt                   lt int2 xsi type   xsd integer   gt 32 lt  int2 gt               lt  HelloWorld gt           lt  SOAP-ENV Body gt       lt  SOAP-ENV Envelope gt         return soapEnvelopeDocument     private static void InsertSoapEnvelopeIntoWebRequest XmlDocument soapEnvelopeXml  HttpWebRequest webRequest        using  Stream stream   webRequest GetRequestStream                  soapEnvelopeXml Save stream

User · Answer

The best practice is to reference the WSDL and use it like a web service reference  It s easier and works better  but if you don t have the WSDL  the XSD definitions are a good piece of code

User · Answer

I think there is a simpler way    public async Task lt string gt  CreateSoapEnvelope            string soapString      lt  xml version   1 0   encoding   utf-8    gt             lt soap Envelope xmlns xsi   http   www w3 org 2001 XMLSchema-instance   xmlns xsd   http   www w3 org 2001 XMLSchema   xmlns soap   http   schemas xmlsoap org soap envelope    gt                 lt soap Body gt                     lt HelloWorld xmlns   http   tempuri org      gt                 lt  soap Body gt             lt  soap Envelope gt               HttpResponseMessage response   await PostXmlRequest  your url here   soapString             string content   await response Content ReadAsStringAsync           return content       public static async Task lt HttpResponseMessage gt  PostXmlRequest string baseUrl  string xmlString           using  var httpClient   new HttpClient                      var httpContent   new StringContent xmlString  Encoding UTF8   text xml              httpContent Headers Add  SOAPAction    http   tempuri org HelloWorld               return await httpClient PostAsync baseUrl  httpContent

User · Answer

I wrote a more general helper class which accepts a string-based dictionary of custom parameters  so that they can be set by the caller without having to hard-code them  It goes without saying that you should only use such method when you want  or need  to manually issue a SOAP-based web service  in most common scenarios the recommended approach would be using the Web Service WSDL together with the Add Service Reference Visual Studio feature instead   using System  using System Collections Generic  using System IO  using System Linq  using System Net  using System Xml   namespace Ryadel Web SOAP            lt summary gt          Helper class to send custom SOAP requests           lt  summary gt      public static class SOAPHelper                    lt summary gt              Sends a custom sync SOAP request to given URL and receive a request              lt  summary gt               lt param name  url  gt The WebService endpoint URL lt  param gt               lt param name  action  gt The WebService action name lt  param gt               lt param name  parameters  gt A dictionary containing the parameters in a key-value fashion lt  param gt               lt param name  soapAction  gt The SOAPAction value  as specified in the Web Service s WSDL  or NULL to use the url parameter  lt  param gt               lt param name  useSOAP12  gt Set this to TRUE to use the SOAP v1 2 protocol  FALSE to use the SOAP v1 1  default  lt  param gt               lt returns gt A string containing the raw Web Service response lt  returns gt          public static string SendSOAPRequest string url  string action  Dictionary lt string  string gt  parameters  string soapAction   null  bool useSOAP12   false                           Create the SOAP envelope             XmlDocument soapEnvelopeXml   new XmlDocument                var xmlStr    useSOAP12                       lt  xml version   1 0   encoding   utf-8    gt                       lt soap12 Envelope xmlns xsi   http   www w3 org 2001 XMLSchema-instance                         xmlns xsd   http   www w3 org 2001 XMLSchema                         xmlns soap12   http   www w3 org 2003 05 soap-envelope   gt                         lt soap12 Body gt                           lt  0  xmlns    1    gt  2  lt   0  gt                         lt  soap12 Body gt                       lt  soap12 Envelope gt                        lt  xml version   1 0   encoding   utf-8    gt                       lt soap Envelope xmlns soap   http   schemas xmlsoap org soap envelope                             xmlns xsi   http   www w3 org 2001 XMLSchema-instance                            xmlns xsd   http   www w3 org 2001 XMLSchema   gt                           lt soap Body gt                              lt  0  xmlns    1    gt  2  lt   0  gt                           lt  soap Body gt                       lt  soap Envelope gt                string parms   string Join string Empty  parameters Select kv   gt  String Format   lt  0  gt  1  lt   0  gt    kv Key  kv Value   ToArray                 var s   String Format xmlStr  action  new Uri url  GetLeftPart UriPartial Authority         parms               soapEnvelopeXml LoadXml s                   Create the web request             HttpWebRequest webRequest    HttpWebRequest WebRequest Create url               webRequest Headers Add  SOAPAction   soapAction    url               webRequest ContentType    useSOAP12     application soap xml charset   utf-8       text xml charset   utf-8                 webRequest Accept    useSOAP12     application soap xml     text xml               webRequest Method    POST                   Insert SOAP envelope             using  Stream stream   webRequest GetRequestStream                                  soapEnvelopeXml Save stream                                 Send request and retrieve result             string result              using  WebResponse response   webRequest GetResponse                                  using  StreamReader rd   new StreamReader response GetResponseStream                                           result   rd ReadToEnd                                                return result                      For additional info  amp  details regarding this class you can also read this post on my blog

User · Answer

As an alternative  and pretty close to debiasej approach  Since a SOAP request is just a HTTP request  you can simply perform a GET or POST using with HTTP client  but it s not mandatory to build SOAP envelope  Something like this  using Microsoft Extensions Logging  using System  using System Net Http  using System Text  using System Threading Tasks   namespace HGF Infraestructure Communications       public class SOAPSample               private readonly IHttpClientFactory  clientFactory          private readonly ILogger lt DocumentProvider gt   logger           public SOAPSample ILogger lt DocumentProvider gt  logger                            IHttpClientFactory clientFactory                         clientFactory   clientFactory               logger   logger                     public async Task lt string gt  UsingGet int value1  int value2                        try                               var client    clientFactory CreateClient                    var response   await client GetAsync   quot https   hostname com webservice asmx SampleMethod value1  value1  amp value2  value2  quot   HttpCompletionOption ResponseHeadersRead                      NULL check  HTTP Status Check                      return await response Content ReadAsStringAsync                              catch  Exception ex                                 logger LogError ex   quot Oops  Something went wrong quot                    return ex Message                                    public async Task lt string gt  UsingPost int value1  int value2                        try                               var content   new StringContent   quot value1  value1  amp value2  value2  quot   Encoding UTF8   quot application x-www-form-urlencoded quot                     var client    clientFactory CreateClient                    var response   await client PostAsync  quot https   hostname com webservice asmx SampleMethod quot   content                      NULL check  HTTP Status Check                      return await response Content ReadAsStringAsync                              catch  Exception ex                                 logger LogError ex   quot Oops  Something went wrong quot                    return ex Message                                   Of course  it depends on your scenario  If the payload is too complex  then this won t work

User · Answer

I got this simple solution here   Sending SOAP request and receiving response in  NET 4 0 C  without using the WSDL or proxy classes   class Program                    lt summary gt              Execute a Soap WebService call              lt  summary gt          public static void Execute                         HttpWebRequest request   CreateWebRequest                XmlDocument soapEnvelopeXml   new XmlDocument                soapEnvelopeXml LoadXml    lt  xml version   1 0   encoding   utf-8    gt                   lt soap Envelope xmlns xsi   http   www w3 org 2001 XMLSchema-instance   xmlns xsd   http   www w3 org 2001 XMLSchema   xmlns soap   http   schemas xmlsoap org soap envelope    gt                     lt soap Body gt                       lt HelloWorld xmlns   http   tempuri org      gt                     lt  soap Body gt                   lt  soap Envelope gt                  using  Stream stream   request GetRequestStream                                  soapEnvelopeXml Save stream                              using  WebResponse response   request GetResponse                                  using  StreamReader rd   new StreamReader response GetResponseStream                                           string soapResult   rd ReadToEnd                        Console WriteLine soapResult                                                          lt summary gt              Create a soap webrequest to  Url               lt  summary gt               lt returns gt  lt  returns gt          public static HttpWebRequest CreateWebRequest                         HttpWebRequest webRequest    HttpWebRequest WebRequest Create   http   localhost 56405 WebService1 asmx op HelloWorld                webRequest Headers Add   SOAP Action                webRequest ContentType    text xml charset   utf-8                 webRequest Accept    text xml               webRequest Method    POST               return webRequest                     static void Main string   args                        Execute

User · Answer

So this is my final code after googling for 2 days on how to add a namespace and make soap request along with the SOAP envelope without adding proxy Service Reference  class Request       public static void Execute string XML                try                       HttpWebRequest request   CreateWebRequest                XmlDocument soapEnvelopeXml   new XmlDocument                soapEnvelopeXml LoadXml AppendEnvelope AddNamespace XML                  using  Stream stream   request GetRequestStream                                  soapEnvelopeXml Save stream                              using  WebResponse response   request GetResponse                                  using  StreamReader rd   new StreamReader response GetResponseStream                                           string soapResult   rd ReadToEnd                        Console WriteLine soapResult                                                     catch  Exception ex                        Console WriteLine ex                        private static HttpWebRequest CreateWebRequest                 string ICMURL   System Configuration ConfigurationManager AppSettings Get  ICMUrl            HttpWebRequest webRequest   null           try                       webRequest    HttpWebRequest WebRequest Create ICMURL               webRequest Headers Add   SOAP Action                webRequest ContentType    text xml charset   utf-8                 webRequest Accept    text xml               webRequest Method    POST                     catch  Exception ex                        Console WriteLine ex                     return webRequest             private static string AddNamespace string XML                string result   string Empty          try                        XmlDocument xdoc   new XmlDocument                xdoc LoadXml XML                XmlElement temproot   xdoc CreateElement  ws    Request    http   example com                 temproot InnerXml   xdoc DocumentElement InnerXml              result   temproot OuterXml                     catch  Exception ex                        Console WriteLine ex                      return result             private static string AppendEnvelope string data                string head     lt soapenv Envelope xmlns soapenv   http   schemas xmlsoap org soap envelope     gt  lt soapenv Header  gt  lt soapenv Body gt            string end      lt  soapenv Body gt  lt  soapenv Envelope gt            return head   data   end

[c#] Client to send SOAP request and receive response

Examples related to c#

Examples related to soap

Examples related to webservice-client