Pause/Resume Timer API

This API is used to resume/pause an existing timer.

Request URL:

https://people.zoho.com/people/api/timetracker/timer?timeLogId=<timeLogId>&timer=<timer>​

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Request parameter:

ParametersValues AllowedDefault ValueDescription
*timeLogId< timeLogId ><Mandatory>Specify the timelog id
*timer<start/stop><Mandatory>Specify the start to resume the timer or stop to pause the timer of the timelog

Error Codes & Messages:

Error CodeError Message
8000No parameter specified
8001Wrong value for parameter
8005Timer is disabled in Settings. Contact your Administrator
8008Cannot log time during Weekend/Holidays/Leave

 

Messages
Error in pausing the timer
Error in restarting the timer
Cannot log time beyond attendance hours
Error in starting timer.Logged-in user alone can start timer
Error in pausing timer.Logged-in user alone can start timer
Error in restarting the Timer.Logged Hours is greater than maximum billable hours allowed per day
Error in pausing the Timer.Logged Hours is greater than maximum billable hours allowed per day
Error in restarting the Timer.Logged Hours is greater than Estimated hours
Error in pausing the Timer.Logged Hours is greater than Estimated hours

Success Response Format

{
    "response": {
        "message": "Timer Paused successfully",
        "uri": "/api/timetracker/timer",
        "status": 0
    }
}
Timer Resume:

{
    "response": {
        "message": "Timer resumed successfully",
        "uri": "/api/timetracker/timer",
        "status": 0
    }
}

Error Response Format

{
    "response": {
        "message": < message >,(NOTE: refer the table below)
        "uri": "/api/timetracker/timer",
        "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/timer?

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

XMLJson
Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/timer">
<status>0</status>
<message>Timer Paused successfully</message>
</response>
Copied{
    "response": {
        "message": "Timer Paused successfully",
        "uri": "/api/timetracker/timer",
        "status": 0
    }
}