Skip to main content




Service Studio version:

SOAP Extensibility API

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • This API can only be used to extend and customize the behavior of consumed SOAP Web Services created in OutSystems 11. To customize consumed SOAP Web Services upgraded from previous versions you must use the (deprecated) EnhancedWebReferences API.

    The OutSystems SOAP Extensibility API enables you to modify the SOAP connection, request and/or response message using .NET code. It is automatically imported to your environment at installation.

    To manipulate the connection, request and/or response message, create an extension module and use its methods in the On Before Request callback action of the consumed SOAP Web Service.
    Check how to use the advanced SOAP extensibility in your application. This topic also contains examples of using the API for address common use cases.

    Note that, unlike the extensibility available for other integration types, the SOAP implementation provides a single extensibility point where you can perform all kinds of customizations: adjust the connection parameters, change the request message and adjust the response message.

    The components described in this topic are available under the following .NET namespace:

    SoapRequest Class

    This object provides access to the SOAP client object implementing the ISOAPClient interface, allows you to register new a runtime behavior callback and to get the SOAP method that invoked the extension.


    Name Description
    ISOAPClient GetCurrentClient()
    Returns the client used for the request. Should only be used inside the On Before Request callback, otherwise it returns null.
    static void RegisterEndpointBehavior(IEndpointBehavior behavior) Registers a callback to modify the request message or/and response message.
    static string GetActionName() Returns the name of the SOAP method that invoked the extension.

    ISOAPClient Interface

    ISOAPClient is an OutSystems interface providing an abstraction over Windows Communication Foundation (WCF) client implementations that can be used to call web services.


    Name Type Description
    ClientCredentials ClientCredentials
    (from WCF)
    Ready-only property that returns an object representing the client credentials used to call an operation.
    Endpoint ServiceEndpoint
    (from WCF)
    Read-only property that returns the target endpoint for the service to which the WCF client can connect.
    InnerChannel IClientChannel
    (from WCF)
    Read-only property that returns the client channel for the WCF client object.
    State CommunicationState
    (from WCF)
    Read-only property that returns the enum value of the current state of the System.ServiceModel.ClientBase object.


    Name Description
    ChannelFactory GetChannelFactory() Returns the inner channel used to send messages to variously configured service endpoints.
    • Was this article helpful?