[SalesForce] How to consume a soap web service using workbench

I would like to call a SOAP web service created in salesforce, using Workbench. There are some samples for other types of web services from the apex workbook but not for SOAP 🙁

My class contains 2 methods, each one containing an argument.
Here is my code :

global class WsMyWebServiceClass {

...

webservice static List<Account>  getAccount(Integer  days) {
_________________________

How can I test my method from Workbench ?

When I log in Workbench, I select Utilities | Rest Explorer

Get is selected by default

/services/data/v36.0 is prefilled

If I type /services/Soap/class/WsMyWebServiceClass and click on Execute, I get the following message :

GET not supported, this is a SOAP service, please use POST

So when I switch to Post, there is a Request Body that appears and I don't know what to fill in it ? Some JSON ?

When do I indicate that I'm using the getAccount method ?

If I use Post method, what do I need to fill for the 2 fields ?

/services/Soap/class/WsMyWebServiceClass… ?????
Request body ?

Best Answer

Here is how I have tried using workbench to test a SOAP web service. Hope this helps.

First you have to get the session ID by passing a Soap request(I copied the request XML from SoapUI) to login method of the Salesforce SOAP API.

Service URL: /services/Soap/u/37.0

Method : Post

Request Headers: (below)

Content-Type: text/xml; charset=UTF-8
Accept: text/xml
SOAPAction: ''

Soap Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:partner.soap.sforce.com">
   <soapenv:Header>
      <urn:CallOptions>
         <urn:client></urn:client>
         <urn:defaultNamespace></urn:defaultNamespace>
      </urn:CallOptions>
      <urn:LoginScopeHeader>
         <urn:organizationId></urn:organizationId>
         <!--Optional:-->
         <urn:portalId></urn:portalId>
      </urn:LoginScopeHeader>
   </soapenv:Header>
   <soapenv:Body>
      <urn:login>
         <urn:username>****************</urn:username>
         <urn:password>****password+security token****</urn:password>
      </urn:login>
   </soapenv:Body>
</soapenv:Envelope>

Execute it you will get the webservice response.

In the response you will get the session ID. Copy it and keep it in your notepad to call your Apex webservice.

For next call you have to use the following details.

Service URL: /services/Soap/class/sarojkbera/MyWebService (MyWebService is the Apex class exposed as Soap service)

Apex Class:

global class MyWebService {
    webService static String makeContact(String firstName, String lastName) {
        return 'Hello '+firstName+' ' +lastName;
    }
}

Method : Post

Request Headers: (below)

Content-Type: text/xml; charset=UTF-8
Accept: text/xml
SOAPAction: ''

Soap Request:

Here I have used the generated Soap request from SoapUI.

Put the session ID (obtained in the previous step) in the request XML.

Execute it and you will get the Webservice response as below.

Related Solutions

[SalesForce] How to invoke soap web service

I had to modify your webservice a bit to get a valid WSDL that SOAPUI could import. When you pass the accountId as the Account type Salesforce adds a whole lot of extra simple and complex types to the WSDL that aren't really needed. The WSDL goes from 6 KB to 542 KB. By sticking with strings or Ids the WSDL is much simpler.

Without any modifications I get the following error from SoupUI:

Error: type 'address@http://soup.sforce.com/schemas/class/DFB/myClass'

This is because there is no complex or simple type address in namespace http://soap.sforce.com/schemas/class/DFB/myClass (alias tns).

Here is my simplified Apex web service:

global class myClass { 
    webService static Id makeContact(String lastName, Id accountId) { 
        Contact c = new Contact(LastName = lastName, AccountId = accountId); 
        insert c;
        System.debug(LoggingLevel.Info, 'Created ' + c.Id + ' for ' + accountId);
        return c.id; 
    }
}

Be sure to save the WSDL directly from the link rather than opening it in the browser and then saving it to disk. I've found browsers can make subtle changes to the WSDL that will sometimes corrupt them.

Saving WSDL directly from link

The resulting WSDL imported into SoupUI successfully for me and I was able to make the following request. Here the SessionID was pulled from an active session using the anonymous apex:

String sessionID = UserInfo.getSessionId();
System.debug(sessionID);

Sample request to same pod as the session was retrieved from:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:myc="http://soap.sforce.com/schemas/class/DFB/myClass">
   <soapenv:Header>
      <myc:SessionHeader>
         <myc:sessionId>00D700000000001!AQoAQGOTA_NOTAREALSESSIONID_Bqf78awnl</myc:sessionId>
      </myc:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <myc:makeContact>
         <myc:lastName>Foo</myc:lastName>
         <myc:accountId>0017000000UolWs</myc:accountId>
      </myc:makeContact>
   </soapenv:Body>
</soapenv:Envelope>

Which gave the response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/DFB/myClass">
   <soapenv:Body>
      <makeContactResponse>
         <result>003700000000005AAP</result>
      </makeContactResponse>
   </soapenv:Body>
</soapenv:Envelope>

[SalesForce] Making Apex Callouts to consume Custom Apex Web Service STEPS

You will need to set the endpoint for the client based on the LoginResult serverUrl.

The login call will go to login.salesforce.com. When it comes back the serverUrl will be something like https://na5.salesforce.com/services/Soap/u/34.0.

partnerSoapSforceCom.Soap partner = new partnerSoapSforceCom.Soap();
partnerSoapSforceCom.LoginResult lr = partner.login('user@example.com', 'SomePassword' + 'SomeSecurityToken');    

ARTaskWebService.AR_getActivitiesWebservice client = new ARTaskWebService.AR_getActivitiesWebservice();
client.SessionHeader = new ARTaskWebService.SessionHeader_element();
client.SessionHeader.sessionId = lr.sessionId;

// You may need to adjust this if using a custom Apex Soap service.
client.endpoint__x = lr.serverUrl;

Since your Apex class Soap class probably has an endpoint like https://na8.salesforce.com/services/Soap/class/AR_getActivitiesWebservice you may need to adjust this using the domain in the LoginResult serverUrl.

E.g. replace the na8 pod identifier in your current endpoint with na5 if that is what the serverUrl comes back with.

Best Answer

Related Solutions

[SalesForce] How to invoke soap web service

[SalesForce] Making Apex Callouts to consume Custom Apex Web Service STEPS

Related Topic