Zoho Writer > Writer - REST API Methods > ZW - Remove tag associated with a document

ZW - Remove tag associated with a document

Tags:  



To remove a tag from a particular document.



Request URL POST Method

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

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

Request parameters :

To remove a tag from a particular document we need to submit a form data to Writer with the following fields:

Field
Description
documentId
Unique ID of the document for which tag is to be removed.
tag
[string] - Removing a tag associated with this document.


Sample Form (POST Method)


<form method="POST"    action="http://export.writer.zoho.com/api/private/xml/removeTag/[documentId]?apikey=[APIKEY]&ticket=[Ticket]">

<input type="hidden" name="tagname" value="[tag]">

<input type="submit" value="removeTag" class="divbutton" name="submit">

</form>



* It is mandatory to pass the apikey and ticket parameters to access the removeTag api.


Response fields

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

Field
Description
documentId
Unique ID associated with the document.
tag
Name of a tag that is being removed from the document.


Sample Response

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


<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/removeTag/8892000000064009">
  <result>

     <documentId>
8892000000064009</documentId>
        <tag>
        <tag name="search" /> 
     </tag>

  </result>
</response>


Equivalent JSON response


{
  "response":
   {
        "uri": "/api/private/json/removeTag/8892000000064009",
        "result":
        {
           "documentId":"8892000000064009",
           "tag":
                 {

                    "name":"search"
                 }
        }
    }
}  


Errors

Removing a tag from a document method may return general errors. Other HTTP error code may be 1404.
 


 RSS of this page