API Details
Particulars | Description |
API Name | Attendance Transaction |
Method | POST |
URL | https://portal.zinghr.com/2015/route/TNA/Employeeattendancetransactions |
Description | This API returns every employee’s shift details and attendance status details |
Input format | JSON |
Output format | JSON |
Input
Property Name | Data Type | Description | Mandatory | Remarks |
SubscriptionName | string | Subscription name of the account | Yes | Max length = 10 characters |
Token | string | Security check. To verify the account and request | Yes | |
Actionfromdate | string | For shift details starting from the mentioned date Date format: dd-mm-yyyy | Optional | |
Actiontodate | string | For shift details till the mentioned date Date format: dd-mm-yyyy | Optional | |
Attendancestatus | string | If specified then API returns details for the status that is passed. Possible values: A, P, WOFF, HD | Optional | |
EmployeeCode | string | Returns attendance details for the specific employee. Only one employee code can be passed at a time | Optional |
Response
Property Name | Data Type | Description |
Message | string | Response message from the server |
Code | int | Response code from the server |
AttendanceDetails | array | List of Attendance Transaction |
Response Code and Message
Code | Message | Remarks |
1 | Success | Successful API call |
2 | Employee not found | Employee code passed in parameter could not find an employee in the system |
3 | Invalid Token | The token passed in the API did not match the token in the system. Validate the token from the Setup Circle in ZingHR portal |
4 | Internal Server Error | The API execution faced an unexpected error |
5 | Invalid date format | Use date format as dd-mm-yyyy |
6 | Token expired | The token is expired and needs to be generated again. Token can be generated from the Setup Circle in ZingHR portal |
Attendance Transaction
Property Name | Data Type | Description |
EmployeeCode | string | Employee code of the employee as in the system |
Shiftname | string | Shift name to which the employee is assigned to |
Shiftdate | string | Date when the Shift applies to the employee |
Shiftstartdate | string | Shift start time in hh:mm |
Shiftenddate | string | Shift end time in hh:mm |
Actualstarttime | string | First swipe of the employee |
Actualendtime | string | Last swipe of the employee |
Attendancestatus | string | Employee’s attendance status on the particular date |
Managercode | string | Employee code of the employee’s manager |
RegIn | string | Regularization In Time hh : mm |
RegOut | string | Regularization Out Time hh : mm |
ODIn | string | Outdoor In Time hh : mm |
ODOut | string | Outdoor Out Time hh : mm |
InTimeSource | String | Biometric, ZingHR App, Regularization, OutDoor or Leave |
InTimeLocation | String | Biometric Id incase source is biometric, Geo Location incase of ZingHR App and blank in other cases |
OutTimeSource | String | Biometric, ZingHR App, Regularization, OutDoor or Leave |
OutTimeLocation | String | Biometric Id incase source is biometric, Geo Location incase of ZingHR App and blank in other cases |
ODApprovedBy | String | OutDoor Approved By |
ODApprovedOn | String | OutDoor Approved Time hh: mm |
RegApprovedBy | String | Regularization Approved By |
RegApprovedOn | String | Regularization Approved Time hh: mm |
Leave Approved By | String | Leave Approved By |
Leave Approved On | String | Leave Approved Time hh: mm |
Approved Backdated Transaction-
This will return transactions which are approved on the date which is given in input .The column and response is same as Attendance Transaction Section .