Zoho - Trademark Blogs   Forums   Contact Us   Writer Home   Toll Free : 888 900 9646
API METHOD - (< Back)

writer.deleteDocument - Used to permenantly delete a document.


Arguments


1. [struct] - required*

Containing Keys:

Field Description
documentid

[scalar] - required* - Unique ID of the document to be deleted.



Sample call to writer.deleteDocument

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.deleteDocument</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>documentid</name>
<value><long>5000000006009</long></value>
</member>
</struct>
</value>
</param>
</params>

</methodCall>


Response

1. [methodResponse] - required*


Containing Keys:
  • [scalar] - Name of one of the document currently being trashed.
  • [scalar] - required* - Unique ID associated with the trashed document.
  • [scalar] - required* - Specifies the last saved version of the document.
  • [scalar] - required* - Unique document url to differentiate multiple documents having similar name.
  • [scalar] - Displays the email ID/username of the document owner.
  • [date] - Displays the created date of the document. E.g. Thu, Sep 28, 2006.
  • [scalar] - Displays the list of email addresses to whom the document has been shared. Shows blank in cases sharing access is disabled.
  • [boolean] - Checks whether the document has been locked exclusively for editing in a shared environment. True means the lock is enabled.
  • [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.
  • [scalar] - Displays the category of the document as Owned.
  • [scalar] - required* - Displays information whether the document is successfully trashed or not.


Sample return value for writer.deleteDocument

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>

<Delete>
<document_name>test</document_name>
<document_id>6000000057003</document_id>
<version>1.0</version>
<document_name_url>test1</document_name_url>
<author_name>bridget</author_name>
<created_date>Wed, Nov01, 2006</created_date>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<category>OWNED</category>
<info>The document is successfully deleted</info>
</Delete>

</methodResponse>