API for Product Q2
Your developers can use this API to query time hours data and users profile data from your account in product Q2.
1. Query Time Cards data:
Sample Code to query time cards data by passing parameters in URL：
https://api1.opentimeclock.com/Jun-Inside-VPC?cmd=api/q2QueryTimeCards&companyId=xxxx&developerToken=xxxx&nextRecord=0&dateTimeFrom=2022-05-01 00:00:00&dateTimeTo=2022-05-15 23:59:59&userFullName=xxxx&departmentName=xxxx&maxRecords=5000&returnColumns=$columnName1$columnName2$columnName3
Sample Code to query time cards data in JavaScript with jQuery POST：
function post(data, handler) {
var url = "https://api1.opentimeclock.com/Jun-Inside-VPC"; //api url
$.post(url, JSON.stringify(data), handler, 'json');
}
function getTimeCards() {
//pass in JSON parameters:
post({
"cmd": "api/q2QueryTimeCards", //This passed in commmand means query time cards records. We may have add or modify command later.
"companyId": "xxxx", //Find your "Company ID" in company setting page.
"developerToken": "xxxx", //Find "Developer Token" in reports page with admin account
"nextRecord": "0", //Default to "0". If >"0" means query the left data when there are more than 5k records available.
"dateTimeFrom": "2022-05-01 00:00:00", //From Date Time format: 0000-00-00 00:00:00
"dateTimeTo": "2022-05-15 23:59:59", //To Date Time format: 0000-00-00 00:00:00
"userFullName": "xxxx", //sample: Elon Musk; For all users, use "ALL USERS" or ""
"departmentName": "xxxx", //sample: HR Department; For all departments, use "ALL DEPARTMENTS",or ""
"maxRecords": "5000", //Default to "5000" if set as "". How many maximum records be return in each query.
"returnColumns": "" //set return columns， format as "$columnName1$columnName2$columnName3...$columnNameX"; sample is "$userFullName$employeeNumber$inDateTime". For all columns, use "ALL COLUMNS",or ""
}, function (result) {
//sample code to use returned data:
var statusCode = result.statusCode;
var message = result.message;
var nextRecord = result.nextRecord;
var dataSet = result.data;
if(statusCode == 'SUCCESS')
console.log('query data successfully.');
if(statusCode == 'ERROR')
console.log('query data failed. check returned message.');
if(nextRecord == '-1')
console.log('no more data left');
if(nextRecord != '-1')
console.log('there are more data left. pass in nextRecord to query more.');
//use data set like this:
var firstFullName=dataSet[0].userFullName;
});
}
Sample Code to query time cards data in PHP：
Sample returned data in JSON to query time cards data：
2. Query Users data:
Sample Code to query users' data by passing parameters in URL：
Sample Code to query users' data in JavaScript with jQuery POST：
Sample Code to query users' data in PHP：
Sample returned data in JSON to query users' data：
Where to find Developer Token：
Last updated
Was this helpful?