Get list of
tags associated with a particular user. The list will be sorted by tag
count
Request URL :
XML : http://export.writer.zoho.com/api/private/xml/tags?apikey=[API Key]&ticket=[Ticket]
JSON : http://export.writer.zoho.com/api/private/json/tags?apikey=[API Key]&ticket=[Ticket]
Request parameters
Field
|
Description
|
start-from [optional]
|
[integer] - Sets the lower bound number from
which the tags will be listed. If there are 10 tags and start-from value is set
to 3, then the tags will be listed from the 3rd tag onwards.
|
limit [optional]
|
[integer] - Sets the number of tags to be
listed. If the limit value is set to 5 then the number of tags listed is
5.
|
| sort-order [optional] |
[string - (asc | desc)] - Obtain the result in
ascending or descending order. Default sorting order is
'descending'.
|
Response fields
The
schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/tags.xsd
Field
|
Description
|
tags
|
List of tag names associated with a particular
user.
|
Sample Response
The
following is the sample response for the above method:
<?xml version="1.0"
encoding="UTF-8" ?>
<response uri="/api/private/xml/tags">
<result>
<tags>
<tag name="Invoice"
count="4"/>
<tag name="Inventory"
count="2"
/>
<tag name="PO" count="1" />
<tag name="SO" count="1" />
</tags>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/tags",
"result":
{
"tags":
{
"tag":
[
{"name":"Invoice", "count":4},
{"name":"Inventory", "count":2},
{"name":"PO", "count":1},
{"name":"SO", "count":1}
]
}
}
}
}
Errors
Displaying list of tags associated with a user
method may return general errors. Likely HTTP error code is 1404.
