Get a list of
documents associated with a tag name.
Request URL :
XML : http://export.writer.zoho.com/api/private/xml/documents/tag/[tag-name]?apikey=[API Key]&ticket=[Ticket]
JSON : http://export.writer.zoho.com/api/private/json/documents/tag/[tag-name]?apikey=[API Key]&ticket=[Ticket]
Response fields
The
schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/taggeddocuments.xsd
Field
|
Description
|
documentId
|
Unique ID associated with each document with a
particular tag name.
|
documentName
|
Name of one of the documents associated with a
particular tag name that is being listed.
|
lastModifiedTime
|
[LongValue] - Displays the last modified time
as long integer.
|
lastModifiedBy
|
[string] - Specifies the name of the user of
the user who has last edited the document. If the document is modified by the
owner, then it displays "Me".
|
writePermission
|
[boolean] - Checks whether the access
privileges is read only or read/write for the shared users. If false, then the
shared users can only read the document content.
|
document_locked
|
[boolean] - Checks whether the document has
been locked exclusively for editing in a shared environment. True means the lock
is enabled.
|
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/documents/tag/zoho">
<result>
<documents>
<document>
<documentId>7000000004003</documentId>
<documentName>Welcome</documentName>
<lastModifiedTime>1176118084655</lastModifiedTime>
<lastModifiedBy>Me</lastModifiedBy>
<writePermission>false</writePermission>
<document_locked>false</document_locked>
<created_date>1180532581984</created_date>
</document>
<document>
<documentId>7000000005057</documentId>
<documentName>CheckList</documentName>
<lastModifiedTime>1176118084655</lastModifiedTime>
<lastModifiedBy>Me</lastModifiedBy>
<writePermission>false</writePermission>
<document_locked>false</document_locked>
<created_date>1180532581984</created_date>
</document>
</documents>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/documents",
"result":
{
"documents":
{
"document":
[
{
"documentId":"7000000004003",
"documentName":"Welcome",
"lastModifiedTime":"1176118084655",
"lastModifiedBy":"Me",
"writePermission":"false",
"document_locked":"false",
"created_date":"1180532581984",
},
{
"documentId":"7000000005057",
"documentName":"CheckList",
"lastModifiedTime":"1176118084655",
"lastModifiedBy":"Me",
"writePermission":"false",
"document_locked":"false",
"created_date":"1180532581984",
}
]
}
}
}
}
Errors
Displaying list of public documents method may
return general errors. Likely HTTP error code is 1804.
