Get Time Logs Details API
This API is used to get the details of a specific time log.
Request URL:
https://people.zoho.com/people/api/timetracker/gettimelogdetails?timelogId=<timelogId>
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Scope:
ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ
Possible Operation Types:
ALL - Complete access to data
READ - Only to read data
Request parameter
| Parameters | Values Allowed | Default Value | Description |
| *timelogId | <timelogId> | <Mandatory> | Specify the time log id whose details need to be fetched |
| isTimerDetails | <true|false> | false | Set true to fetch the timer intervals if the time log is of type 2 (timer time log) |
| isCommentsCount | <true|false> | false | Set true to fetch the number of comments/notes added for the timer time log |
Error Codes & Messages:
| Error Code | Error Message |
| 9000 | Permission denied |
| 9002 | No < parameter_name > parameter specified |
| 9003 | Wrong value given for < parameter_name > parameter |
Success Response Format
{
"response": {
"result": [{
"erecno": < employee_erecno >,
"employeeMailId": < emp_mailId >,
"employeeLastName": < emp_lname >,
"employeeFirstName": < emp_fname >,
"timerLog": < true|false >,
"timelogId": < timelog_id >,
"type": <0|1|2>,(0-hours Type ,1-Start&End Type,2-Timer type)
"workDate":< workdate_in_company_dateformat >,
"toTime": < to_time_in_mins >,
"isCurrentlyRunning":< true|false >,
"fromTime": < from_time_in_mins >,
"fromTimeInTimeFormat": < from_time_in_company settings time format >,
"toTimeInTimeFormat": < to_time_in_company settings time format >,
"hours": < hours in HH:MM format >,
"totaltime": < total_time_in_secs >,
"taskName": < work_item >,
"description": < timelog_description >,
"jobId": < job_id >,
"jobName": < job_name >,
"jobIsActive": < true|false >,
"jobIsCompleted": < 0|1 >,(NOTE: 0-in-progress,1-completed)
"clientId": < client_id >,
"projectName": < project_name >,
"projectId":< project_id >,
"billingStatus": < billable|non-billable >,
"isDeleteAllowed": < true|false >,
"isEditAllowed":< true|false >,
"billedStatus": < billed|not billed >,
"approvalStatus": < notsubmitted | draft | pending | approved | rejected >,
"commentsCount": < commentcount >,(NOTE: This key exists only when isCommentsCount is true)
"add_ip":< added_ip_address>,
"mod_ip":< modified_ip_address >,
"isCurrentlyRunning":< true >,(NOTE: This key exists only if the timer is running)
"timearr":[(NOTE: This key exists only when the time log is of timer type)
{
"fromTime": < from_time_in_secs >,
"geoLocation_in":< timer_started_location >,
"geoLocation_out": < timer_stopped_location >,
"toTime": < to_time_in_secs >,
"fromTimeInTimeFormat": < time_in_company settings timeformat >,
"toTimeInTimeFormat": < time_in_company settings timeformat >,
"timerId": < timer_id> ,
"mod_ip": < modified_ip_address >,
"isRunning":< true >(NOTE:key exists only when the timer set is running)
},....
],}
],...
"isNextAvailable": true, (NOTE: This key exists only if there is more data)
"message": "Data fetched successfully",
"uri": "/api/timetracker/gettimelogdetails",
}
Error Response Format
{
"response": {
"message": Error in fetching data,
"uri": "/api/timetracker/gettimelogdetails",
"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
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfSample Response
Copied{
"response": {
"result": [
{
"erecno": "492688000000135005",
"timerLog": false,
"employeeMailId": "c.spalding@zylker.com",
"employeeFirstName": "Christine",
"isDeleteAllowed": true,
"type": "1",
"workDate": "09-04-2019",
"fromTime": 600,
"billedStatus": "not billed",
"fromTimeInTimeFormat": "10:00AM",
"jobIsActive": true,
"toTime": 1080,
"longitude": 80.0493,
"jobName": "Development Phase",
"approvalStatus": "notsubmitted",
"hours": "08:00",
"jobIsCompleted": 0,
"jobBillableStatus": "0",
"isEditAllowed": true,
"billingStatus": "billable",
"jobId": "492688000000808246",
"totaltime": 28800,
"employeeLastName": "Spalding",
"timelogId": "492688000000808270",
"toTimeInTimeFormat": "06:00PM"
}
],
"message": "Data fetched successfully",
"uri": "/api/timetracker/gettimelogdetails",
"status": 0
}
}Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/gettimelogdetails">
<status>0</status>
<message>Data fetched successfully</message>
<result>
<erecno>492688000000135005</erecno>
<timerLog>false</timerLog>
<employeeMailId>c.spalding@zylker.com</employeeMailId>
<employeeFirstName>Christine</employeeFirstName>
<isDeleteAllowed>true</isDeleteAllowed>
<type>1</type>
<workDate>09-04-2019</workDate>
<fromTime>600</fromTime>
<billedStatus>not billed</billedStatus>
<fromTimeInTimeFormat>10:00AM</fromTimeInTimeFormat>
<jobIsActive>true</jobIsActive>
<toTime>1080</toTime>
<jobName>Development Phase</jobName>
<approvalStatus>notsubmitted</approvalStatus>
<hours>08:00</hours>
<jobIsCompleted>0</jobIsCompleted>
<jobBillableStatus>0</jobBillableStatus>
<isEditAllowed>true</isEditAllowed>
<billingStatus>billable</billingStatus>
<jobId>492688000000808246</jobId>
<totaltime>28800</totaltime>
<employeeLastName>Spalding</employeeLastName>
<timelogId>492688000000808270</timelogId>
<toTimeInTimeFormat>06:00PM</toTimeInTimeFormat>
</result>
</response>