API METHOD - (< Back)

writer.getDocuments - Display the list of documents.

Arguments

1. [struct] - required*

Containing Keys:

Field	Description
fromindex (optional)	[scalar] - optional - Sets the initial document number from which the documents will be listed. If there are 10 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 value is specified in fromindex & noofdocstoshow, all the documents will be listed.

Sample call to writer.getDocuments

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.getDocuments</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 documents in the list.

document_id -

[scalar] - required* - Unique ID associated with each document in the list.

version -

[scalar] - Specifies the last saved version of the document.

document_name_url -

[scalar] - Unique document url to differentiate multiple documents having similar name.

author_name -

[scalar] - Displays the email ID of the document owner, i.e., the account from which the document is created.

created_date -

[date] - Displays the created date of the document. E.g. Thu, Sep 28, 2006.

document_trashed -

[boolean] - Checks whether the document was trashed & restored in the list. Takes any one of the values - True or False.

lastmodifiedby -

[scalar] - Specifies the Email ID of the person who has last edited the document. In case the document is shared & it is edited by one of the invitees, then the Email ID will be different from that of the author_name's ID.

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.

Sample return value for writer.getDocuments

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>

<Documents>

<document>
<document_name>hi</document_name>
<document_id>6000000046043</document_id>
<version>-1.0</version>
<document_name_url>hi</document_name_url>
<author_name>andywatkin@clickit.com</author_name>
<created_date>Mon, Sep 25, 2006</created_date>
<document_trashed>false</document_trashed>
<lastmodifiedby>jsonnet@highend.com</lastmodifiedby>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
</document>

<document>
<document_name>testt</document_name>
<document_id>6000000046043</document_id>
<version>-1.0</version>
<document_name_url>hi</document_name_url>
<author_name>michellecollete@mail.com</author_name>
<created_date>Mon, Sep 25, 2006</created_date>
<document_trashed>false</document_trashed>
<lastmodifiedby>kevinshine</lastmodifiedby>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
</document>

</Documents>

</methodResponse>