Get Job Details API
This API is used to get the job details.
Request URL:
https://people.zoho.com/people/api/timetracker/getjobdetails?jobId=<jobId>&dateFormat=<dateFormat>&includeDept=<includeDept>
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:
Parameter | Values Allowed | Default Value | Description |
*jobId | <jobId> | <Mandatory> | Specify the job Id |
dateFormat | <dateFormat> | <Company date format> | Specify the date format |
includeDept | true | false | false | To fetch the departments that are assigned to the jobs |
Error Codes and Messages :
Error Code | Error Message |
9000 | Permission denied |
9002 | No <parameter name> parameter specified |
9003 | Wrong value given for <parameter name> parameter |
9005 | Timetracker tab is disabled |
Success Response Format
{
"response": {
"result": [
{
"jobId": <Job Id>,
"jobName": <Job name>,
"projectId": <Project Id>
"projectName": <Project name>,
"clientId": <Client Id>,
"clientName": <Client name>,
"fromDate": <Start date>,
"toDate": <End date>,
"description": <Description>,
"jobBillableStatus": <Billable | Non-Billable>,
"ratePerHour": <Rate per hour>,
"jobStatus": <In-Progress | Completed>,
"hours": <Estimated hours in HH:mm>,
"totalhours": <Total hours logged for the job in HH:mm>,
"owner": <Owner Id>,
"assignedBy": <Owner name>,
"isDeleteAllowed": <true | false>,
"jobDepts": [ (NOTE : this key will be available only if the "includeDept" parameter is set as true in the request)
{
"deptName": <Department name>,
"deptId": <Department Id>
}
],
"assignees": [
{
"hours": <Estimated hours in HH:mm>,
"erecno": <Erec no>,
"rate": <Assignee rate per hour>,
"name": <Name>,
"totalhours": <Hours logged by the assignee in HH:mm>
},
]
}
],
"message": "Data fetched successfully",
"uri": "/api/timetracker/getjobdetails",
"status": 0
}
}
Error Response Format
{
"response": {
"message": "Error in fetching data",
"uri": "/api/timetracker/getjobdetails",
"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.