Get a list of
trashed workbooks.
Request URL :
XML :
http://sheet.zoho.com/api/private/xml/trashedbooks?apikey=[API Key]&ticket=[Ticket]
JSON :
http://sheet.zoho.com/api/private/json/trashedbooks?apikey=[API Key]&ticket=[Ticket]
Request parameters
Field
|
Description
|
start-from [optional]
|
[integer] - Sets the initial workbook number
from which the workbooks will be listed. If there are 10 workbooks and
start-from value is set to 3, then the workbooks will be listed from the 3rd
workbook.
|
limit [optional]
|
[integer] - Sets the number of workbooks to be
listed. If the limit value is set to 5 then the number of workbooks listed is
5.
|
| order-by [optional] |
[string - (createdTime | lastModifiedTime |
name)] - Order workbooks by createdTime, lastModifiedTime & workbook
name.
|
sort-order [optional]
|
[string - (asc | desc)] - Arrange the
workbooks in ascending or descending order. Default sorting is done in
descending order.
|
Response fields
The
schema document for the API response is located at: http://sheet.zoho.com/schema/trashedbooks.xsd
Field
|
Description
|
workbookId
|
Unique ID associated with each workbook in the
list.
|
workbookName
|
Name of one of the workbooks that is being
listed.
|
createdTime
|
Number of milliseconds between the workbook
created time and midnight, January 1, 1970 UTC.
|
| lastModifiedTime |
Number of milliseconds between the last
modified time and midnight, January 1, 1970 UTC.
|
lastModifiedBy
|
Specifies the Email ID of the person who has
last edited the workbook. In case the workbook 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. |
Sample Response
The
following is the sample response for the above method:
<?xml
version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/trashedbooks">
<result>
<trashedWorkbooks>
<trashedWorkbook>
<workbookId>15365000000004003</workbookId>
<workbookName>WeatherForecast</workbookName>
<createdTime>1172137033182</createdTime>
<lastModifiedTime>1180593219644</lastModifiedTime>
<lastModifiedBy>tt2</lastModifiedBy>
</trashedWorkbook>
<trashedWorkbook>
<workbookId>15267000000002011</workbookId>
<workbookName>OperationsResearch</workbookName>
<createdTime>1174374756812</createdTime>
<lastModifiedTime>1175593219644</lastModifiedTime>
<lastModifiedBy>tt2</lastModifiedBy>
</trashedWorkbook>
</trashedWorkbooks>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/trashedbooks",
"result":
{
"trashedWorkbooks":
{
"trashedWorkbook":
[
{
"workbookId":"15365000000004003",
"workbookName":"WeatherForecast",
"createdTime":1172137033182,
"lastModifiedTime":1180593219644,
"lastModifiedBy":"tt2"
},
{
"workbookId":"15267000000002011",
"workbookName":"OperationsResearch",
"createdTime":1174374756812,
"lastModifiedTime":1175593219644,
"lastModifiedBy":"tt2"
}
]
}
}
}
}
Errors
Displaying list of trashed workbooks method may
return general & input errors.
