Get Employees

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Used to get employees in the tenant. You can get only those employees which are accessible by a given user, even if the filter option is scenario. The example shown below will get the first 1,000 employee positions, based on the start index given, under scenario API3, in the APR08GOLDENTENANT tenant.

Note:

For allocations with multiple rows for the same department and compensations, you only get segments for one row. Also, for input compensations items, you get the average annual value.

Syntax

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

Sample

GetEmployees("tenant1user1@company.com", "tenant1user1@epmsuite.com",
"tenant1code", "ScenarioCode1", EmployeeFilterOptions.Scenario  , 0, arr);

Success Response

<EmployeePosition>
	<EmployeeInfo>
			<ScenarioCode>API3</ScenarioCode>
			<HomeBudgetEntityCode>new<</HomeBudgetEntityCode>
			<Number>Load1</Number>
			<Name>Load1</Name>
			<HireDate>2020-01-01T00:00:00</HireDate>
	</EmployeeInfo>
	<PositionName>Position1</PositionName>
	<PositionEntityCode>new</PositionEntityCode>
	<OtherSegmentCodes>
		<KeyValues>

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)

Was this article helpful?

What's Next

Process Employees