Get a list of
trashed documents.
Request URL :
XML : http://export.writer.zoho.com/api/private/xml/trasheddocuments?apikey=[API Key]&ticket=[Ticket]
JSON : http://export.writer.zoho.com/api/private/json/trasheddocuments?apikey=[API Key]&ticket=[Ticket]
Request parameters
Field
|
Description
|
start-from [optional]
|
[integer] - Sets the initial document number
from which the trashed documents will be listed. It should always be a positive
integer. If there are 10 shared documents and start-from value is set to 3, then
the documents will be listed from the 3rd document.
|
limit [optional]
|
[integer] -Sets the number of trashed
documents to be listed. Allowed values for this parameter is from 1 to 100. If
the number of trashed document is less than the limit value then all the trashed
documents are listed.
|
Response fields
The
schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/trasheddocuments.xsd
Field
|
Description
|
documentId
|
Unique ID associated with each trash document
in the list.
|
documentName
|
Name of one of the trashed documents that is
being listed.
|
version
|
Specifies the last saved version of the
document |
document_name_url
|
Unique document url to differentiate multiple
documents having similar name. |
document_blogged
|
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 services. |
author_name
|
Displays the Email ID/Zoho ID of the document
owner, i.e., the account from which the document is created. |
created_date
|
Displays the created date of the document.
E.g. 1180532581984.
|
category
|
Displays the category of the document, whether
'OWNED' or 'SHARED'
|
Sample Response
The
following is the sample response for the above method:
<?xml version="1.0"
encoding="UTF-8" ?>
<response uri="/api/private/xml/trasheddocuments">
<result>
<trasheddocuments>
<document>
<documentId>9000000003013</documentId>
<documentName>test</documentName>
<version>1.6</version>
<document_name_url>test</document_name_url>
<document_blogged>false</document_blogged>
<authorName>John</authorName>
<created_date>1180532581984</created_date>
<category>owned</category>
</document>
<document>
<documentId>9000000007797</documentId>
<documentName>Logs</documentName>
<version>1.9</version>
<document_name_url>Logs</document_name_url>
<document_blogged>false</document_blogged>
<authorName>John</authorName>
<created_date>1180532581984</created_date>
<category>owned</category>
</document>
</trasheddocuments>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/trasheddocuments",
"result":
{
"trasheddocuments":
{
"document":
[
{
"documentId":"9000000003013",
"documentName":"test",
"version":"1.6",
"document_name_url":"test",
"document_blogged":"false",
"authorName":"John",
"created_date":"1180532581984",
"category":"owned",
},
{
"documentId":"9000000007797",
"documentName":"Logs",
"version":"1.9",
"document_name_url":"Logs",
"document_blogged":"false",
"authorName":"John",
"created_date":"1180532581984",
"category":"owned",
}
]
}
}
}
}
Errors
Displaying list of trashed documents method may return general errors. Other HTTP error code is 1806.
