[SalesForce] SOAP XML node Sequence

So I recently had the task of logging in using the SOAP API. I constructed the envelope, and logged in fine with the following:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:enterprise.soap.sforce.com">
       <soapenv:Body>
          <urn:login>
             <username>example@user.com</username>username>
             <password>password_token</password>
          </urn:login>
       </soapenv:Body>
    </soapenv:Envelope>

But when I move the username and password nodes around I get an fault saying that my username or password is incorrect.

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:enterprise.soap.sforce.com">
       <soapenv:Body>
          <urn:login>
             <password>password_token</password>
             <username>example@user.com</username>username>
          </urn:login>
       </soapenv:Body>
    </soapenv:Envelope>

Is it common to enforce the XML structure like this? I used SOAPUI to test this.

Best Answer

It depends on the author of the Web Service or more specifically what is in the WSDL (Web Service Definition Language) they provide.

In most cases the receiving code (the web service implementation) does not get invoked until all of the XML in the SOAP envelope is unmarhsalled/deserialised and passed to it, so it should not really matter what order it arrived.

However it does seem that most Web Service providers these days do prefer to use the <xsd:sequence> element in my experience. When used in the WSDL that defines the web service, this implies the need for specific sequence none the less. And this is the standard Salesforce is using as well.

Looking at the Enterprise WSDL the login element does indeed use this, hence the behaviour your seeing.

<element name="login">

<complexType>

<sequence>

<element name="username" type="xsd:string"/>

<element name="password" type="xsd:string"/>

</sequence>

</complexType>

</element>

Related Solutions

[SalesForce] ExactTarget SOAP Request returns Fault in Response

POSTMAN is not sending any headers with the SOAP Packet. Try adding this to test:

POST https://webservice.exacttarget.com/Service.asmx HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "Create"
Content-Length: 1925
Host: webservice.exacttarget.com
Connection: Keep-Alive

ALSO during my testing of your packet I found that this:

<IsHTMLPaste>True</IsHTMLPaste>

Should be

<IsHTMLPaste>true</IsHTMLPaste>

Hope this helps you.

[SalesForce] How to form SOAP XML request to update Salesforce dara

You can construct a SOAP request using those classes. Using the DOM classes is easier because using those you do not need to work at such a detailed level in your code.

Here is an example of a SOAP message from the Examples of SOAP Messages section of the "Simple Object Access Protocol (SOAP) 1.1" spec:

POST /StockQuote HTTP/1.1
Host: www.stockquoteserver.com
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn
SOAPAction: "Some-URI"

<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
       <m:GetLastTradePrice xmlns:m="Some-URI">
           <symbol>DIS</symbol>
       </m:GetLastTradePrice>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Note the very specific namespaces that must be used, the Envelope and Body elements that must be present, and the SOAPAction header. You will need to get all the details right for your request to work, and also your response parser will have to deal with similar details.

(SOAP is usually handled by using code generators such as WSDL2Apex because of the complexity. Unfortunately WSDL2Apex does not handle many elements commonly present in WSDLs.)

Best Answer

Related Solutions

[SalesForce] ExactTarget SOAP Request returns Fault in Response

[SalesForce] How to form SOAP XML request to update Salesforce dara

Related Topic