API Details

Particulars Description
API Name Employee Basic Details
Method POST
URL https://portal.zinghr.com/2015/route/EmployeeDetails/GetEmployeesDetail
Description
This API returns basic details of all active employees from the system
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
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



Employee Master Collection

Property Name Data Type Description
EmployeeCode
string
Employee code of the employee as in the system
EmployeeId
int
Employee’s ID in the system
Salutation
string
Employee’s salutation as in Mr, Ms, Mrs
EmployeeName
string
Employee full name
LastName
string
Employee last name
MiddleName
string
Employee middle name
Email
string Employee’s official email address
Gender
string
Employee gender
Mobile
string
Employee mobile number
DateofBirth
string
Employee’s date of birth
DateOfJoining
string
Employee’s date of joining the organization
Dateofconfirmation
string
Employee’s date of confirmation in the organization
DateOfLeaving
string
Employee’s last working day, if the employee has resigned
EmployeeStatus
string
Current employee status – New, Existing, FnFLocked etc
Age
string
Employee’s age
PAN
string
Employee’s PAN number as entered in the system
UAN
string
Employee’s provident fund’s UAN number as entered in the system
AadhaarNumber
string
Employee’s aadhaar number as entered in the system
PFAccountNumber
string
Employee’s provident fund account number as entered in the system
ESICAccountNumber
string
Employee’s ESIC account number as entered in the system
Attributes
array
List of attributes & unit collection
LastModified
string
Latest date when the employee record was updated in the system
CreatedDate
string
Date when the employee was created in the system
EmpFlag
string
Specifies whether the employee is created, edited or deleted
Values: ‘ADD’, ‘EDIT’, ‘DELETE’
ReportingManagerCode
string
Employee’s reporting manager code in the system
ReportingManagerName
string
Reporting manager full name as entered in the system
ExitDate
string
Last working day of the employee
ExitReason1
string
Reason for  exit
ExitReason2
string
Remarks on exit if any
ExitTypeName
string
Type of resignation
GroupDOJ
string
Group DOJ



Attribute & Attribute Units collection

Property Type Data Type Description
AttributeTypeID
int
Attribute type ID
AttributeTypeDesc
string
Attribute type description
AttributeTypeCode
string
Attribute type code
AttributeTypeUnitID
int
Attribute type unit id
AttributeTypeUnitCode
string
Attribute type unit code
AttributeTypeUnitDesc
string
Attribute type unit description