sugarsoap Web Service

sugarsoap

Click here for a complete list of operations.

set_entries

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

<?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:set_entries>
      <session xsi:type="xsd:string">string</session>
      <module_name xsi:type="xsd:string">string</module_name>
      <name_value_lists href="#id1" />
    </tns:set_entries>
    <soapenc:Array id="id1" soapenc:arrayType="tns:name_value[][2]">
      <Item href="#id2" />
      <Item href="#id3" />
    </soapenc:Array>
    <soapenc:Array id="id2" soapenc:arrayType="tns:name_value[2]">
      <Item href="#id4" />
      <Item href="#id5" />
    </soapenc:Array>
    <soapenc:Array id="id3" soapenc:arrayType="tns:name_value[2]">
      <Item href="#id6" />
      <Item href="#id7" />
    </soapenc:Array>
    <tns:name_value id="id4" xsi:type="tns:name_value">
      <name xsi:type="xsd:string">string</name>
      <value xsi:type="xsd:string">string</value>
    </tns:name_value>
    <tns:name_value id="id5" xsi:type="tns:name_value">
      <name xsi:type="xsd:string">string</name>
      <value xsi:type="xsd:string">string</value>
    </tns:name_value>
    <tns:name_value id="id6" xsi:type="tns:name_value">
      <name xsi:type="xsd:string">string</name>
      <value xsi:type="xsd:string">string</value>
    </tns:name_value>
    <tns:name_value id="id7" xsi:type="tns:name_value">
      <name xsi:type="xsd:string">string</name>
      <value xsi:type="xsd:string">string</value>
    </tns:name_value>
  </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:set_entriesResponse>
      <set_entriesResult href="#id1" />
    </tns:set_entriesResponse>
    <tns:set_entries_result id="id1" xsi:type="tns:set_entries_result">
      <ids href="#id2" />
      <error href="#id3" />
    </tns:set_entries_result>
    <soapenc:Array id="id2" soapenc:arrayType="xsd:string[2]">
      <Item>string</Item>
      <Item>string</Item>
    </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>
  </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:set_entries>
      <session xsi:type="xsd:string">string</session>
      <module_name xsi:type="xsd:string">string</module_name>
      <name_value_lists soapenc:id="id0" soapenc:itemType="tns:name_value[]" soapenc:arraySize="2">
        <Item soapenc:id="id1" soapenc:itemType="tns:name_value" soapenc:arraySize="2">
          <Item soapenc:id="id2">
            <name xsi:type="xsd:string">string</name>
            <value xsi:type="xsd:string">string</value>
          </Item>
          <Item soapenc:id="id3">
            <name xsi:type="xsd:string">string</name>
            <value xsi:type="xsd:string">string</value>
          </Item>
        </Item>
        <Item soapenc:id="id4" soapenc:itemType="tns:name_value" soapenc:arraySize="2">
          <Item soapenc:id="id5">
            <name xsi:type="xsd:string">string</name>
            <value xsi:type="xsd:string">string</value>
          </Item>
          <Item soapenc:id="id6">
            <name xsi:type="xsd:string">string</name>
            <value xsi:type="xsd:string">string</value>
          </Item>
        </Item>
      </name_value_lists>
    </tns:set_entries>
  </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:set_entriesResponse>
      <rpc:result xmlns="">set_entriesResult</rpc:result>
      <set_entriesResult soapenc:id="id0" xsi:type="tns:set_entries_result">
        <ids soapenc:id="id1" soapenc:itemType="xsd:string" soapenc:arraySize="2">
          <Item>string</Item>
          <Item>string</Item>
        </ids>
        <error soapenc: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>
        </error>
      </set_entriesResult>
    </tns:set_entriesResponse>
  </soap12:Body>
</soap12:Envelope>