Start Timer API

This API is used to start a new timer.

Request URL:

https://people.zoho.com/people/api/timetracker/timer?user=<user>&workDate= <workDate>&jobId=<jobId>&timer=<timer>&workItem= <workItem>&dateFormat=<dateFormat>&billingStatus=<billingStatus>​

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

ParametersValues AllowedDefault ValueDescription
*user< ERECNO | Email-ID | Employee-ID ><Mandatory>Specify the current user's value
*jobId<jobId><Mandatory>Specify jobId for which timer needs to be started
*workDate<date in yyyy-MM-dd/company dateformat><Mandatory>Specify the work date for when timelog needs to be added
dateFormat<dateFormat><company's date format>Specify the date format.
projectId< projectId>allSpecify the project Id based on which timer needs to be started
*billingStatus<billable | non billable | non-billable | nonbillable| all | 0 | 1 | -1><Mandatory>Specify the billable status
*timerstart<Mandatory>Specify value 'start'
description<description>-Specify the description(maximum length is 250)
workItem< workItem>-Specify the workitem (maximum length is 500)

Error Codes & Messages:

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

 

Messages
Error in adding timelog
Cannot log time beyond attendance hours
Logged-in user alone can start timer
Error in adding/modifying Timelog.Logged Hours is greater than maximum billable hours allowed per day
Error in adding/modifying Timelog.Logged Hours is greater than Estimated hours

Success Response Format

{
    "response": {
        "result": [
            {
                "timeLogId": < timelogId >
            }
        ],
        "message": "Timelog entry added Successfully",
        "uri": "/api/timetracker/timer",
        "status": 0
    }
}

Error Response Format

{
    "response": {
        "message": < message >,
        "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?user=charles@zohocorp.com& jobId=492688000000806005&workDate=2019-04-05&timer=start&billingStatus=Billable

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

JsonXML
Copied{
    "response": {
        "result": [
            {
                "timeLogId": "492688000000819009"
            }
        ],
        "message": "Timelog entry added Successfully",
        "uri": "/api/timetracker/timer",
        "status": 0
    }
}
Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/timer">
<status>0</status>
<message>Timelog entry added Succ <?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/timer">
<status>0</status>
<message>Timelog entry added Successfully</message>
<result>
	<timeLogId>4926880000f00819003</timeLogId>
</result>
</response>
  essfully</message>
<result>
	<timeLogId>4926880000f00819003</timeLogId>
</result>
</response>