API Home >> Sheet >> API Reference >> books

To restore a particular workbook from trash.

 
Request URL : POST

                                XML : http://sheet.zoho.com/api/private/xml/restorebook/[BookID]?apikey=[API Key]&ticket=[Ticket]

                                JSON : http://sheet.zoho.com/api/private/xml/restorebook/[BookID]?apikey=[API Key]&ticket=[Ticket]


Request parameters

To restore a workbook from trash we need to submit a form data as mentioned below:

Sample Form (POST Method)

<form method="POST"    action="http://sheet.zoho.com/api/private/xml/restorebook/15265000000006067?apikey=[APIKEY]&ticket=[Ticket]">

<input type="submit" value="RestoreBook" class="divbutton" name="submit">

</form>

Response fields

Field	Description
workbookId	Unique ID associated with the workbook that is being restored from trash.
workbookName	Name of the workbook being restored.
updateLock	Advisory lock for update operation.

Sample Response

The following is the sample response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/restorebook/15265000000006067">
  <result>

     <workbookId>15265000000006067</workbookId>
        <workbookName>TempConverter</workbookName>
     <updateLock>1171956839391</updateLock>

  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/private/json/restorebook/15265000000006067",
        "result":
        {   
            "workbookId":"15265000000006067",
            "workbookName":"TempConverter",
            "updateLock":"1171956839391"
        }
    }
}  

Errors

Restoring a workbook from trash method may return general errors. Other specific HTTP error codes include 2851 & 2853.