Early Access  

This feature is not enabled for all users. If you’d like to try it out, please email our support team for early access.

Let's see how to create and configure an outbound SOAP message.

Configuring the WSDL Contract   

1. Navigate to  (settings) >> WEB SERVICES >> Outbound >> Select SOAP.

2. Click New SOAP and enter the following details:
   

1. Name: Provide a name for the SOAP service.
   

2. 
   WSDL URL: If using an external WSDL contract, enter the API endpoint URL.

3. 
   Download WSDL : If Download WSDL is enabled, the WSDL from the external URL is downloaded/retrieved. The same is displayed in the Editor.

4. 
   Authentication Type: Select the required authentication method if the WSDL retrieval requires credentials.

5. 
   Credentials: Provide authentication details as needed.

6. 
   Execute in Bridge: Choose the option to execute the SOAP service via the Bridge, then select the appropriate Bridge ID, if applicable.
   

3. Click Save. 

Contracts downloaded via URL are read-only. To modify the contract, uncheck the Download WSDL option, and edit the XML manually. In this case, WSDL URL is of no use.

Generating and Executing SOAP Functions   

1. Go to the SOAP Functions section.

2. Click Generate SOAP Functions. This will parse the WSDL contract and list the available APIs.

3. If you want to create a new API message manually, click SOAP Function in the top-right corner to configure a SOAP message from scratch.

4. To execute the select API message from the list, the following fields will be automatically populated:
   

1. Name

2. Binding

3. Operation

4. SOAP Action

5. Endpoint

6. Message

5. Fill in the other fields to execute the function:
   

1. Authentication Type: Select the authentication type.

2. Credential: Select the credential for authentication. The first credential provided during SOAP outbound creation is auto-selected but can be overwritten.

3. Connection Timeout: Set connection timeout (in milliseconds).
   

6. Click Send to call the API endpoint and receive a response in XML format.

If you make changes to the WSDL contract, click Regenerate Sample SOAP Messages to refresh the function definitions.

• Existing SOAP messages will not be deleted.

• New APIs/messages will be added if detected.

• Modified messages will be updated automatically based on the latest WSDL.

 Configuring variables 

1. We also support local variables or Config Store values in the request message:
   
2. If used, click the Refresh icon to populate available variables and assign values accordingly.

3. Click Send to call the API endpoint and receive a response in XML format.
   

Other Actions     

Enable or Disable SOAP Messages   

You can enable or disable a SOAP message at different levels.

• WSDL Level: Enables or disables the entire WSDL function and its associated APIs.

• Go to SOAP configuration. 

• Under the SOAP Library on the left side, enable or disable the SOAP message.

      

• Function Level: Enables or disables specific API functions within a SOAP message.

• Go to the SOAP Functions section.

• Select a message and enable or disable specific API functions.

 Delete SOAP Messages   

• To delete an entire WSDL:

• Click the Delete icon on the top-right of the SOAP message page.

• To delete a specific API message inside a WSDL:

• Go to the SOAP Functions section.

• Select an API message and click the Delete icon on the top-right.

Executing Outbound SOAP in Codex   

OutboundSOAP.execute("<soap_config_id>", <variables>);

let requestData = {};
requestData["inputNumber"] = "100";
OutboundSOAP.execute(31453000002078039, requestData);

OutboundSOAP.executeByName("wsdl_name", "function_name", "{var1}:{val1}");

let numberToConvert = {};
numberToConvert["number"] = "100";
OutboundSOAP.executeByName("NumberToWordService", "convertNumberToWord", numberToConvert);

Sample SOAP Execution   

Converting Numbers to Words  

Sample Request:  

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:num="http://www.dataaccess.com/webservicesserver/">
   <soapenv:Header/>
   <soapenv:Body>
      <num:NumberToWords>
         <num:ubiNum>123</num:ubiNum>
      </num:NumberToWords>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response:  

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <NumberToWordsResponse xmlns="http://www.dataaccess.com/webservicesserver/">
         <NumberToWordsResult>One Hundred Twenty-Three</NumberToWordsResult>
      </NumberToWordsResponse>
   </soapenv:Body>
</soapenv:Envelope>