Time Tracking Software API (deprecated version below)

Timesheet Mobile’s Time Tracking Software API is a REST based set of endpoints designed to be easily accessed and used to integrate third party applications to exchange employee, customer, task, and timesheet data.

 

Login_check API Parameters- Authenticates admin username and password and returns API_KEY.  KEY is to be used in all subsequent API calls.

 

Request Parameters Description Example
username *   Username of the admin. username1
password *   Password of the corresponding username password

Optional outputs:

Request Parameters Description Example
output optional output type can be requested for all the APIs.
Supported outputs are 'xml' and 'json'. 'json' will be the default output.
https://admin.timesheetmobile.com/TBA/APIs/login_check.php?username=TBA&password=TBA1&output=xml

Login_check examples:

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/login_check.php?username=TBA&password=TBA1

Response:

{
	“status”: “success”,
	“message”: “success”,
	“API_KEY”: “fZjT32U5dnxkAwG3”
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/login_check.php?username=TBA&password=

Response:

{
	“status”: “fail”,
	“message”: “’password’ parameter is missing”,
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/login_check.php?username=&password=TBA1

Response:

{
	“status”: “fail”,
	“message”: “’username’ parameter is missing”,
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/login_check.php?username=TBA&password=TBA1

Response:

{
	“status”: “fail”,
	“message”: ” Your not admin”,
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/login_check.php?username=TBA&password=TBA1

Response:

{
	“status”: “fail”,
	“message”: ” Invalid Username or Password”,
}


Timesheet Report API Parameters

 

Request Parameters Description          Syntax Example
from_date *   From which date you want to start the report Accepted Date Format mm/dd/yyyy 01/03/2015
to_date *   To which date you want to run the report Accepted Date Format

mm/dd/yyyy

10/25/2015
key * Unique string given when admin login API key from login API AZG3B3WEJ0EZWGL5
employees

 

Number of the corresponding employee Employee Number

If no employee number given report for all employees will be generated

 

Default: All

32
 jobs

 

Number of the corresponding

job

Job Number if report required for single job

 

Default: All

21
rounding_time Accepted values
off
15
30Default : Set by Admin
15
time_format In what way you want display the time format Accepted values:

hh:mm

decimal

 

Default: Set by Admin

hh:mm
report_type Report type is for to split the records based on the report_type option Accepted values:

actual

day_started

day_ended

 

Default: Set by Admin

Actual

dayended

report_data_type Report data type is the category of report (Unapproved, Approved,both) which is to be recieved as response. Accepted values:

unapproved (Default)

approved

both

unapproved

checklist Checklist parameter includes the checklist items along with the logs which were checked at the time of punch-out. Only items checked will be recieved. Items which were unchecked will not be recieved in the API. Accepted values:

yes

no

yes

* Required Fields and remaining fields are optional and case insensitive.

Note:  For employees and jobs parameters if you enter valid employee number it gives corresponding data or if you enter “all” or any other thing then it gives all employees data

Timesheet Report Examples:

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=08/01/2018&to_date=08/09/2018

Response:

{
  "status": "success",
  "message": "success",
  "log_count": 312,
  "logs": [
    {
      "employee_number": "400",
      "employee_name": "Jane Smith ",
      "date_time_in": "02-08-2018 11:56:34",
      "date_time_out": "02-08-2018 12:09:52",
      "workgroup_number": ["6"],
      "workgroup_name": ["android"],
      "job_number": "200",
      "job_name": "Bailey House",
      "service_item": "",
      "task_no": "0",
      "task_name": "CNA",
      "location_acceptance_in": "At Site: APP",
      "location_acceptance_out": "At Site: APP",
      "login_notes": "",
      "logout_notes": "",
      "login_mileage": "0",
      "logout_mileage": "0",
	  "login_latitude": "17.007546",
	  "login_longitude": "81.7805468",
	  "login_radius": "20",
	  "logout_latitude": "17.007546",
	  "logout_longitude": "81.7805468",
	  "logout_radius": "20",
          "approve_status":"approved",
      "payroll_item": "",
      "duration": "00 : 13"
    },
    
      "employee_number": "122",
      "employee_name": "Bill Rich",
      "date_time_in": "01-08-2018 19:23:38",
      "date_time_out": "01-08-2018 20:24:57",
      "workgroup_number": [ "2","3","6","10","11","21"],
      "workgroup_name": ["gyfytghjugyugyu","IOS Developer","android","scientist","Ios Testing","warn"],
      "job_number": "286",
      "job_name": "59 Johnson Ave",
      "service_item": "",
      "task_no": "18",
      "task_name": "HHA",
      "location_acceptance_in": "Smartphone GPS OFF",
      "location_acceptance_out": "Smartphone GPS OFF",
      "login_notes": "",
      "logout_notes": "",
      "login_mileage": "0",
      "logout_mileage": "0",
	  "login_latitude": "0",
	  "login_longitude": "0",
	  "login_radius": "0",
	  "logout_latitude": "0",
	  "logout_longitude": "0",
	  "logout_radius": "0",
          "approve_status":"unapproved",
      "payroll_item": "",
      "duration": "01 : 01"
    }
]
}

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=08/01/2018&to_date=08/09/2018&employees=1&job=52

Response:

{
  "status": "success",
  "message": "success",
  "log_count": 11,
  "logs": [
    {
      "employee_number": "1",
      "employee_name": "Melissa Kukurudza",
      "date_time_in": "07-08-2018 12:51:40",
      "date_time_out": "07-08-2018 12:53:25",
      "workgroup_number": [6","7"],
      "workgroup_name": ["android","web tester"],
      "job_number": "1298",
      "job_name": "ananda inn",
      "service_item": "",
      "task_no": "29",
      "task_name": "Painting",
      "location_acceptance_in": "At Site: APP",
      "location_acceptance_out": "At Site: APP",
      "login_notes": "gyftty",
      "logout_notes": "",
      "login_mileage": "77",
      "logout_mileage": "0",
	  "login_latitude": "17.007546",
	  "login_longitude": "81.7805468",
	  "login_radius": "20",
	  "logout_latitude": "17.007546",
	  "logout_longitude": "81.7805468",
	  "logout_radius": "20",
          "approve_status":"approved",
      "payroll_item": "",
      "duration": "00 : 01"
    }
]
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=10/23/2015&to_date=10/28/2015&employees=1&jobs=100

Response:

{
	“status”: “success”,
	“message”: “success”,
	“log_count”: 0,
	“logs”: []
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=10/23/2015

Response:

{
	“status”: “fail”,
	“message”: “‘to_date’ parameter is missing”
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=10/30/2015&to_date=10/28/2015

Response:

{
	“Status”: “fail”,
	“Message”: “to_date must greater than from_date”
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=&to_date=10/28/2015

Response:

{
	“Status”: “fail”,
	Message”: “from_date parameter is missing”
}

Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?from_date=10/23/2015&to_date=10/28/2015

Response:

{
	“Status”: “fail”,
	“Message”: “’ key’ is missing”
}

 

 Time Tracking Software API Request:

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee_report.php?key=NZG3B3WEJ0EZWGL5&from_date=10/23/2015&to_date=10/28/2015&key=aba2as3rgd343t4eg3

Response:

{
	“Status”: “fail”,
	“Message”: “Invalid API key”
}

 



Employee API Parameters:

Action = view

Request Parameters Description Example
emp_id    ID of the Employee 2

 

View Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=view&key=cFwyBfxtDZmoIb0C

Response:

[
  {
    "employee_number": "1",
    "employee_first_name": "Melissa",
    "employee_last_name": "Kukurudza",
    "employee_phone": "0123456789",
    "location_option": "Log out 2018-04-19 16:00:19",
    "payroll_item": "",
    "ot_payroll_item": "",
    "workgroup": ["android","web tester"],
    "manager": "Manager",
    "email": "[email protected]"
  },
  {
    "employee_number": "2",
    "employee_first_name": "VJ",
    "employee_last_name": "Kumar",
    "employee_phone": "+0918886810715",
    "location_option": "Log out 2018-07-27 01:26:13",
    "payroll_item": "Bonus",
    "ot_payroll_item": "Regular Hours",
    "workgroup": "admin",
    "manager": "Manager",
    "email": "[email protected]"
  }
 ]

 

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=view&key=cFwyBfxtDZmoIb0C&emp_id=1

Response:

{
  "employee_number": "1",
  "employee_first_name": "Melissa",
  "employee_last_name": "Kukurudza",
  "employee_phone": "0123456789",
  "location_option": "Log out 2018-04-19 16:00:19",
  "payroll_item": "",
  "ot_payroll_item": "",
  "workgroup": ["android","web tester"],
  "manager": "Manager",
  "email": "[email protected]"
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=view&key=cFwyBfxtDZmoIb0C&emp_id=fffd

Response:

{
	“status”: “fail”,
	“message”: “’emp_id’ should be number”
}

Action = delete

Request Parameters Description Example
emp_id *   ID of the Employee 2

* required fields

Delete Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=delete&key=cFwyBfxtDZmoIb0C&emp_id=2

Response:

{
	“status”: “success”,
	“message”: “successfully deleted”
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=delete&key=cFwyBfxtDZmoIb0C&emp_id=122

Response:

{
	“status”: “fail”,
	message”: “No record with that employee number 122”
}

Action = insert

Request Parameters Description Example
emp_id   ID of the Employee 2 (if not provided, automatically takes next employee id)
first_name *   First Name of the Employee John
last_name Last Name of the Employee Doe
phone_num Phone number of the Employee 8866541559
code Country code of the phone number 96
manager  Whether employee is manager or non-manager 1 or 0
email * Email of the Employee [email protected]
workgroup * Work group of the Employee Single: Construction
Multiple: painting,testing
payrollitem Payroll of Employee Hourly
otpayrollitem Overtime payroll of Employee OTHourly
job_assign Assign emp for all or none or multiple jobs Default : all
Multiple : 314, 315, 564
None : none

* required fields      *Conditional required fields when manager value is 1

Insert Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&emp_id=2&first_name=adam&last_name=a&phone_num=3214569858&manager=1&email=adam121@gmal.com&code=21&workgroup=testing&payrollitem=daily&otpayrollitem=hourly

Response:

{
	“status”: “success”,
	“message”: “successfully inserted”
}

 

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&emp_id=10

Response:

{
	“status”: “fail”,
	“message”: “‘first_name’ parameter is missing”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&emp_id=122&manager=1&first_name=vj

Response:

{
   “status”: “fail”,
   “message”: “‘workgroup’ or ’email’ parameter is"
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&emp_id=122&manager=1&first_name=vj&email=asm

Response:

{
	“status”: “fail”,
	“message”: “Invalid ’email’ format “
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&emp_id=122&manager=1&first_name=vj&email=asm@yahoo.com

Response:

{
   “status”: “fail”,
   “message”: “‘workgroup’ or ’email’ parameter is"
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&emp_id=bn&manager=1

Response:

{
	“status”: “fail”,
	“message”: “’emp_id’ should be number”
}

 

Assigning next employee number if emp_id not provided:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&first_name=adam&last_name=a&phone_num=3214569858&manager=1&email=adam121@gmal.com&code=21&workgroup=testing&payrollitem=daily&otpayrollitem=hourly

Response:

{
	“status”: success,
	“message”: “successfully inserted”
}

 

Assigning Multi-workgroup to the employee:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=cFwyBfxtDZmoIb0CC&first_name=sys&last_name=admin&phone_num=3214569858&manager=1&email=sys@admin.com&code=21&workgroup=testing,painting&payrollitem=daily&otpayrollitem=hourly

Response:

{
	“status”: success,
	“message”: “successfully inserted”
}

 

Assign all jobs to Employee

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=qRkJaaQMqgYctmTN&emp_id=258&first_name=adam&last_name=sa&phone_num=3214569858&manager=1&email=cfgdf@gmal.com&code=21&workgroup=testing&payrollitem=daily&otpayrollitem=hourly&job_assign=all
OR
https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=qRkJaaQMqgYctmTN&emp_id=258&first_name=adam&last_name=sa&phone_num=3214569858&manager=1&email=cfgdf@gmal.com&code=21&workgroup=testing&payrollitem=daily&otpayrollitem=hourly

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

No Job Assignment to Employee

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=qRkJaaQMqgYctmTN&emp_id=258&first_name=adam&last_name=sa&phone_num=3214569858&manager=1&email=cfgdf@gmal.com&code=21&workgroup=testing&payrollitem=daily&otpayrollitem=hourly&job_assign=none

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assign Mutiple jobs to Employee

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=insert&key=qRkJaaQMqgYctmTN&emp_id=258&first_name=adam&last_name=sa&phone_num=3214569858&manager=1&email=cfgdf@gmal.com&code=21&workgroup=testing&payrollitem=daily&otpayrollitem=hourly&job_assign=314,315,564

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Action = update

Request Parameters Description Example
emp_id *   ID of the Employee 3
Newempid New ID of the Employee 11
first_name    First Name of the Employee Adam
last_name Last Name of the Employee Daly
phone_num Phone number of the Employee 5545412416
code Country code of the phone number 96
manager Whether employee is manager or non-manager 1 or 0
email * Email of the Employee [email protected]
workgroup * Work group of the Employee Single: Construction
Multiple: painting,testing
workgroup_append If yes, Append given workgroup without deleting previous assigned workgroups.
If no, Append given workgroup by deleting previous assigned workgroups.
Default : yes
no
payrollitem Payroll of Employee Hourly
otpayrollitem Overtime payroll of Employee Hourly1.5
job_assign Assign all jobs to Employee ALL : all
Multiple : 314, 315, 564
None : none
job_append If yes, Append given job ids without deleting previous assigned jobs.
If no, Append given job ids by deleting previous assigned jobs
Default : yes
no

* required fields               *Conditional required fields when manager value is 1

Update Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=21&last_name=jhon&phone_num=3214569858&manager=0&&workgroup=testing&payrollitem=daily&otpayrollitem=hourly

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=21&manager=0&&workgroup=testing&payrollitem=daily&otpayrollitem=hourly &newempid=52

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=21&manager=0&&workgroup=testing&payrollitem=daily&otpayrollitem=hourly &newempid=2

Response:

{
	“status”: ” fail “,
	“message”: “‘newempid’ already exists “
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=bn&manager=1

Response:

{
	“status”: “fail”,
	“message”: “’emp_id’ should be number”
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&manager=1

Response:

{
	“status”: “fail”,
	“message”: “no employee with 121 ’emp_id'”
}

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&manager=1

Response:

{
	“status”: “fail”,
	“message”: “‘action’ parameter is missing”
}

 

Assign worgroup with out deleting previous assigned workgroups (default)

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=painting,construction&workgroup_append=yes
OR
https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=painting,construction

Response:

{
	“status”: “success”,
	“message”: “successfully Updated”
}

 

Assign worgroup by deleting previous assigned workgroups

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=cleaning&workgroup_append=no

Response:

{
	“status”: “success”,
	“message”: “successfully Updated”
}

 

Assign all jobs to Employee

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=cleaning&job_assign=all

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign Multiple jobs without deleting previously assigned jobs(default)

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=cleaning&job_assign=515&job_append=yes
OR
https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=cleaning&job_assign=515

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign Multiple jobs by deleting previously assigned jobs

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=cleaning&job_assign=120,121&job_append=no

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Un-assign all jobs from Employee

Link:

https://admin.timesheetmobile.com/TBA/APIs/employee.php?action=update&key=cFwyBfxtDZmoIb0CC&emp_id=121&workgroup=cleaning&job_assign=none

Response:

{
    "status": "success",
    "message": "successfully updated"
}

 



Customer Job API Parameters:

Action = view

Request Parameters Description Example
jid ID of the Job 2

 

View Examples:

 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=view&key=cFwyBfxtDZmoIb0C

Response:

[{
	“job_number”: “1”,
	“job_name”: “Brooks Lawn Care.”,
	“job_phone”: “6175551545”,
	“service_item”: “landscaping”,
	“billable”: “NO”,
	“street”: “123 Elm”,
	“city”: “boston”,
	“zip”: “01005”,
	“state”: “MA”,
	“latitude”: “36.19005320”,
	“longitude”: “-61.62479920”,
	“GEO_Fence”: “100m”
},
{
	“job_number”: “2”,
	“job_name”: “D&D Snowplowing”,
	“job_phone”: “+3459876534523”,
	“service_item”: “snow removal”,
	“billable”: “YES”,
	“street”: “15 Oak St.”,
	“city”: “Newton”,
	“zip”: “01587”,
	“state”: “MA”,
	“latitude”: “36.00070000”,
	“longitude”: “-62.03400000”,
	“GEO_Fence”: “200m”
}]

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=view&key=cFwyBfxtDZmoIb0C&jid=1

Response:

[
{
   “job_number”: “1”,
   “job_name”: “Jones St. Addition”,
   “job_phone”: “6175558745”,
   “service_item”: “carpentry”,
   “billable”: “NO”,
   “street”: “123 Elm”,
   “city”: “boston”,
   “zip”: “01221”,
   “state”: “MA”,
   “latitude”: “40.19095320”,
   “longitude”: “-76.62479920”,
   “GEO_Fence”: “125m”
}
] 

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=view&key=cFwyBfxtDZmoIb0C&jid=fffd

Response:

{
	“status”: “fail”,
	“message”: “‘jid’ should be number”
}

Action = delete

Request Parameters Description Example
jid * ID of the Job 2

* required fields

Delete Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=delete&key=cFwyBfxtDZmoIb0C&jid=2

Response:

{
   “status”: “success”,
   “message”: “successfully deleted”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=delete&key=cFwyBfxtDZmoIb0C&jid=122

Response:

{
   “status”: “fail”,
   “message”: “No record with that job number 122”
}

Action = insert

Request Parameters Description Example
jid ID of the Job 2 (if not provided, automatically takes next job id)
jname  Name of the Job Main St. Remodeling
phone_num Phone number of the Job 9655412471
code Country code of the phone number 96
street Street of the Job 13th Ave
city City of the Job Boston
state State of the Job MA
latitude Latitude point of the Job 12.200233
longitude Longitude point of the Job 70.12121
service_item Service electrical
billable Billable YES or NO
radius Geo fence radius of the Job 321
time_zone Time zone ALASKA
emp_assign Assign job to all or none or multiple employee Default : all
Multiple: 10,12,14
None: none
task_assign Assign all tasks or none or multiple tasks to job ALL : all
Multiple: 3,4,5
None: none

* required fields

States codes and their Names:

State Code

State Name State Code State Name State Code State Name
AL ALABAMA MI MICHIGAN UT UTAH
AK ALASK, MN MINNESOTA VT VERMONT
AS AMMARIEAN SAMOA MS MISSISSIPPI VI VIRGIN ISLANDS
AZ ARIZONA MO MISSOURI VA VIRGINIA
AR ARKANSAS MT MONTANA WA WASHINGTON
CA CALIFORNIA NE NEBRASKA WV WEST VIRGINIA
CO COLORADO NV NEVADA WI WISCONSIN
CT CONNECTICUT NH NEW HAMPSHIRE WY WYOMING
DE DELAWARE NJ NEW JERSEY AE ARMED FORCES AFRICA \

CANADA \ EUROPE \

MIDDLE EAST

DC DISTRICT OF COLUMBIA NM NEW MEXICO AA ARMED FORCES AMMARIEA

(EXCEPT CANADA)

FM FEDERATED STATES OF MICRONESIA NY NEW YORK AP ARMED

FORCES

PACIFIC

FL FLORIDA NC NORTH CAROLINA BC British Columbia
GA GEORGIA ND NORTH DAKOTA ON Ontario
GU GUAM GU MP NORTHERN MARIANA ISLANDS NL Newfoundland and

Labrador

HI HAWAII OH OHIO NS Nova Scotia
ID IDAHO OK OKLAHOMA PE Prince Edward Island
IL ILLINOIS OR OREGON NB New Brunswick
IN INDIANA PW PALAU QC Quebec
IA IOWA PA PENNSYLVANIA MB Manitoba
KS KANSAS PR PUERTO RICO SK Saskatchewan
KY KENTUCKY RI RHODE ISLAND AB Alberta
LA LOUISIANA SC SOUTH CAROLINA NT Northwest Territories
ME MAINE SD SOUTH DAKOTA NU Nunavut
MH MARSHALL ISLANDS TN TENNESSEE YT Yukon Territory
MD MARYLAND MA MASSACHUSETTS PR Puerto Rico
TX TEXAS

Insert Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&latitude=22.22232&longitude=121.333&billable=yes

Response:

{
	“status”: “success”,
	“message”: “successfully inserted”
}
  

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no

Response:

{
   “status”: “success”,
   “message”: “successfully inserted”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&latitude=22.22232&longitude=121.333&billable=yes&radius=10

Response:

{
	“status”: “fail”,
	“message”: “‘radius’ should be numMarie and range between 25 to 10000? “
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&latitude=2122.22232&longitude=121.333&billable=yes&radius=500

Response:

{
   “status”: “fail”,
	“message”: “invalid ‘latitude’ point”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job& latitude=21.22232&longitude=1921.333&billable=yes&radius=500

Response:

{
   “status”: “fail”,
  “message”: “invalid ‘longitude’ point”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job& latitude=21.22232&longitude=asdsd

Response:

{
                “status”: “fail”,
                “message”: “‘longitude’ point should be number”
               }
               

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=bn&manager=1

Response:

{
	“status”: “fail”,
	“message”: “‘jid’ should be number”
}

Job Assignment for all. By Default, job assigned for all employees

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=all
OR
https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

No employee Assignment for the job

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=none

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assign Job for Multiple Employees

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=10,12,14

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assign all tasks to the job

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=all

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

No Task Assignment for the job. By default None

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=none
OR
https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assign multiple tasks to the job

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=7,12

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assigning next job number if *jid* not provided

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=insert&key=cFwyBfxtDZmoIb0CC&jname=accme_job&phone_num=2233665511&city=boston&street=13thave&billable=no

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Action = update

Request Parameters Description Example
jid * ID of the Job 2
newjid New ID of the Job 11
jname Name of the Job Lincoln School Roof
phone_num Phone number of the Job 9655412471
code Country code of the phone number 96
street Street of the Job 13th Ave
city City of the Job Boston
state State of the Job MA
latitude Latitude point of the Job 12.200233
longitude Longitude point of the Job 70.12121
service_item Service Class
billable Billable YES or NO
radius Geo fence radius of the Job 321
time_zone Time zone ALASKA
emp_assign Assign job to all or none or multiple employee Default : all
Multiple: 10,12,14
None: none
emp_append If yes, Append given employee ids without deleting previous assigned employees.
If no, Append given employee ids by deleting previous assigned employees.
Default : yes
no
task_assign Assign all or none or multiple tasks to the job ALL : all
Multiple: 3,4,5
None: none
task_append If yes, Append given taks ids without deleting previous assigned tasks.
If no, Append given tasks ids by deleting previous assigned tasks.
Default : yes
no

* required fields

Update Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&latitude=22.22232&longitude=121.333&billable=no

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&latitude=22.22232&longitude=121.333&billable=yes&radius=10

Response:

{
	“status”: “fail”,
	“message”: “‘radius’ should be numMarie and range between 25 to 10000? “
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&latitude=2122.22232&longitude=121.333&billable=yes&radius=500

Response:

{
	“status”: “fail”,
	“message”: “invalid ‘latitude’ point”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job& latitude=21.22232&longitude=1921.333&billable=yes&radius=500

Response:

{
	“status”: “fail”
	“message”: “invalid ‘longitude’ point”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job& latitude=21.22232&longitude=asdsd

Response:

{
	“status”: “fail”,
	“message”: “‘longitude’ point should be number”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=bn&manager=1

Response:

{
	“status”: “fail”,

“message”: “‘jid’ should be number” }

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?key=cFwyBfxtDZmoIb0CC&jid=bn&manager=1

Response:

{
	“status”: “fail”,
	“message”: “‘action’ parameter is missing”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&jid=32&manager=1

Response:

 {
	“status”: “fail”,
	“message”: “‘key’ parameter is missing”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZIb0CC&jid=1&manager=1

Response:

{
	“status”: “fail”,
	“message”: “Invalid API Key”
}

Job Assignment for all employees. No default option

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=all

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Un-assign all employees from the job

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=none

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign Job for Multiple Employees without deleting previously assigned employees(default)

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=10,12,14&emp_append=yes
OR
https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=10,12,14

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign Job for Multiple Employees by deleting previously assigned employees

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&emp_assign=16,18&emp_append=no

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign all tasks to the job

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=all

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign multiple tasks to the job without deleting previously assigned tasks(default)

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=7,12&task_append=yes
OR
https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=7,12

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign multiple tasks to the job by deleting previously assigned tasks

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=13,22&task_append=no

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Un-assign all tasks from the job

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=update&key=cFwyBfxtDZmoIb0CC&jid=4&jname=job&phone_num=2233665511&city=boston&street=13thave&billable=no&task_assign=none

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Action = make_inactive

Request Parameters Description Example
jid * ID of the Job 2

* required fields

Job Making Inactive Examples:

Change an Active job to Inactive Status

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=make_inactive&key=cFwyBfxtDZmoIb0CC&jid=4

Response:

{
    "status": "success",
    "message": "Job Status Changed to Inactive Successfully"
}

Failure Cases

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=make_inactive&key=cFwyBfxtDZmoIb0CC&jid=10

Response:

{
	"status":"fail",
	"message":"No record with that job number 10"
}

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=make_inactive&key=cFwyBfxtDZmoIb0CC

Response:

{
	"status":"fail",
	"message":"'jid' parameter is missing"
}

Action = make_active

Request Parameters Description Example
jid * ID of the Job 2

* required fields

Job Activating Examples:

Change an Inactive job to Active Status

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=make_active&key=cFwyBfxtDZmoIb0CC&jid=4

Response:

{
    "status": "success",
    "message": "Job Status Changed to Active Successfully"
}

Failure Cases

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=make_active&key=cFwyBfxtDZmoIb0CC&jid=10

Response:

{
	"status":"fail",
	"message":"No record with that job number 10"
}

Link:

https://admin.timesheetmobile.com/TBA/APIs/job.php?action=make_active&key=cFwyBfxtDZmoIb0CC

Response:

{
	"status":"fail",
	"message":"'jid' parameter is missing"
}

Task API Parameters:

Action = view

Request Parameters Description Example
tid ID of the Task 2

View Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=view&key=cFwyBfxtDZmoIb0C

Response:

[
	{
		“task_number”: “1”,
		“task_name”: “Painting”,
		“service_item”: “labor hours”,
		“class”: “Service”
	},
	{
		“task_number”: “2”,
		“task_name”: “Roofing”,
		“service_item”: “contractor”,
		“class”: “Contract”
	}
]

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=view&key=cFwyBfxtDZmoIb0C&tid=2

Response:

	[
	{
		“task_number”: “2”,
		“task_name”: “Testing”,
		“service_item”: “Validation”,
		“class”: “Inheritance”
	}
	]

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=view&key=cFwyBfxtDZmoIb0C&tid=fffd

Response:

{
	“status”: “fail”,
	“message”: “‘tid’ should be number”
}

Action = delete

Request Parameters Description Example
tid * ID of the Task 2

* required fields

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=delete&key=cFwyBfxtDZmoIb0C&tid=2

Response:

{
	“status”: “success”,
	“message”: “successfully deleted”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=delete&key=cFwyBfxtDZmoIb0C&tid=122

Response:

{
	“status”: “fail”,
	“message”: “No record with that task number 122”
}

Action = insert

Request Parameters Description Example
tid ID of the Task 2 (if not provided, automatically takes next task id)
tname * Name of the Task roofing
service_item Name of service item roofing
class Name of Class labor contract
job_assign Assign task for all or none or multiple jobs ALL : all
Multiple : 10, 12, 14
None : none

* required fields

Insert Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tid=10&tname=development&service_item=Service1&class=Class1

Response:

{
	“status”: “success”,
	“message”: “successfully inserted”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tid=10

Response:

{
	“status”: “fail”,
	“message”: “‘tname’ parameter is missing”
}

Assign Task to all jobs

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tid=10&tname=development&service_item=Service1& class=Class1&job_assign=all

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

No Job Assignment to Task

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tid=10&tname=development&service_item=Service1& class=Class1&job_assign=none
OR
https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tid=10&tname=development&service_item=Service1& class=Class1

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assign Mutiple jobs to Task

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tid=10&tname=development&service_item=Service1& class=Class1&job_assign=10,12

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Assigning next task number if *tid* not provided

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=insert&key=cFwyBfxtDZmoIb0CC&tname=new development&service_item=Service1& class=Class1

Response:

{
    "status": "success",
    "message": "successfully inserted"
}

Action = update

Request Parameters Description Example
tid* ID of the Task 2
tname Name of the Task security guard
newtid New ID of the task 6
class Name of Class security
service_item Name of service item servicetest
job_assign Assign task to all jobs ALL : all
Multiple : 10, 12, 14
None : none
job_append If yes, Append given job ids without deleting previous assigned jobs.
If no, Append given job ids by deleting previous assigned jobs
Default : yes
no

* required fields

Update Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=developmen&class=newclass

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=warn&new_tid=21

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=warn

Response:

{
	“status”: “fail”,
	“message”: “‘task’ name already exists”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=100&tname=warn

Response:

{
	“status”: “fail”,
	“message”: “no task with 100 ‘tid'”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?key=cFwyBfxtDZmoIb0CC&tid=100&tname=warn

Response:

{
	“status”: “fail”,
	“message”: “‘action’ parameter is missing”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cBfxtDZmoIb0CC&tid=100&tname=warn

Response:

{
	“status”: “fail”,
	“message”: “Invalid API Key”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update &tid=100&tname=warn

Response:

{
	“status”: “fail”,
	“message”: “‘key’ parameter is missing”
}

Assign Task to all jobs

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=developmen&class=newclass&job_assign=all

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign Multiple jobs without deleting previously assigned jobs(default)

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=developmen&class=newclass&job_assign=5,6&job_append=yes
OR
https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=developmen&class=newclass&job_assign=5,6

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Assign Multiple jobs by deleting previously assigned jobs

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=developmen&class=newclass&job_assign=7,8&job_append=no

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Un-assign all jobs from task

Link:

https://admin.timesheetmobile.com/TBA/APIs/task.php?action=update&key=cFwyBfxtDZmoIb0CC&tid=5&tname=developmen&class=newclass&job_assign=none

Response:

{
    "status": "success",
    "message": "successfully updated"
}

Workgroup API Parameters:

Action = view

Request Parameters Description Example
gid ID of the Workgroup 2

View Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?actio n=view&key=cFwyBfxtDZmoIb0C

Response:

[
{
	“id”: “1”,
	“workgroup”: “Management”
},
{
	“id”: “2”
	“workgroup”: “SS”
},
{
	“id”: “3”,
	“workgroup”: “match”
},
{
	“id”: “9”,
	“workgroup”: “My new workgroup6”
}
]

Action = delete

Request Parameters Description Example
gid * ID of the Workgroup 2

* required fields

Delete Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=delete&key=cFwyBfxtDZmoIb0C&gid=2

Response:

{
	“status”: “success”,
	“message”: “successfully deleted”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=delete&key=cFwyBfxtDZmoIb0C&gid=122

Response:

{
	“status”: “success”,
	“message”: “No record with that group number 122”
}

Action = insert

Request Parameters Description Example
gid * ID of the Workgroup 2
gname * Name of the Workgroup Plumbers

* required fields

Insert Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=insert&key=cFwyBfxtDZmoIb0CC&gid=10&gname=dust

Response:

{
	“status”: “success”,
	“message”: “successfully inserted”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=insert&key=cFwyBfxtDZmoIb0CC&gid=10

Response:

{
	“status”: “fail”,
	“message”: “‘gid’ already exists”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=insert&key=cFwyBfxtDZmoIb0CC&gid=hgg&gname=dust

Response:

{
	“status”: “fail”,
	“message”: “’gid’ should be number”
}

Action = update

Request Parameters Description Example
gid * ID of the Workgroup 2
gname * Name of the Workgroup Electricians
new_gid New ID of the workgroup 6

* required fields

Update Examples:

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=update&key=cFwyBfxtDZmoIb0CC&gid=5&gname=hack

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=update&key=cFwyBfxtDZmoIb0CC&gid=5&gname=warn&new_gid=21

Response:

{
	“status”: “success”,
	“message”: “successfully updated”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=update&key=cFwyBfxtDZmoIb0CC&gid=5&gname=hack

Response:

{
	“status”: “fail”,
	“message”: “‘workgroup’ name already exists”
}

Time Tracking Software API Request:

https://admin.timesheetmobile.com/TBA/APIs/workgroup.php?action=update&key=cFwyBfxtDZmoIb0CC&gid=5&gname=hack

Response:

{
	“status”: “fail”,
	“message”: “‘workgroup’ name already exists”
}


Schedule API Parameters:

Action = View

Request Parameters Description Example
schedule_id Schedule ID 2

Examples:

View Schedule w.r.t Schedule ID

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=view&schedule_id=248

output:

{
  "schedule_id": "248",
  "emp_id": "1",
  "job_id": "44",
  "task_id": "0",
  "start_date": "2016-07-26 12:00:00",
  "end_datetime": "2016-07-26 01:00:00",
  "status": "",
  "hours_count": "11",
  "created_by": "[email protected]",
  "created_at": "2016-07-26 15:34:03",
  "instance_id": "1"
}

View all schedules

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=view

output:

[
  {
    "schedule_id": "248",
    "emp_id": "1",
    "job_id": "44",
    "task_id": "0",
    "start_date": "2016-07-26 12:00:00",
    "end_datetime": "2016-07-26 01:00:00",
    "status": "",
    "hours_count": "11",
    "created_by": "[email protected]",
    "created_at": "2016-07-26 15:34:03",
    "instance_id": "1"
  },
  {
    "schedule_id": "250",
    "emp_id": "47",
    "job_id": "272",
    "task_id": "233222",
    "start_date": "2016-10-28 10:38:00",
    "end_datetime": "2016-10-28 11:00:00",
    "status": "",
    "hours_count": "0.37",
    "created_by": "[email protected]",
    "created_at": "2016-10-28 14:35:42",
    "instance_id": "2"
  }
]

Action = Insert

Request Parameters Description Example
emp_id * Ids of the employees 12,13,14
jid Job Id 10
tid Task ID 6
start_date * Event Start date & time 2018-07-20 09:00:00
end_date * Event End date & time 2018-07-20 11:00:00
repeat_events Option to repeat the events yes
max_occurances Limit the number of occurances for the repeat option 200 (Accepted from 1 to 365)
repeat_days Days that the event need to be repeated mon,wed (Accepted values - sun,mon,tue,wed,thu,fri,sat)

* required fields

Examples:

Schedule Insert for Single Employee

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=insert&emp_id=11182&jid=3&tid=10&start_date=2018-07-19%2015:00:00&end_date=2018-07-19%2018:00:00

output:

{
	
  "success_status":"success",
  "success_message":"New Event Added Successfully for employee id : 11182 "

}

Schedule insert for Multiple Employee

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=insert&emp_id=11195,11182&jid=140004&tid=1111&start_date=2018-07-20%2015:00:00&end_date=2018-07-20%2018:00:00

output:

{
	
  "success_status":"success",
  "success_message":"New Event Added Successfully for employee id : 11195, 11182 "

}

If Employee Already Scheduled

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=insert&emp_id=11182 &jid=3&tid=10&start_date=2018-07-20 11:00:00&end_date=2018-07-20 15:00:00

output:

{
	
  "conflict_status":"conflict",
   "conflict_message":"Job Conflict for employee id : 11182 "
}

If one of multiple Employee already scheduled then

hhttps://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=insert&emp_id=11182,11195&jid=3&tid=10&start_date=2018-07-19%2015:00:00&end_date=2018-07-19%2018:00:00

output:

{
	
  
  "success_status":"success",
  "success_message":"New Event Added Successfully for employee id : 11195 ",
  "conflict_status":"conflict",
  "conflict_message":"Job Conflict for employee id : 11182 "

}

If job id does not match

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=insert&emp_id=11182&jid=12425445&tid=2&start_date=2018-07-14%2015:00:00&end_date=2018-07-14%2018:00:00

output:

{
	 
  "status":"fail",
  "message":"no job with 12425445 'jid' "

}

If Task id does not match

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=insert&emp_id=11182&jid=10&tid=57475752&start_date=2018-07-14%2015:00:00&end_date=2018-07-14%2018:00:00

output:

{
	 
  "status":"fail",
  "message":"no task with 57475752 'tid' "

}

Action : Update

Request Parameters Description Example
schedule_id* ID of Schedule 1724
emp_id* Employee ID* 11195
jid Job Id 10
tid Task ID 10
start_date * Event Start date & time 2018-07-20 09:00:00
end_date * Event End date & time 2018-07-20 11:00:00

* required fields

API

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=update&schedule_id=1724&emp_id=11195&jid=10&tid=4&start_date=2018-07-20%2009:00:00&end_date=2018-07-20%2011:00:00

output:

{
	 
  "status":"success",
  "message":"Event Updated"

}

Action : Delete

Request Parameters Description Example
schedule_id* ID of Schedule 1724
emp_id* Employee ID* 11195

* required fields

API

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=delete&schedule_id=1724&emp_id=11195

output:

{
	 
  "status":"success"

}

If Schedule Id not provided

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=delete&schedule_id=&emp_id=11195

output:

{
	 
  "status":"fail",
  "message":"'schedule_id' required "

}

If Employee Id not provided

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=delete&schedule_id=1724&emp_id=

output:

{
	 
    "status":"fail",
  "message":"'emp_id' required "


}

If Either of Schedule or Employee Id does not match

https://admin.timesheetmobile.com/TBA/APIs/schedule.php?key=qRkJaaQMqgYctmTN&action=delete&schedule_id=768678&emp_id=1195

output:

{
	
  "status":"fail",
  "message":"No record found with schedule_id : 56456 & emp_id : 11195"

}


Punches API Parameters:

Request Parameters Description Example
employee_number * ID of the Employee 3
job_number * ID of the Job 5
action * Action of employee need to clock-in or clock-out 'punch_in' of clock-in
'punch_out' for clock-out'
task_number ID of the Task 6
notes Notes for the punch Any text data
mileage Mileage for the punch 20

API (punch-in sample):

https://admin.timesheetmobile.com/TBA/APIs/manage_punch.php?key=qRkJaaQMqgYctmTN&employee_number=3&job_number=4&action=punch_in

Output:

{
	"status": "success",
	"message": "Punched-in Successfully",
	"log_id": 82078
}

API (punch-out sample):

https://admin.timesheetmobile.com/TBA/APIs/manage_punch.php?key=qRkJaaQMqgYctmTN&employee_number=3&job_number=4&action=punch_out

Output:

{
	"status": "success",
	"message": "Punched-out Successfully",
	"log_id": 82079
}


Activity Log API Parameters:

from_date *   From which date you want to show the logs Accepted Date Format mm/dd/yyyy 01/03/2015
to_date *   To which date you want to show the logs Accepted Date Format

mm/dd/yyyy

10/25/2015
employees

 

Number of the corresponding employee Employee Number

If no employee number given report for all employees will be generated

 

Default: All

32
 jobs

 

Number of the corresponding

job

Job Number if report required for single job

 

Default: All

21

API sample:

https://admin.timesheetmobile.com/TBA/APIs/activity_log.php?key=qRkJaaQMqgYctmTN&from_date=05/20/20&to_date=06/14/20

Output:

{
	"status": "success",
	"message": "success",
	"log_count": 4,
	"logs": [{
		"employee_number": "400",
		"employee_name": "Jane Smith",
		"date_time_in": "20-05-2020 12:06:51",
		"job_number": "200",
		"job_name": "Bailey House",
		"task_number": "3",
		"task_name": "CNA",
		"action": "Punch In",
		"geo_fence": "At Site: APP",
		"phone": "0123456789",
		"notes": "",
		"mileage": "",
		"latitude": "17.007546",
		"longitude": "81.7805468",
		"radius": "48",
		"log_id": "82025"
	},
	{
		"employee_number": "400",
		"employee_name": "Jane Smith",
		"date_time_in": "20-05-2020 13:10:43",
		"job_number": "200",
		"job_name": "Bailey House",
		"task_number": "3",
		"task_name": "CNA",
		"action": "Punch Out",
		"geo_fence": "At Site: APP",
		"phone": "Off Line 0123456789",
		"notes": "",
		"mileage": "",
		"latitude": "17.007590",
		"longitude": "81.7805473",
		"radius": "30",
		"log_id": "82026"
	},
	{
		"employee_number": "400",
		"employee_name": "Jane Smith",
		"date_time_in": "23-05-2020 08:04:10",
		"job_number": "200",
		"job_name": "Bailey House",
		"task_number": "3",
		"task_name": "CNA",
		"action": "Punch In",
		"geo_fence": "At Site: APP",
		"phone": "0123456789 Geofence-Autopunch",
		"notes": "",
		"mileage": "",
		"latitude": "17.007446",
		"longitude": "81.7805490",
		"radius": "34",
		"log_id": "82030"
	},
	{
		"employee_number": "400",
		"employee_name": "Jane Smith",
		"date_time_in": "23-05-2020 10:17:23",
		"job_number": "200",
		"job_name": "Bailey House",
		"task_number": "3",
		"task_name": "CNA",
		"action": "Punch In",
		"geo_fence": "At Site: APP",
		"phone": "0123456789 Geofence-Autopunch",
		"notes": "",
		"mileage": "",
		"latitude": "17.007452",
		"longitude": "81.7805487",
		"radius": "32",
		"log_id": "82030"
	}]
}