Employee Master API (V2)

Modified on Fri, 27 May, 2022 at 2:07 PM

Employee Master API (V2) :

Introducing new Employee Master API which will allow you to enable/disable or rename the fields in API response as per the requirement. Please refer below input parameters and list of fields which are available in response.

API Details:

API Name	Employee Master
Method	POST
URL	https://portal.zinghr.com/2015/route/EmployeeDetails/GetEmployeeMasterDetails
Description	This API returns further attribute details of all the employees in the organization
Input format	JSON
Output format	JSON

Please contact system admin to enable, disable or rename any of the below fields in API response.

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
EmpFlag	String	To Fetch employees data based on EmpFlag parameter value mention below ADD : For New Employee. EDIT : For Updated Employee Data. DELETE : For Left Employee.	Optional
SectionName	String	To fetch selective section details along with basic details .For an eg specifying this section name as "Attribute", you will get basic details along with all attribute details as collection	Optional
PageSize	String		Optional	Mandatory if only Subscription name and token is provided.
PageNumber	String		Optional	Mandatory if only Subscription name and token is provided.

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
FirstName	String	Employee First name
LastName	String	Employee last name
MiddleName	String	Employee middle name
FatherName	String	Employee Father 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	Employee Current Status
Age	String	Employee’s age
PFAccountNumber	String	Employee’s PF Account Number as entered in the system
ESICAccountNumber	String	Employee’s ESIC Account Number as entered in the system
ReportingManagerName	String	Employee’s Reporting Manager Name as entered in the system
ReportingManagerCode	String	Employee’s Reporting Manager Code as entered in the system
LastModified	String	Last Modified Date of an employee
CreatedDate	String	Created Date of an Employee
EmpFlag	String	Current employee status – New, Existing, FnFLocked etc
DateofResignation	String	Employee Date Of Resignation
ExitDate	String	Last date of working while applying for resignation
GroupDOJ	String	Employee's Group DOJ
ExitTypeName	String	Exit type while applying for resignation
ExitReason1	String	Reason specified while applying for resignation
ExitReason2	String	Remarks specified while applying for resignation
DomainID	String	Domain ID
PaymentDescription	String	Employees's Payment Description
PTApplicable	String	Employee's Pt Applicable
PFApplicable	String	Employee's Pf Application
ESICApplicable	String	Employees's ESIC Applicable
LwfApplicable	String	Employee's Lef Applicable
PfDenotion	String	Employee's Denotion
EmploymentType	String	Employeement tyape
FNFProcessedMonth	String	Employee's FNF Processed Month
NetPay	String	Employee's Net Pay
FNFStatus	String	Employee's FNF Status
RecoveryStatus	String	Employee's ReCovery Status
EcodeGeneratedBy	String	Employee's Ecode Generated By
OfferLetterReferenceNo	String	Employee's Offer Latter Reference No
AttendanceManagerStatus	String	Employee's Attendance Manager Status
Nationality	String	Eployee's Nationality
MaritalStatus	String	Employee's Marital Status
OldEmployeeCode	String	Employee's Old Employee Code
Attribute	Array	List Of Attributes and unit Collection
Address	Array	Address Collection
BankDetails	Array	List Of Bank Details Collection
SalaryDetails	Array	List Of Salary Details Collection
SkillsDetails	Array	List Of Skills Details Collection
LanguageDetails	Array	List Of Language Details Collection
Qualification	Array	List Of Qualification Details Collection
CertificationDetails	Array	List Of Certification Details Collection
FamilyDetails	Array	List Of Family Details Collection
MedicalDetails	Array	List Of Medical Details Collection
NominationDetails	Array	List Of Nomination Details Collection
MedicalCoverageDetails	Array	List Of Medical Coverage Details Collection
FamilyVisaDetails	Array	List Of Family Visa Details Collection
EmployeeHistortDetails	Array	List Of Employee History Details Collection
VisaDetails	Array	List Of Visa Details Collection
ESICDetails	Array	List Of ESIC Details Collection
ApproverDetails	Array	List Of Approver Details Collection
ClaimApproverDetails	Array	List Of Claim Approver Details Collection
AlternateMobileNo	String	Employee Alternate Mobile Number
BloodGroup	String	Employee Blood Group
ReportingManagerEmail	String	Reporting Manager Email Id
ReportingManagerName2	String	Reporting Manager's Manager Name
ReportingManagerCode2	String	Reporting Manager's Manager Code
ReportingManagerEmail2	String	Reporting Manager's Manager Email Id
PersonalEmailAddress	String	Personal Email Id