Get Project Details API

This API is used to get the details of a specific project.

Request URL:

https://people.zoho.com/people/api/timetracker/getprojectdetails?projectId=<projectId>

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ 

Possible Operation Types:

ALL- Complete access to data
OR
READ- Only to read data

Request parameter:

ParametersValues AllowedDefault ValueDescription
*projectId< projectId >< Mandatory >Specify the project id of the project of which the details needs to be fetched
isUserCounttrue | falsefalseTo get the number of users assigned to the project
isJobCounttrue | falsefalseTo get the number of jobs mapped to the project
includeDepttrue | falsefalseTo get the departments that are assigned to the project

Error Codes & Messages:

Error CodeError Message
9000Permission denied
9003Wrong value for <parameter_name> parameter
9005Time Tracker Tab is disabled

Success Response Format

{
    "response": {
        "result": [
            {
                "projectName": <Project name>,
                "projectId": <Project ID>,
              "projectCost": <Project cost>,
               "clientId": <Client ID>,
               "clientName": <Client name>,
               "projectStatus": <Project status>,
               "ownerId": <Owner ID>,
               "ownerName": <Owner name>,
               "isDeleteAllowed": <true | false>,
               "jobCount": <Job count>, (NOTE: This key will be available only if 'isJobCount' param is true)
               "projectUsersCount": <User count>, (NOTE: This key will be available only if 'isUserCount' param is true)
               "projectHead": {
                    "empId": <Employee ID>,
                    "erecno": <Erecno>,
                    "rate": <Rate per hour>,
                    "name": <Name>
                },
                "projectManagers": [
                                               {
                                              "empId": <Employee ID>,
                                              "erecno": <Erecno>,
                                               "rate": <Rate per hour>,
                                                "name": <Name>
                                                 },...
                                                 ],
                                                "projectUsers": [
                                                                        {
                                                                        "empId": <Employee ID>,
                                                                         "erecno": <Erecno>,
                                                                         "rate": <Rate per hour>,
                                                                          "name": <Name>
                                                                          },...
                                                                          ],
                                              "projectDepts": [ (NOTE: This will be available only if 'includeDept' param is true)
                                               {
                                               "deptName": <Department name>,
                                               "deptId": <Department ID>
                                                 },...
                ]
            }
        ],
        "message": "Data fetched successfully",
        "uri": "/api/timetracker/getprojectdetails",
        "status": 0
    }
}
​

Error Response Format

{
           "response": {
          "message": "Error in fetching data",
          "uri": "/api/timetracker/getprojectdetails",
          "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/getprojectdetails?authtoken=<authtoken>&projectId=<projectId>

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

JsonXML
Copied{
    "response": {
        "result": [
            {
                "projectName": "Web Designing",
   "projectId": "617735000000229087",
 	   "projectCost": 34590,
                "clientId": "617735000000245001",
                "clientName": "Nicole Kidman",
   "projectStatus": "In-Progress",
                "ownerId": "617735000000189005",
                "ownerName": "Joshua Butler",
   "isDeleteAllowed": true,
                "jobCount": 2,
   "projectUsersCount": 5,
   "projectHead": {
                    "empId": "1",
                    "erecno": "617735000000189005",
                    "rate": 300,
                    "name": "Joshua Butler"
                },
                "projectManagers": [
                    {
                        "empId": "2",
                        "erecno": "617735000000189976",
                        "rate": 200,
                        "name": "Lucy Feroda"
                    },
                    {
                        "empId": "3",
                        "erecno": "617735000000189986",
                        "rate": 200,
                        "name": "Mark Tedson"
                    }
                ],
                "projectUsers": [
                    {
                        "empId": "5",
                        "erecno": "617735000000193006",
                        "rate": 100,
                        "name": "James Taylor"
                    },
                    {
                        "empId": "4",
                        "erecno": "617735000000189996",
                        "rate": 100,
                        "name": Denise Hathway"
                    }
                ],
  "projectDepts": [
                    {
                        "deptName": "Product Management",
                        "deptId": "617735000000245087"
                    },
                    {
                        "deptName": "Human Resources",
                        "deptId": "617735000000245097"
                    }
                ]
            }
        ],
        "message": "Data fetched successfully",
        "uri": "/api/timetracker/getprojectdetails",
        "status": 0
    }
}
Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/getprojectdetails">
    <status>0</status>
    <message>Data fetched successfully</message>
    <result>
        <project>
            <projectName>Web Designing</projectName>
            <projectId>617735000000229087</projectId>
            <projectCost>34590.0</projectCost>
            <clientId>617735000000245001</clientId>
            <clientName>Nicole Kidman</clientName>
            <projectStatus>In-Progress</projectStatus>
            <ownerId>617735000000189005</ownerId>
            <ownerName>Joshua Butler</ownerName>
            <isDeleteAllowed>true</isDeleteAllowed>
            <jobCount>2</jobCount>
            <projectUsersCount>5</projectUsersCount>
            <projectHead>{"empId":"1","erecno":"617735000000189005","rate":300,"name":"Joshua Butler"}</projectHead>
            <projectManagers>[{"empId":"2","erecno":"617735000000189976","rate":200,"name":"Lucy Feroda"},{"empId":"3","erecno":"617735000000189986","rate":200,"name":"Mark Tedson"}]</projectManagers>
            <projectUsers>[{"empId":"5","erecno":"617735000000193006","rate":100,"name":"James Taylor"},{"empId":"4","erecno":"617735000000189996","rate":100,"name":"Denise Hathway"}]</projectUsers>
<projectDepts>[{"deptName":"Product Management","deptId":"617735000000245087"},{"deptName":"Human Resources","deptId":"617735000000245097"}]</projectDepts>
        </project>
    </result>
</response>