API Details

Particulars
Description
API Name
Employee Exit Details
Method
Post
URL
https://portal.zinghr.com/2015/route/Integration/GetExitDetails
Description
This API returns all the active employees from the system who resigned between specific date ranges.
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

EmployeeCode
string
Send employee code to get basic details of a specific employees. Only one employee can be passed at a time
Optional

Fromdate
string
To fetch attribute changes from the date mentioned.
Date format: dd-mm-yyyy
Optional
If not mentioned then the current attribute details are returned
Todate
string

To fetch attribute changes till the date mentioned
Date format: dd-mm-yyyy
Optional
If Fromdate is mentioned then Todate is mandatory



Response

Property Name
Data Type
Description
Message
string
Response message from the server
Code
int
Response code from the server
EmployeesCount
int
Total number of employees found
Employees
array
List of Employee Master collection


Response Code and Message

Code
Message
Remarks
1Success
Successful API call
2Employee not found
Employee code passed in parameter could not find an employee in the system
3Invalid 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
4Internal Server Error
The API execution faced an unexpected error
5Invalid date format
Use date format as dd-mm-yyyy
6Token expired
The token is expired and needs to be generated again. Token can be generated from the Setup Circle in ZingHR portal


Employee Exit Collection

Property Name
Data Type
Description
EmployeeCode
string
Employee Code
EmployeeName
string
Employee's full name
DateofResignation
string
Date of Resignation
DateofLeaving
string
Last date of working while applying for resignation
ExitTypeName
string
Exit type while applying for resignation
Exitreason1
string
Reason specified  while applying for resignation
Exitreason2
string
Remarks specified  while applying for resignation