sugarsoap
Click here for a complete list of operations.
get_module_fields
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/get_module_fields"
<?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:get_module_fields>
<session xsi:type="xsd:string">string</session>
<module_name xsi:type="xsd:string">string</module_name>
</tns:get_module_fields>
</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:get_module_fieldsResponse>
<get_module_fieldsResult href="#id1" />
</tns:get_module_fieldsResponse>
<tns:module_fields id="id1" xsi:type="tns:module_fields">
<module_name xsi:type="xsd:string">string</module_name>
<module_fields1 href="#id2" />
<error href="#id3" />
</tns:module_fields>
<soapenc:Array id="id2" soapenc:arrayType="tns:field[2]">
<Item href="#id4" />
<Item href="#id5" />
</soapenc:Array>
<tns:error_value id="id3" 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="id4" 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="#id6" />
</tns:field>
<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="#id7" />
</tns:field>
<soapenc:Array id="id6" soapenc:arrayType="tns:name_value[2]">
<Item xsi:null="1" />
<Item xsi:null="1" />
</soapenc:Array>
<soapenc:Array id="id7" 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:get_module_fields>
<session xsi:type="xsd:string">string</session>
<module_name xsi:type="xsd:string">string</module_name>
</tns:get_module_fields>
</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:get_module_fieldsResponse>
<rpc:result xmlns="">get_module_fieldsResult</rpc:result>
<get_module_fieldsResult soapenc:id="id0" xsi:type="tns:module_fields">
<module_name xsi:type="xsd:string">string</module_name>
<module_fields1 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>
</module_fields1>
<error soapenc:id="id6" 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>
</get_module_fieldsResult>
</tns:get_module_fieldsResponse>
</soap12:Body>
</soap12:Envelope>