Request URL :

XML : http://export.writer.zoho.com/api/private/xml/info/[documentID]?apikey=[API Key]&ticket=[Ticket]

JSON : http://export.writer.zoho.com/api/private/json/info/[documentID]?apikey=[API Key]&ticket=[Ticket]

Response fields

The schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/documents.xsd

Field	Description
documentId	Unique ID associated with the document.
documentName	Name of the document.
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.

Sample Response

The following is the sample response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/info/7000000004003">
<result>
    <document>
        <documentId>7000000004003</documentId>
        <documentName>Resume</documentName>
        <version>1.4</version>
        <document_name_url>Resume</document_name_url>
        <shared_users>[]</shared_Users>
        <document_locked>false</document_locked>
        <document_blogged>false</document_blogged>
        <authorName>Gary</authorName>
        <created_date>1180532581984</created_date>
    </document>
</result>
</response>

Equivalent JSON response

{
"response":
   {
        "uri": "/api/private/json/info/7000000004003",
        "result":
        {
                 "document":
                 {
                        "documentId":"7000000004003",
                        "documentName":"Resume",
                        "version":"1.4",
                        "document_name_url":"Resume",
                        "shared_users":"[]",
                        "document_locked":"false",
                        "document_blogged":"false",
                        "authorName":"Gary",
                        "created_date":"1180532581984"
                 }
       }
    }
}

Errors

Displaying meta-data info of document method may return HTTP error code - 1404.

RSS of this page

Zoho API Guide

ZW - Get complete meta data info about the document