Getting job details using API | Timesheet

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.

Sample Request

Copiedhttps://people.zoho.com/people/api/timetracker/getjobdetails?jobId=469505000000268001&dateFormat=dd-MMM-yyyy&includeDept=true

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

Json XML

Copied{
    "response": {
        "result": [
            {
                "jobName": "System Performance Analysis",
                "owner": "469505000000133005",
                "jobStatus": "In-Progress",
                "hours": "57:00",
                "assignedBy": "Eliza Madison",
                "clientId": "469505000000133417",
                "clientName": "Adamo Meyrick",
                "toDate": "12-Apr-2019",
                "jobDepts": [
                    {
                        "deptName": "HR",
                        "deptId": "469505000000133001"
                    }
                ],
                "description": "To analyse the system performance",
                "assignees": [
                    {
                        "hours": "07:00",
                        "erecno": "469505000000133005",
                        "rate": 100,
                        "name": "Eliza Madison",
                        "totalhours": "12:00"
                    },
                    {
                        "hours": "50:00",
                        "erecno": "469505000000133275",
                        "rate": 70,
                        "name": "Patrick Dohnman",
                        "totalhours": "40:00"
                    }
                ],
                "jobBillableStatus": "Non-Billable",
                "isDeleteAllowed": true,
                "fromDate": "05-Apr-2019",
                "jobId": "469505000000268001",
                "ratePerHour": 0,
                "totalhours": "52:00",
                "projectName": "Analysis",
                "projectId": "469505000000267333"
            }
        ],
        "message": "Data fetched successfully",
        "uri": "/api/timetracker/getjobdetails",
        "status": 0
    }
}

Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/getjobdetails">
    <status>0</status>
    <message>Data fetched successfully</message>
    <result>
        <job>
            <jobName>System Performance Analysis</jobName>
            <owner>469505000000133005</owner>
            <jobStatus>In-Progress</jobStatus>
            <hours>57:00</hours>
            <assignedBy>Eliza Madison</assignedBy>
            <clientId>469505000000133417</clientId>
            <clientName>Adamo Meyrick</clientName>
            <toDate>12-Apr-2019</toDate>
            <jobDepts>[{"deptName":"HR","deptId":"469505000000133001"}]</jobDepts>
            <description>To analyse the system performance</description>
            <assignees>[{"hours":"07:00","erecno":"469505000000133005","rate":100,"name":"Eliza Madison","totalhours":"12:00"},{"hours":"50:00","erecno":"469505000000133275","rate":70,"name":"Patrick Dohnman","totalhours":"40:00"}]</assignees>
            <jobBillableStatus>Non-Billable</jobBillableStatus>
            <isDeleteAllowed>true</isDeleteAllowed>
            <fromDate>05-Apr-2019</fromDate>
            <jobId>469505000000268001</jobId>
            <ratePerHour>0.0</ratePerHour>
            <totalhours>52:00</totalhours>
            <projectName>Analysis</projectName>
            <projectId>469505000000267333</projectId>
        </job>
    </result>
</response>