Zoho Writer > Writer - XML RPC API Methods > getSharedDocuments - Get the list of shared documents

getSharedDocuments - Get the list of shared documents

Tags:  

writer.getSharedDocuments - Used to get the list of shared documents


Arguments

1. [struct] - required*

Containing Keys:

Field Description
fromindex (optional)

[scalar] - optional - Sets the initial document number from which the shared documents will be listed. If there are 8 documents & fromindex value is set to 3, the documents will be listed from the 3rd document.

noofdocstoshow (optional)

[scalar] - optional - Sets the number of documents to be listed. If the value is set to 5, then no of documents listed is 5.



If no values are specified in fromindex & noofdocstoshow all the shared documents will be listed.

Sample call to writer.getSharedDocuments

POST /interface/xmlrpc HTTP/1.0
Host: http://www.writer.zoho.com/
Content-Type: text/xml
Content-Length:

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<methodCall>

<methodName>writer.getSharedDocuments</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>fromindex</name>
<value><int>2</int></value>
</member>
<member>
<name>noofdocstoshow</name>
<value><long>6</long></value>
</member>
</struct>
</value>
</param>
</params>

</methodCall>


Response

1. [methodResponse] - required*

Containing Keys:
  • document_name -
  • [scalar] - Name of one of the shared documents in the list.
  • document_id -
  • [scalar] - Unique ID associated with each shared document in the list.
  • version -
  • [scalar] - Specifies the last saved version of the document that is being shared.
  • document_name_url -
  • [scalar] - Unique document url to differentiate multiple documents having similar name.
  • author_name -
  • [scalar] - Displays the email ID/username of the document owner, i.e., the account from which the document is shared.
  • shared_users -
  • [scalar] - Displays the list of email addresses to whom the document has been shared. Shows blank in cases sharing access is disabled.
  • document_locked -
  • [boolean] - Checks whether the document has been locked exclusively for editing in a shared environment. True means the lock is enabled.
  • document_blogged -
  • [boolean] - Checks whether the document has been posted to any of the blog services. False status indicates that the document is not posted to any of the blog service.
  • category -
  • [scalar] - Displays the category of the document as Shared.
Sample return value for writer.getSharedDocuments

HTTP/1.1 200 OK
Connection: close
Content-Length:
Content-Type: text/xml
Date: Wed 01 Nov 2006 23:45:59 GMT
Server: Apache/1.3.4 (Unix)

<methodResponse>


<document>
<document_name>Welcome</document_name>
<document_id>6000000046043</document_id>
<version>-1.0</version>
<document_name_url>hi</document_name_url>
<author_name>johndoe</author_name>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<category>SHARED</category>
</document>

<document>
<document_name>Delights of using Zoho Writer</document_name>
<document_id>6000000046077</document_id>
<version>-1.0</version>
<document_name_url>test</document_name_url>
<author_name>johnhussey</author_name>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<category>SHARED</category>
</document>

</methodResponse>

 

 RSS of this page