Get Comments for Timer API
This API is used to add comments for the running timer.
Request URL:
https://people.zoho.com/people/api/timetracker/getcomments?timeLogId=<timeLogId>
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Request parameter:
Parameters | Values Allowed | Default Value | Description |
*timeLogId | <timeLogId> | <Mandatory> | Specify the timeLogId |
Error Codes & Messages:
Error Code | Error Message |
8000 | No <param_name> specified |
8001 | Wrong value for <param_name> |
Success Response Format
{
"response": {
"result": [
{
"commentId": < comment id >,
"createdTime": < date(in dd-mm-yyy) , time in( hh:mm:ss 24-hr format) >,
"comment": < comment >
}
],
"message": "Timer Comments fetched successfully",
"uri": "/api/timetracker/getcomments",
"status": 0
}
}
Error Response Format
{
"response": {
"message": "Error in getting comments",
"uri": "/api/timetracker/getcomments",
"errors": [
{
"code": < error code >,
"message": < error message >
}
],
"status": 1
}
}
Threshold Limit: 20 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Sample Request
Copiedhttps://people.zoho.com/people/api/timetracker/getcomments?timeLogId=177402000000936001
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Sample Response
Copied.<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/getcomments">
<status>0</status>
<message>Timer Comments fetched successfully</message>
<result>
<Comment>
<commentId>492688000000821129</commentId>
<createdTime>06-04-2019 , 17:22:28</createdTime>
<comment>Complete security testing</comment>
</Comment>
</result>
</response>
Copied{
"response": {
"result": [
{
"commentId": "492688000000821129",
"createdTime": "06-04-2019 , 17:22:28",
"comment": "Complete security testing"
}
],
"message": "Timer Comments fetched successfully",
"uri": "/api/timetracker/getcomments",
"status": 0
}
}