Question

i am using SOAP API for SugarCRM.
I want to download document using PHP.
I have no idea how to download the document.
Thanks in Advance.

Answer 1

There are generally two “types” of documents in sugarcrm. Those added to the Document module and those added to the History sub panel in e.g. the Account module.

To retrieve documents linked to accounts you should look in the notes table. This also contains everything else from the history sub panel which are linked to the account, e.g. emails. You can properly filter on the document_type column, if all documents are using the same document_type. (Replace [account_id] and [session_id])

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sug="http://www.sugarcrm.com/sugarcrm" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <sug:get_entry_list soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <session xsi:type="xsd:string">[session_id]/session>
         <module_name xsi:type="xsd:string">Notes</module_name>
         <query xsi:type="xsd:string">parent_type = 'Accounts' AND parent_id = '[account_id]'</query>
         <order_by xsi:type="xsd:string"></order_by>
         <offset xsi:type="xsd:int">0</offset>
         <select_fields xsi:type="sug:select_fields" soapenc:arrayType="xsd:string[1]">
           <select_fields xsi:type="xsd:string">id</select_fields>
       <select_fields xsi:type="xsd:string">name</select_fields>
           <select_fields xsi:type="xsd:string">filename</select_fields>
           <select_fields xsi:type="xsd:string">document_revision_id</select_fields>
         </select_fields>
         <max_results xsi:type="xsd:int">100</max_results>
         <deleted xsi:type="xsd:int">0</deleted>
      </sug:get_entry_list>
   </soapenv:Body>
</soapenv:Envelope> 

To get documents from the Documents module, you basically do the same, but it takes two steps. First retrieve the documents from the documents table and afterwards use the document_revision_id to retrieve the document id and filename from the document_revisions table.

In order to download/retrieve a document, you need the id and the filename. Files are usually stored in /cache/upload in you sugarcrm root folder and are named with the id.
So if a document has id=a06bfc2e-c6e9-ac53-9e7b-4bf4e4d862ca, the document can be retrieved from http://my-suger/cache/upload/a06bfc2e-c6e9-ac53-9e7b-4bf4e4d862ca. The retrieved file should than be renamed to the filename, which you get from the web service response.