Get Job Schedule API

This API is used to get the list of job schedules of employees.

Request URL:

https://people.zoho.com/api/timetracker/getJobSchedule?user=<user>&fromDate=<fromDate>&toDate=<toDate>&sIndex=<sIndex>&limit=<limit>

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
user	<ERECNO \| Email-ID \| Employee-ID \| all>	<currentUser>	Specify the user whose job schedule needs to be fetched
sIndex	<sIndex>	0	Specify from which record the response should be fetched
limit	<limit>	200	Specify the number of records to be fetched. Maximum value is 200
*fromDate	<from date in yyyy-MM-dd/company date format>	<Mandatory>	Specify the date from which the job schedule list needs to be fetched
*toDate	<to date in yyyy-MM-dd/company date format>	<Mandatory>	Specify the date till which the job schedule list needs to be fetched

Error Codes and Messages :

Error Code	Error Message
9000	Permission denied
9002	No <parameter_name> parameter specified
9004	Wrong date format given for <parameter_name> parameter

Success Response Format

{
"response": {
"result": {
"usersList": [
{
"empId": < Employee_id>,
"empName": < Employee_name>,
"empErecno": < Employee_erecno>,
"jobschArr": [
{
"date": < Schedule_date>,
"owner": < Owner_erecno>,
"jobName": < jobname>,
"jobId": < jobid>,
"fromtime_mins": < from time in mins>,
"totime_mins": < to time in mins>,
"color": < color_code(0-15)>,
"isPublished": < true|false>,
"description": < desc>,
"tschId": < job_schedule_id>,
"projectId": < project_id>,
"assignedTo": < assignee_erecno>
"repeatInt":< 1-12 >(NOTE: It denotes the interval in which the job schedule is repeated. This key exists only when the job schedule is in the repeat series.)
"repeatId":< repeat id>(NOTE: This key exists only when the job schedule is in the repeat series)
"repeatUntil":< repeat until date yyyy-mm-dd >(NOTE: It denotes the date until when the job schedule is repeated. This key exists only when the job schedule is in the repeat series.)
"repeatType":<0-2>(NOTE: It denotes how often the schedule is repeated (0- daily | 1- weekly | 2- monthly). This key exists only when the job schedule is in the repeat series.)
},...
]
}
],
"unpubcount": < unpublished_schedule_count>
},
"message": "Data fetched successfully",
"uri": "/api/timetracker/getJobSchedule",
"isNextAvailable": true, (NOTE: This key will not be available if there is no more data)
"status": 0
}
}

Error Response Format

{
"response": {
"message": Error in fetching data,
"uri": "/api/timetracker/getJobSchedule",
"errors": [
{
"code": <Error Code>,
"message": <Error Message>
}
],
"status": 1
}
}

Threshold Limit: 50 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/api/timetracker/getJobSchedule ?sIndex=0&limit=25&user=EID123&fromDate=2019-06-01&toDate=2019-06-30

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

Json XML

Copied{
    "response": {
        "result": {
            "usersList": [
                {
                    "empId": "1",
                    "empName": "Admin Joker",
                   "empErecno": "543031000000149005",
                    "jobschArr": [
                        {
                            "date": "2019-07-04 00:00:00.0",
                            "owner": "28000000189001",
                            "jobName": "CheckingPastPublishSeries",
                            "repeatId": "28000000201253",
                            "fromtime_mins": 732,
                            "color": "0",
                            "repeatInt": "1",
                            "isPublished": false,
                            "isException": false,
                            "repeatType": "0",
                            "description": "",
                            "tschId": "28000000201249",
                            "repeatUntil": "2019-07-09",
                            "assignedTo": "28000000189001",
                            "jobId": "28000000201237",
                            "totime_mins": 792,
                            "projectId": "28000000201239"
                        }
                    ],
                }
            ],
            "unpubcount": 0
        },
        "message": "Data fetched successfully",
        "uri": "/api/timetracker/getJobSchedule",
        "isNextAvailable": true,
        "status": 0
    }
}

Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/getJobSchedule">
    <status>0</status>
    <message>Data fetched successfully</message>
    <isNextAvailable>true</isNextAvailable>
    <result>
       <usersList>
            <empId>EID123</empId>
            <empName>Jeppiar J</empName>
            <empErecno>2801234000189001</empErecno>
            <jobschArr>
                 [{"2019-07-06": 
                        { "date": 2019-07-04 00:00:00.0,
                           "owner": 28000000189001,
                           "jobName": "CheckingPastPublishSeries",
                           "repeatId": "28000000201253",
                           "fromtime_mins": 732,
                           "color": "0",
                           "repeatInt": "1",
                           "isPublished": false,
                           "repeatType": "0",
                           "description": "", 
                           "tschId": "28000000201249",
                           "repeatUntil": "2019-07-09",
                           "assignedTo": "28000000189001",
                           "jobId": "28000000201237",
                           "totime_mins": 792,
                           "projectId": "28000000201239" }}]
            </jobschArr>
      </usersList>
      <unpubcount> 0 </unpubcount>
   </result>
</response>