General Settings API

This API is used to get the general settings in the time tracker.

Request URL:

https://people.zoho.com/people/api/timetracker/gettimetrackersettings?

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ 

Possible Operation Types:

ALL - Complete access to data
DELETE - Only to delete data

Interpretations:

  • ​TS_manualLog: true - manual time log is allowed.
  • TS_automaticLog: true - timer log is allowed.
  • TS_BillnoAuto: 0 - manual entry for bill number; 1- automatic bill number generation.
  • TS_defaultbillingType: 0 - billable; 1 - non-billable.
  • TS_timerEdit: 0 - anyone can edit timer entries; 1 - only reporting manager can add jobs; 2 - only admin can add jobs.
  • TS_DefaultView: 0 - daily view; 1 - weekly view; 2 - monthly view.
  • TS_jobSchdPublishMailNotify : 0- If 'Email notification for Job schedule' is disabled; 1- If 'Email notification for Job schedule' is enabled.
  • TS_showTimelogLocation : 0-Location display in timelogs is disabled;1-Location display in timelogs is enabled.
  • TS_MinHrsEnabled: 0-Minimum hours criteria is disabled in Timesheet;1-Minimum hours criteria is enabled in timesheet.
  • TS_MinHrsType: 0-If Minimum hours criteria in Timesheet is Enabled with Per Day;1-If Minimum hours criteria in Timesheet is Enabled with Per Week;2-If Minimum hours criteria in Timesheet is Enabled with both Per Day/Week;4-If Minimum hours criteria in Timesheet is disabled.
  • TS_MinHrsPerDay: 0-If 'TS_MinHrsEnabled' is 0; Value in minutes if 'TS_MinHrsType' is 0 or 2.
  • TS_MinHrsPerWeek: 0-If 'TS_MinHrsEnabled' is 0; Value in minutes if 'TS_MinHrsType is 1 or 2.
  • TS_MaxEnabled: 0-Maximum hours criteria is disabled in Timesheet;1-Maximum hours criteria is enabled in timesheet.
  • TS_MaxHrsType: 0-If Maximum hours criteria in Timesheet is Enabled with Per Day;1-If Maximum hours criteria in Timesheet is Enabled with Per Week;2-If Maximum hours criteria in Timesheet is Enabled with both Per Day/Week;4-If Maximum hours criteria in Timesheet is disabled.
  • TS_MaxHrsPerDay: 0-If 'TS_MaxHrsEnabled' is 0; Value in minutes if 'TS_MaxHrsType is 0 or 2.
  • TS_MaxHrsPerWeek: 0-If 'TS_MaxHrsEnabled' is 0; Value in minutes if 'TS_MaxHrsEnabled' is 1 or 2.
  • TS_hideLeaveInJobSchd: 0-If 'Hide in Job Schedule View' has Leave disabled; 1-If 'Hide in Job Schedule View' has Leave enabled.
  • TS_hideWeekEndsInJobSchd: 0-If 'Hide in Job Schedule View' has Weekend disabled; 1-If 'Hide in Job Schedule View' has Weekend enabled.
  • TS_restrict24hrsLogPerDay: 0 - if 'Restrict time logs to 24 hours per day' is disabled, 1 - if 'Restrict time logs to 24 hours per day' is enabled.
  • TS_pastLogRestriction : 0-If Past Date Log restriction is disabled, 1 - if Past Date Log restriction is enabled.
  • TS_pastLogAllowDays: 0 -If Past Date Log restriction for All days, 1 to 365 - if Before X days is enabled. This key will be available only if Past Date Log restriction is enabled (i.e) TS_pastLogRestriction = 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.

Request

Copiedhttps://people.zoho.com/people/api/timetracker/gettimetrackersettings?

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

JsonXML
Copied{ "response": { "message": "Timetracker general settings fetched successfully", "result": { "TS_BillnoPrefix": "ABC", "TS_manualLog": "true", "TS_Schedule": "281496000000151265", "TS_sendMailForJobComplete": "true", "TS_timerEdit": "0", "TS_automaticLog": "true", "TS_hoursLog": "true", "TS_DefaultView": "1", "TS_billingtimesheetType": "2", "TS_clienttimesheetType": "0", "TS_startEndLog": "true", "TS_BillnoAuto": "1", "TS_Billno": "1030", "TS_BillnoStarts": "10003", "TS_defaultbillingType": "1", "TS_timesheetOwners": "0" }, "status": 0, "uri": "/api/timetracker/gettimetrackersettings" } }
Copied<?xml version="1.0" response uri="/api/timetracker/gettimetrackersettings">
<status>0</status>
<message>Timetracker general settings fetched successfully</message>
<result>
<settings>
<TS_BillnoPrefix>ABC</TS_BillnoPrefix>
<TS_manualLog>true</TS_manualLog>
<TS_Schedule>281496000000151265</TS_Schedule>
<TS_sendMailForJobComplete>true</TS_sendMailForJobComplete>
<TS_timerEdit>0</TS_timerEdit>
<TS_automaticLog>true</TS_automaticLog>
<TS_hoursLog>true</TS_hoursLog>
<TS_DefaultView>1</TS_DefaultView>
<TS_billingtimesheetType>2</TS_billingtimesheetType>
<TS_clienttimesheetType>0</TS_clienttimesheetType>
<TS_startEndLog>true</TS_startEndLog>
<TS_BillnoAuto>1</TS_BillnoAuto>
<TS_Billno>1030</TS_Billno>
<TS_BillnoStarts>10003</TS_BillnoStarts>
<TS_defaultbillingType>1</TS_defaultbillingType>
<TS_timesheetOwners>0</TS_timesheetOwners>
</settings>
</result>
</response>