Delete Employees

Used to delete employees in the tenant. Only those employees which are accessible by a given user, and which are not forwarded and not locked, can be deleted, even if the filter option is scenario. The example below deletes all employees under the DTHR scenario in the DTHR tenant.

Syntax

public KeyValues[] DeleteEmployees(string LoginName, string Password, string TenantCode, string scenarioCode, EmployeeFilterOptions employeeFilterOption, string[] FilterOptions = null)

Sample

DeleteEmployees(  "tenant1user1@company.com", "tenant1user1@epmsuite.com",
"tenant1code", "ScenarioCode1", EmployeeFilterOptions.Scenario , filterOptions);

Success Response

<DeleteEmployeesResult> 
	<KeyValues>
			<Key>DTHR</Key>
			<Value>Employees are delted for Scenario DTHR successfully for budget entities
	</KeyValues>
</DeleteEmployeesResult>

Invalid Response

An invalid response could be due to: 

• LoginName is empty or invalid email
• Invalid or empty password
• Invalid or empty TenantCode
• Invalid or empty ScenarioCode
• Invalid or empty EmployeeFilterOptions
• Empty FilterOptions (e.g., HomeBudgetEntities/Employees)