Add Comments for Timer API

This API is used to add comments for the running timer.

Request URL:

https://people/api/timetracker/addcomment?timeLogId=<timelogId>&comment=<comment>

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ 

Possible Operation Types:

ALL - Complete access to data
DELETE - Only to delete data

Request parameter:

ParametersValues AllowedDefault ValueDescription
*timeLogId<timeLogId><Mandatory>Specify the timeLogId
*comment<comment><Mandatory>Specify the comment

Error Codes & Messages:

Error CodeError Message
8000No <param_name> specified
8001Wrong value for <param_name>
8005Comments can be added only when the timer is running

Success Response Format

{
    "response": {
        "result": [
            {
                "commentId": < commentId >
            }
        ],
        "message": "Timer Comment Added successfully",
        "uri": "/api/timetracker/addcomment",
        "status": 0
    }
}

Error Response Format

{
    "response": {
        "message": "Error in adding comments",
        "uri": "/api/timetracker/addcomment",
        "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/addcomment?timeLogId=293141000000147001&comment=Complete security testing

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

JsonXML
Copied{
    "response": {
        "result": [
            {
                "commentId": "492688000000822001"
            }
        ],
        "message": "Timer Comment Added successfully",
        "uri": "/api/timetracker/addcomment",
        "status": 0
    }
}
Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/addcomment">
<status>0</status>
<message>Timer Comment Added successfully</message>
<result>
   <commentId>492688000000822001</commentId>
</result>
</response>