sugarsoap Web Service

sugarsoap

Click here for a complete list of operations.

get_relationships

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_relationships"

<?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_relationships>
      <session xsi:type="xsd:string">string</session>
      <module_name xsi:type="xsd:string">string</module_name>
      <module_id xsi:type="xsd:string">string</module_id>
      <related_module xsi:type="xsd:string">string</related_module>
      <related_module_query xsi:type="xsd:string">string</related_module_query>
      <deleted xsi:type="xsd:int">int</deleted>
    </tns:get_relationships>
  </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_relationshipsResponse>
      <get_relationshipsResult href="#id1" />
    </tns:get_relationshipsResponse>
    <tns:get_relationships_result id="id1" xsi:type="tns:get_relationships_result">
      <ids href="#id2" />
      <error href="#id3" />
    </tns:get_relationships_result>
    <soapenc:Array id="id2" soapenc:arrayType="tns:id_mod[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:id_mod id="id4" xsi:type="tns:id_mod">
      <id xsi:type="xsd:string">string</id>
      <date_modified xsi:type="xsd:string">string</date_modified>
      <deleted xsi:type="xsd:int">int</deleted>
    </tns:id_mod>
    <tns:id_mod id="id5" xsi:type="tns:id_mod">
      <id xsi:type="xsd:string">string</id>
      <date_modified xsi:type="xsd:string">string</date_modified>
      <deleted xsi:type="xsd:int">int</deleted>
    </tns:id_mod>
  </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_relationships>
      <session xsi:type="xsd:string">string</session>
      <module_name xsi:type="xsd:string">string</module_name>
      <module_id xsi:type="xsd:string">string</module_id>
      <related_module xsi:type="xsd:string">string</related_module>
      <related_module_query xsi:type="xsd:string">string</related_module_query>
      <deleted xsi:type="xsd:int">int</deleted>
    </tns:get_relationships>
  </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_relationshipsResponse>
      <rpc:result xmlns="">get_relationshipsResult</rpc:result>
      <get_relationshipsResult soapenc:id="id0" xsi:type="tns:get_relationships_result">
        <ids soapenc:id="id1" soapenc:itemType="tns:id_mod" soapenc:arraySize="2">
          <Item soapenc:id="id2">
            <id xsi:type="xsd:string">string</id>
            <date_modified xsi:type="xsd:string">string</date_modified>
            <deleted xsi:type="xsd:int">int</deleted>
          </Item>
          <Item soapenc:id="id3">
            <id xsi:type="xsd:string">string</id>
            <date_modified xsi:type="xsd:string">string</date_modified>
            <deleted xsi:type="xsd:int">int</deleted>
          </Item>
        </ids>
        <error soapenc: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>
        </error>
      </get_relationshipsResult>
    </tns:get_relationshipsResponse>
  </soap12:Body>
</soap12:Envelope>