sugarsoap Web Service

sugarsoap

Click here for a complete list of operations.

login

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap.asmx HTTP/1.1
Host: demo.splendidcrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sugarcrm.com/sugarcrm/login"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://www.sugarcrm.com/sugarcrm" xmlns:types="http://www.sugarcrm.com/sugarcrm/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:login>
      <user_auth href="#id1" />
      <application_name xsi:type="xsd:string">string</application_name>
    </tns:login>
    <tns:user_auth id="id1" xsi:type="tns:user_auth">
      <user_name xsi:type="xsd:string">string</user_name>
      <password xsi:type="xsd:string">string</password>
      <version xsi:type="xsd:string">string</version>
    </tns:user_auth>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://www.sugarcrm.com/sugarcrm" xmlns:types="http://www.sugarcrm.com/sugarcrm/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:loginResponse>
      <loginResult href="#id1" />
    </tns:loginResponse>
    <tns:set_entry_result id="id1" xsi:type="tns:set_entry_result">
      <id xsi:type="xsd:string">string</id>
      <error href="#id2" />
    </tns:set_entry_result>
    <tns:error_value id="id2" xsi:type="tns:error_value">
      <number xsi:type="xsd:string">string</number>
      <name xsi:type="xsd:string">string</name>
      <description xsi:type="xsd:string">string</description>
    </tns:error_value>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap.asmx HTTP/1.1
Host: demo.splendidcrm.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://www.sugarcrm.com/sugarcrm" xmlns:types="http://www.sugarcrm.com/sugarcrm/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:login>
      <user_auth soapenc:id="id0" xsi:type="tns:user_auth">
        <user_name xsi:type="xsd:string">string</user_name>
        <password xsi:type="xsd:string">string</password>
        <version xsi:type="xsd:string">string</version>
      </user_auth>
      <application_name xsi:type="xsd:string">string</application_name>
    </tns:login>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://www.sugarcrm.com/sugarcrm" xmlns:types="http://www.sugarcrm.com/sugarcrm/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:loginResponse>
      <rpc:result xmlns="">loginResult</rpc:result>
      <loginResult soapenc:id="id0" xsi:type="tns:set_entry_result">
        <id xsi:type="xsd:string">string</id>
        <error soapenc:id="id1" xsi:type="tns:error_value">
          <number xsi:type="xsd:string">string</number>
          <name xsi:type="xsd:string">string</name>
          <description xsi:type="xsd:string">string</description>
        </error>
      </loginResult>
    </tns:loginResponse>
  </soap12:Body>
</soap12:Envelope>