sugarsoap
Click here for a complete list of operations.
search_by_module
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_by_module"
<?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_by_module>
<user_name xsi:type="xsd:string">string</user_name>
<password xsi:type="xsd:string">string</password>
<search_string xsi:type="xsd:string">string</search_string>
<modules href="#id1" />
<offset xsi:type="xsd:int">int</offset>
<max_results xsi:type="xsd:int">int</max_results>
</tns:search_by_module>
<soapenc:Array id="id1" soapenc:arrayType="xsd:string[2]">
<Item>string</Item>
<Item>string</Item>
</soapenc:Array>
</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:search_by_moduleResponse>
<search_by_moduleResult href="#id1" />
</tns:search_by_moduleResponse>
<tns:get_entry_list_result id="id1" xsi:type="tns:get_entry_list_result">
<result_count xsi:type="xsd:int">int</result_count>
<next_offset xsi:type="xsd:int">int</next_offset>
<field_list href="#id2" />
<entry_list href="#id3" />
<error href="#id4" />
</tns:get_entry_list_result>
<soapenc:Array id="id2" soapenc:arrayType="tns:field[2]">
<Item href="#id5" />
<Item href="#id6" />
</soapenc:Array>
<soapenc:Array id="id3" soapenc:arrayType="tns:entry_value[2]">
<Item href="#id7" />
<Item href="#id8" />
</soapenc:Array>
<tns:error_value id="id4" 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>
<tns:field id="id5" xsi:type="tns:field">
<name xsi:type="xsd:string">string</name>
<type xsi:type="xsd:string">string</type>
<label xsi:type="xsd:string">string</label>
<required xsi:type="xsd:int">int</required>
<options href="#id9" />
</tns:field>
<tns:field id="id6" xsi:type="tns:field">
<name xsi:type="xsd:string">string</name>
<type xsi:type="xsd:string">string</type>
<label xsi:type="xsd:string">string</label>
<required xsi:type="xsd:int">int</required>
<options href="#id10" />
</tns:field>
<tns:entry_value id="id7" xsi:type="tns:entry_value">
<id xsi:type="xsd:string">string</id>
<module_name xsi:type="xsd:string">string</module_name>
<name_value_list href="#id11" />
</tns:entry_value>
<tns:entry_value id="id8" xsi:type="tns:entry_value">
<id xsi:type="xsd:string">string</id>
<module_name xsi:type="xsd:string">string</module_name>
<name_value_list href="#id12" />
</tns:entry_value>
<soapenc:Array id="id9" soapenc:arrayType="tns:name_value[2]">
<Item xsi:null="1" />
<Item xsi:null="1" />
</soapenc:Array>
<soapenc:Array id="id10" soapenc:arrayType="tns:name_value[2]">
<Item xsi:null="1" />
<Item xsi:null="1" />
</soapenc:Array>
<soapenc:Array id="id11" soapenc:arrayType="tns:name_value[2]">
<Item xsi:null="1" />
<Item xsi:null="1" />
</soapenc:Array>
<soapenc:Array id="id12" soapenc:arrayType="tns:name_value[2]">
<Item xsi:null="1" />
<Item xsi:null="1" />
</soapenc:Array>
</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_by_module>
<user_name xsi:type="xsd:string">string</user_name>
<password xsi:type="xsd:string">string</password>
<search_string xsi:type="xsd:string">string</search_string>
<modules soapenc:id="id0" soapenc:itemType="xsd:string" soapenc:arraySize="2">
<Item>string</Item>
<Item>string</Item>
</modules>
<offset xsi:type="xsd:int">int</offset>
<max_results xsi:type="xsd:int">int</max_results>
</tns:search_by_module>
</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:search_by_moduleResponse>
<rpc:result xmlns="">search_by_moduleResult</rpc:result>
<search_by_moduleResult soapenc:id="id0" xsi:type="tns:get_entry_list_result">
<result_count xsi:type="xsd:int">int</result_count>
<next_offset xsi:type="xsd:int">int</next_offset>
<field_list soapenc:id="id1" soapenc:itemType="tns:field" soapenc:arraySize="2">
<Item soapenc:id="id2">
<name xsi:type="xsd:string">string</name>
<type xsi:type="xsd:string">string</type>
<label xsi:type="xsd:string">string</label>
<required xsi:type="xsd:int">int</required>
<options soapenc:id="id3" soapenc:itemType="tns:name_value" soapenc:arraySize="2">
<Item xsi:nil="true" />
<Item xsi:nil="true" />
</options>
</Item>
<Item soapenc:id="id4">
<name xsi:type="xsd:string">string</name>
<type xsi:type="xsd:string">string</type>
<label xsi:type="xsd:string">string</label>
<required xsi:type="xsd:int">int</required>
<options soapenc:id="id5" soapenc:itemType="tns:name_value" soapenc:arraySize="2">
<Item xsi:nil="true" />
<Item xsi:nil="true" />
</options>
</Item>
</field_list>
<entry_list soapenc:id="id6" soapenc:itemType="tns:entry_value" soapenc:arraySize="2">
<Item soapenc:id="id7">
<id xsi:type="xsd:string">string</id>
<module_name xsi:type="xsd:string">string</module_name>
<name_value_list soapenc:id="id8" soapenc:itemType="tns:name_value" soapenc:arraySize="2">
<Item xsi:nil="true" />
<Item xsi:nil="true" />
</name_value_list>
</Item>
<Item soapenc:id="id9">
<id xsi:type="xsd:string">string</id>
<module_name xsi:type="xsd:string">string</module_name>
<name_value_list soapenc:id="id10" soapenc:itemType="tns:name_value" soapenc:arraySize="2">
<Item xsi:nil="true" />
<Item xsi:nil="true" />
</name_value_list>
</Item>
</entry_list>
<error soapenc:id="id11" 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>
</search_by_moduleResult>
</tns:search_by_moduleResponse>
</soap12:Body>
</soap12:Envelope>