sugarsoap

Click here for a complete list of operations.

search

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/search"

<?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:search>
      <user_name xsi:type="xsd:string">string</user_name>
      <password xsi:type="xsd:string">string</password>
      <name xsi:type="xsd:string">string</name>
    </tns:search>
  </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:searchResponse>
      <searchResult href="#id1" />
    </tns:searchResponse>
    <soapenc:Array id="id1" soapenc:arrayType="tns:contact_detail[2]">
      <Item href="#id2" />
      <Item href="#id3" />
    </soapenc:Array>
    <tns:contact_detail id="id2" xsi:type="tns:contact_detail">
      <email_address xsi:type="xsd:string">string</email_address>
      <name1 xsi:type="xsd:string">string</name1>
      <name2 xsi:type="xsd:string">string</name2>
      <association xsi:type="xsd:string">string</association>
      <id xsi:type="xsd:string">string</id>
      <msi_id xsi:type="xsd:string">string</msi_id>
      <type xsi:type="xsd:string">string</type>
    </tns:contact_detail>
    <tns:contact_detail id="id3" xsi:type="tns:contact_detail">
      <email_address xsi:type="xsd:string">string</email_address>
      <name1 xsi:type="xsd:string">string</name1>
      <name2 xsi:type="xsd:string">string</name2>
      <association xsi:type="xsd:string">string</association>
      <id xsi:type="xsd:string">string</id>
      <msi_id xsi:type="xsd:string">string</msi_id>
      <type xsi:type="xsd:string">string</type>
    </tns:contact_detail>
  </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:search>
      <user_name xsi:type="xsd:string">string</user_name>
      <password xsi:type="xsd:string">string</password>
      <name xsi:type="xsd:string">string</name>
    </tns:search>
  </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:searchResponse>
      <rpc:result xmlns="">searchResult</rpc:result>
      <searchResult soapenc:id="id0" soapenc:itemType="tns:contact_detail" soapenc:arraySize="2">
        <Item soapenc:id="id1">
          <email_address xsi:type="xsd:string">string</email_address>
          <name1 xsi:type="xsd:string">string</name1>
          <name2 xsi:type="xsd:string">string</name2>
          <association xsi:type="xsd:string">string</association>
          <id xsi:type="xsd:string">string</id>
          <msi_id xsi:type="xsd:string">string</msi_id>
          <type xsi:type="xsd:string">string</type>
        </Item>
        <Item soapenc:id="id2">
          <email_address xsi:type="xsd:string">string</email_address>
          <name1 xsi:type="xsd:string">string</name1>
          <name2 xsi:type="xsd:string">string</name2>
          <association xsi:type="xsd:string">string</association>
          <id xsi:type="xsd:string">string</id>
          <msi_id xsi:type="xsd:string">string</msi_id>
          <type xsi:type="xsd:string">string</type>
        </Item>
      </searchResult>
    </tns:searchResponse>
  </soap12:Body>
</soap12:Envelope>