API Details

API NameEmployee Master
MethodPOST
URLhttps://portal.zinghr.com/2015/route/EmployeeDetails/GetEmployeeDetails
Description
This API returns further attribute details of all the employees in the organization
Input format
JSON
Output format
JSON



Input

Property NameData TypeDescriptionMandatoryRemarks
SubscriptionName
string
Subscription name of the account
Yes
Max length = 10 characters
TokenstringSecurity 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
stringTo fetch attribute changes from the date mentioned.
Date format: dd-mm-yyyy
Optional
If not mentioned then the current attribute details are returned
Todate
stringTo fetch attribute changes till the date mentioned
Date format: dd-mm-yyyy
Optional
If Fromdate is mentioned then Todate is mandatory



Response

Property NameData TypeDescription
MessagestringResponse message from the server
CodeintResponse code from the server
EmployeesCount
intTotal number of employees found
Employees
arrayList of Employee Master collection



Response Code and Message

CodeMessageRemarks
1Success
Successful API call
2
Employee 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 Master Collection

Property NameData TypeDescription
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
stringEmployee’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
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
LastModified
string
Latest date when the employee record was updated in the system
PaymentDescription
string
How is the salary payment made
PTApplicable
string
Is Professional Tax applicable for the employee
PFApplicable
string
Is Provident Fund applicable for the employee
ESICApplicable
string
Is ESIC applicable for the employee
PfDenotion
string
PF Denotion for the provident fund
Address
arrayList of Address collection
BankDetails
array
List of Bank Details collection
SalaryDetails
array
List of Salary Details collection
Attributes
array
List of attributes & unit collection
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
SkillsDetails
array
List of Skills Details
LanguageDetails
array
List of Language details
Qualification
array
List of Qualifications