How to add HTTP Header to SOAP Client

Question

Can someone answer me if it is possible to add HTTP header to soap client web-service calls. After surfing Internet the only thin I found was how to add SOAP header.

The code looks like this:

var client =new MyServiceSoapClient();
//client.AddHttpHeader("myCustomHeader","myValue");//There's no such method, it's just for clearness
var res = await client.MyMethod();

UPDATE:

The request should look like this
POST https://service.com/Service.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.host.com/schemas/Authentication.xsd/Action"
Content-Length: 351
MyHeader: "myValue"
Expect: 100-continue
Accept-Encoding: gzip, deflate
Connection: Keep-Alive

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header/>
  <s:Body>
    <myBody>BodyGoesHere</myBody>
  </s:Body>
</s:Envelope>

Header property in the envelop should be empty

score 60 · Answer 1 · edited Oct 02 '19 at 11:58

60

Try to use this:

SoapServiceClient client = new SoapServiceClient();

using(new OperationContextScope(client.InnerChannel)) 
{
    // // Add a SOAP Header (Header property in the envelope) to an outgoing request. 
    // MessageHeader aMessageHeader = MessageHeader
    //    .CreateHeader("MySOAPHeader", "http://tempuri.org", "MySOAPHeaderValue");
    // OperationContext.Current.OutgoingMessageHeaders.Add(aMessageHeader);

    // Add a HTTP Header to an outgoing request
    HttpRequestMessageProperty requestMessage = new HttpRequestMessageProperty();
    requestMessage.Headers["MyHttpHeader"] = "MyHttpHeaderValue";
    OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] 
       = requestMessage;

    var result = client.MyClientMethod();
}

See here for more detail.

edited Oct 02 '19 at 11:58

SteveC

15,808
23
102
173

answered Apr 10 '14 at 20:37

Ivan Melnikov

731
5
4

2

this should be marked as answer, worked for me. thanks – Syed Waqas Oct 13 '15 at 07:10
3

What If InnerChanner doesn't exists in current client (I'm trying with SOAP Call) – NewPHPer Aug 04 '17 at 12:22
What is `SoapServiceClient`? – tRuEsAtM Feb 06 '18 at 00:28
In my case, InnerChannel did not exist because i used WSDL.exe to create a client side proxy, as opposed to svcutil.exe – Peter PitLock Nov 29 '18 at 12:48
Worked like a charm, saved me from a headache. And thank you for leaving the commented code, that's actually what I was looking for - adding headers inside the envelope. – OrionMD Oct 16 '20 at 12:46
"The provided URI scheme 'https' is invalid; expected 'http'. (Parameter 'via')" is what I get. If I change url to http it seems to work, but this is not a valid url in my case. – Antonio Rodríguez Sep 03 '21 at 11:05

score 3 · Answer 2 · answered Sep 19 '13 at 06:20

3

Try this

var client = new MyServiceSoapClient();
using (var scope = new OperationContextScope(client.InnerChannel))
{
    // Create a custom soap header
    var msgHeader = MessageHeader.CreateHeader("myCustomHeader", "The_namespace_URI_of_the_header_XML_element", "myValue");
    // Add the header into request message
    OperationContext.Current.OutgoingMessageHeaders.Add(msgHeader);

    var res = await client.MyMethod();
}

answered Sep 19 '13 at 06:20

Farhan Ghumra

15,180
6
50
115

Thanks, this is not what I need. I've updated description, take a look on it. – kappie Sep 20 '13 at 05:37
This seems nice, but it encodes. For instance `<` becomes `<`. Any ideas how to prevent this? I've checked the overloads but none seem to add the header as is, RAW. – Mike de Klerk Nov 30 '18 at 09:53

Qué Padre · Answer 3 · 2013-09-19T06:42:26.320

1

var client = new MyServiceSoapClient();
using (new OperationContextScope(InnerChannel))
{ 
    WebOperationContext.Current.OutgoingRequest.Headers.Add("myCustomHeader", "myValue");                
}

edited Sep 19 '13 at 06:42

answered Sep 19 '13 at 06:34

Qué Padre

2,005
3
24
39

Thanks, this is not what I need. I've updated description, take a look on it. – kappie Sep 20 '13 at 05:36
What is `MyServiceSoapClient`? – tRuEsAtM Feb 06 '18 at 00:28
If you are trying to pass Customer Header in RequestHeader then this would be the correct answer. For me this was it. – Sandeep Maharjan Jul 05 '19 at 09:03

score 1 · Answer 4 · answered Feb 17 '22 at 19:25

To add HTTP header to standard generated SOAP client (through either service reference or by generating client using svcutil) you can leverage Endpoint.Behaviors extension point which I found the most convenient.

Couple steps need to be accomplished. First we need to create message inspector with actual feature which will add HTTP header ("HEADER_WHICH_WE_WANT") to each SOAP request

using System.ServiceModel;
using System.ServiceModel.Channels;
using System.ServiceModel.Dispatcher;

class MessageInspector : IClientMessageInspector
{
  public object BeforeSendRequest(ref Message request, IClientChannel channel)
  {
    var property = request.Properties.ContainsKey(HttpRequestMessageProperty.Name)?
    request.Properties[HttpRequestMessageProperty.Name] as HttpRequestMessageProperty: new HttpRequestMessageProperty();

    if (null == property)
      return null;

    property.Headers["HEADER_WHICH_WE_WANT"] = "Actual Value we want";
    request.Properties[HttpRequestMessageProperty.Name] = property;
    return null;
}}

next we need to add this MessageInspector to IEndpointBehavior interface implementation at clientRuntime.MessageInspectors point

using System.ServiceModel.Channels;
using System.ServiceModel.Description;
using System.ServiceModel.Dispatcher;

internal class InspectorBehavior : IEndpointBehavior
{
  public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
  {
   clientRuntime.MessageInspectors.Add(new MessageInspector());
  }
}

and the last thing is to register this behavior for SOAP client

SoapClient.Endpoint.Behaviors.Add(new InspectorBehavior());

that's it, now each SOAP call will be equipped with custom HTTP header "HEADER_WHICH_WE_WANT" with value "Actual Value we want" we specified in our code.

for me this is the better answer as you only do it once and is valid for all subsequent calls regardless of where it's called from +1 — MeeKaaH, Feb 07 '23 at 11:03

score 0 · Answer 5 · answered Aug 02 '21 at 19:05

Some of those answers would add headers to the XML body content of the request. To add the headers to the request itself follow:

SoapServiceClient client = new SoapServiceClient();

using(var scope = new OperationContextScope(client.InnerChannel)) 
{
     WebOperationContext.Current.OutgoingRequest.Headers.
           Add("headerKey", "headerValue");

    var result = client.MyClientMethod();
}

Note the change of OperationContext for WebOperationContext. Is a helper class that provides easy access to contextual properties of Web requests and responses.

How to add HTTP Header to SOAP Client

5 Answers5

Linked