Get a list of
documents that's been made public by the user.
Request URL :
XML : http://export.writer.zoho.com/api/private/xml/publicdocuments?apikey=[API Key]&ticket=[Ticket]
JSON : http://export.writer.zoho.com/api/private/json/publicdocuments?apikey=[API Key]&ticket=[Ticket]
Request parameters
Field
|
Description
|
start-from [optional]
|
[integer] - Sets the initial document number
from which the documents in the public folder will be listed. It should always
be a positive integer. If there are 10 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 public
documents to be listed. Allowed values for this parameter is from 1 to 100. If
the number of document is less than the limit value then all documents are
listed.
|
Response fields
The
schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/publicdocuments.xsd
Field
|
Description
|
documentId
|
Unique ID associated with each public document
in the list.
|
documentName
|
Name of one of the public 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. |
shared_users
|
Displays the list of email addresses to whom
the document has been shared. Shows blank in case sharing access is
disabled. |
document_locked
|
Checks whether the document has been locked
exclusively for editing in a shared environment. True means the lock is
enabled. |
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/publicdocuments">
<result>
<publicdocuments>
<document>
<documentId>6000000004003</documentId>
<documentName>Welcome</documentName>
<version>1.4</version>
<document_name_url>Welcome</document_name_url>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<authorName>Mary</authorName>
<created_date>1180532581984</created_date>
<category>OWNED</category>
</document>
<document>
<documentId>6000000005057</documentId>
<documentName>CheckList</documentName>
<version>1.1</version>
<document_name_url>CheckList</document_name_url>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<authorName>Mary</authorName>
<created_date>1180532581984</created_date>
<category>OWNED</category>
</document>
</publicdocuments>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/publicdocuments",
"result":
{
"publicdocuments":
{
"document":
[
{
"documentId":"6000000004003",
"documentName":"Welcome",
"version":"1.4",
"document_name_url":"Welcome",
"shared_users":"[]",
"document_locked":"false",
"document_blogged":"false",
"authorName":"Mary",
"created_date":"1180532581984",
"category":"owned",
},
{
"documentId":"6000000005057",
"documentName":"CheckList",
"version":"1.1",
"shared_users":"[]",
"document_name_url":"CheckList",
"document_locked":"false",
"document_blogged":"false",
"authorName":"Mary",
"created_date":"1180532581984",
"category":"owned",
}
]
}
}
}
}
Errors
Displaying list of public documents method may
return general & input errors. Likely HTTP error code is
1416.
