Skip to content
Employee.identifyEmployeeIds(Map<String,String> mapParameters)
The Employee Search help page demonstrates how the Employee.identifyEmployeeIds method returns the employee ids based on inputs provided.
The method allows an employee id to be identified based on values of one or more parameters that are passed in. If there are more than 1 parameter passed in, the matching will be done for each parameter and the results will include all those employees where each parameter matches.
The system further provides only those results which are authorized to be accessed by the logged in employee.
Arguments
Map: Map type mandatory argument that stores the key value pair.
The fields on which the employees can be searched are mentioned in the below given table:
| Fields to search employees | Type of field | Description of field |
| employmentStatus | String | Default value Current.Can contain multiple other values too which includesCurrent,Terminated,Retired,Absconding,Exit,On Notice Period,Resigned,On Full and Final Settlement |
| employeeNo | String | A regular expression string can be passed in.If there are commas between the values, it will treat each comma separated value as a separate regular expression and do the matching against it. |
| name | String | A regular expression string can be passed in.If there are commas between the values, it will treat each comma separated value as a separate regular expression and do the matching against it. |
| company | String | Exact company nameIf there are commas between the values, it will treat each comma separated value as a separate value and do the matching against it. |
| grade | String | Exact grade nameIf there are commas between the values, it will treat each comma separated value as a separate value and do the matching against it. |
| employmentType | String | Exact employment typeIf there are commas between the values, it will treat each comma separated value as a separate value and do the matching against it. |
| location | String | Exact location nameIf there are commas between the values, it will treat each comma separated value as a separate value and do the matching against it. |
| sbu | String | Exact sbu nameIf there are commas between the values, it will treat each comma separated value as a separate value and do the matching against it. |
| department | String | Exact department namesIf there are commas between the values, it will treat each comma separated value as a value and do the matching against it. |
| title | String | Exact titleIf there are commas between the values, it will treat each comma separated value as a separate value and do the matching against it. |
| joiningDateRange | String | Upto two dates separated by a comma. Format of the date is as specified in your company details format.If the first date is available, that is taken as the starting date of joiningIf the second date is available, that is taken as the ending date of joiningEg. 14/03/2013,18/06/2013 – returns all employees who have joined the company between 14 March 2013 and 18 June 2013, both dates included. |
Returns
An array of employee ids as strings that will be used in subsequent calls.
Errors
- Unauthorized Access: If access is not allowed to the employee whose apiKey is passed In
- Invalid Parameter: If passed in parameter is not recognizable with parameter name
- Invalid Value: If passed in parameter value is not appropriate
Employee Object Methods
Click on each of these links to know more about them:
