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

Get a list of workbooks made public by the user.

Request URL :

XML : http://sheet.zoho.com/api/public/xml/books/user/[user name]?apikey=[API Key]

JSON : http://sheet.zoho.com/api/public/json/books/user/[user name]?apikey=[API Key]

Request parameters

Field	Description
start-from [optional]	[integer] - Sets the initial workbook number from which workbooks that is made public by a user will be listed. If there are 10 publlc 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 workbooks that is made public by the user listed is 5.

Response fields

Field	Description
workbookId	Unique ID associated with each workbook that is being made public by the user.
workbookName	Name of one of the public workbooks that is being listed.
authorName	Displays the name of the author of the public workbook.
permaLink	Displays the link of the public workbook.
embedLink	Displays the link that can be used for embedding this workbook in other web pages.

Sample Response

The following is the sample XML response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/public/xml/books/user/rameshs">
<result>
    <publicWorkbooks>
      <publicWorkbook>
        <workbookId>6001000000002031</workbookId>
        <workbookName>Canon Powershot A610</workbookName>
        <authorName>rameshs</authorName>
        <permaLink>
<![CDATA[http://zohosheet/public.do?docurl=Canon+Powershot+A610&name=ER4OKJyDUI4%3D]]>
        </permaLink>
        <embedLink>
<![CDATA[http://zohosheet/publish.do?docurl=Canon+Powershot+A610&name=ER4OKJyDUI4%3D]]>
        </embedLink>
        </publicWorkbook>
      <publicWorkbook>
        <workbookId>6001000000002037</workbookId>
        <workbookName>Kodai Expenses</workbookName>
        <authorName>rameshs</authorName>
        <permaLink>
<![CDATA[http://zohosheet/public.do?docurl=Kodai+Expenses&name=dS0EmjVtfwQ%3D]]>
        </permaLink>
        <embdeLink>
<![CDATA[http://zohosheet/publish.do?docurl=Kodai+Expenses&name=dS0EmjVtfwQ%3D]]>
        </embedLink>
      </publicWorkbook>
    </publicWorkbooks>
</result>
</response>

Equivalent JSON response

{
"response":
   {
        "uri": "/api/public/json/books/user/rameshs",
        "result":
        {
           "publicWorkbooks":
            {
                "publicWorkbook":
                [
                    {
                        "workbookId":"6001000000002031",
                        "workbookName":"Canon Powershot A610",
                        "authorName":"rameshs",
                        "permaLink": "<![CDATA[http://zohosheet/public.do?docurl=Canon+Powershot+A610&name=ER4OKJyDUI4%3D]]>",
                        "embedLink": "<![CDATA[http://zohosheet/publish.do?docurl=Canon+Powershot+A610&name=ER4OKJyDUI4%3D]]>",
                     },
                     {
                        "workbookId":"3786000000002011",
                        "workbookName":"Kodai Expenses",
                        "authorName":"rameshs",
                        "permaLink": "<![CDATA[http://zohosheet/public.do?docurl=Kodai+Expenses&name=dS0EmjVtfwQ%3D]]>",
                        "embedLink": "<![CDATA[http://zohosheet/publish.do?docurl=Kodai+Expenses&name=dS0EmjVtfwQ%3D]]>"
                     }
                ]
            }
       }
    }
}

Errors

Displaying list of workbooks made public by a user method may return general & input errors.