Zoho Writer > Writer - XML RPC API Methods > viewDocument - View a particular document contents

viewDocument - View a particular document contents

Tags:  

writer.viewDocument - View a particular documents' content.


Arguments

1. [struct] - required*

Containing Keys:

Field Description
documentname

[scalar] - required* - Specify the name of the document to be viewed.

documentid

[scalar] - required* - Sets the unique document id for the particular viewed document.

version

[scalar] - required* - Specify the version of the document viewed.


 
Sample call to writer.viewDocument

GET/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.viewDocument</methodName>
<params>
<param>
<value>
<struct>

<member>
<name>documentname</name>
<value><string>test</string></value>
</member>

<member>
<name>documentid</name>
<value><long>6000000057003</long></value>
</member>

<member>
<name>version</name>
<value><double>1.1</double></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] - 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.
  • content -
  • [scalar] - Add new content to the existing document.
Sample return value for writer.viewDocument

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>

<View>
<document_name>test</document_name>
<document_id>6000000057003</document_id>
<version>1.1</version>
<document_name_url>test1</document_name_url>
<author_name>lesterbrown@godaddy.com</author_name>
<created_date>Wed, Sep 27, 2006</created_date>
<document_trashed>false</document_trashed>
<lastmodifiedby>micklewis@excite.com</lastmodifiedby>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<content>
Add some new lines to the existing document
</content>
</View>

</methodResponse>

 

 RSS of this page