Zoho Writer > Writer - XML RPC API Methods > getdocumentsbytag - Get the list of documents having similar tag name

getdocumentsbytag - Get the list of documents having similar tag name

Tags:  

writer.tags.getDocuments - Get the list of documents having similar tag name.


Arguments

1. [struct] - required*

Containing Keys:

Field Description
tagname

[scalar] - required* - Tag name associated with the particular document.



Sample call to writer.tags.getDocuments

POST /interface/xmlrpc HTTP/1.0
Host: www.zohowriter.com
Content-Type: text/xml
Content-Length:

<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<methodCall>

<methodName>writer.tags.getDocuments</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>tagname</name>
<value><string>zoho</string></value>
</member>
</struct>
</value>
</param>
</params>
</methodCall>


Response

1. [methodResponse] - required*

Containing Keys:
  • document_name -
  • [scalar] - Name of one of the document currently being tagged.
  • document_id -
  • [scalar] - Unique ID associated with the tagged document.
  • version -
  • [scalar] - Specifies the last saved version of the document.
  • document_name_url -
  • [scalar] - Unique document url to differentiate multiple documents having similar name.
  • author_name -
  • [scalar] - Displays the email ID/username of the document owner.
  • created_date -
  • [date] - Displays the created date of the document. E.g. Thu, Sep 28, 2006.
  • shared_users -
  • [scalar] - Displays the list of email addresses to whom the document has been shared. Shows blank in cases sharing access is disabled.
  • document_locked -
  • [boolean] - Checks whether the document has been locked exclusively for editing in a shared environment. True means the lock is enabled.
  • document_blogged -
  • [boolean] - 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 service.
  • category - 
  • [scalar] - Displays the category of the document as Owned.
  • info - 
  • [scalar] - Displays information whether the document with similar tag name is successfully listed or not.
Sample return value for writer.tags.getDocuments

HTTP/1.1 200 OK
Connection: close
Content-Length:
Content-Type: text/xml
Date: Wed 01 Nov 2006 23:45:59 GMT
Server: Apache/1.3.4 (Unix)

<methodResponse>

<tagname>zoho</tagname>

<document>
<document_name>test</document_name>
<document_id>6000000057003</document_id>
<version>1.0</version>
<document_name_url>test1</document_name_url>
<author_name>bridget</author_name>
<created_date>Wed, Nov01, 2006</created_date>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<category>OWNED</category>
<info>The documents with similar tag name is successfully listed</info>
</document>

<document>
<document_name>Zoho Writer Docs</document_name>
<document_id>6000000057991</document_id>
<version>1.0</version>
<document_name_url>ZWDocs</document_name_url>
<author_name>drew</author_name>
<created_date>Wed, Nov01, 2006</created_date>
<shared_users>[]</shared_users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<category>OWNED</category>
<info>The documents with similar tag name is successfully listed</info>
</document>


</methodResponse>

 

 RSS of this page