Load Employees

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

You will be able to update employee data or an employee position in the LoadEmployee API. You can either update a single or multiple employee position. If multiple positions are specified in the data load, you will have to provide new values for the Employee Number, Employee Name, and Employee Position Description fields. All the updated values will be reflected in an Audit log file. In addition, you will now be able to process employee data using the process option. The example below creates/updates employees in the tenant1code application.

Note

Existing compensations are overwritten with any compensations mapped against the employee type code. Allocations are also overridden.

Note

If duplicate positions exist, we do not load/update such positions.

Method
POST

Endpoint Url Syntax
/HostApi/HostAPI_StateFree.asmx

Content Type
text/xml

Headers

Key	Value
SOAPAction	http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19/LoadEmployees

Syntax

public EmployeeStatus[] LoadEmployees(string LoginName, string Password, string TenantCode, EmployeePosition[] employees, DateTime payRollUploadDate)

Example

LoadEmployees( "tenant1user1@company.com", "tenant1user1@epmsuite.com", "tenant1code", employees, DateTime.UtcNow)

Success Response

<soap:Body> <LoadEmployeesResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2020/03/19">
<LoadEmployeesResult> <EmployeeStatus> <EmployeeInfo>
<ScenarioCode>Default Scenario</ScenarioCode>
<HomeBudgetEntityCode>1000</HomeBudgetEntityCode> <Number>12543</Number>
<Name>Ben Parker</Name>
<HireDate?2020-02-22T08:22:54</HireDate> </EmployeeInfo>
<Status>true</Status>
<ErrorMessage>Employee added sucessfully.</ErrorMessage>
<PositionName>Admin</PositionName>
</EmployeeStatus> </LoadEmployeesResult>
</LoadEmployeesResponse>
</soap:Body>

Invalid Response

<soap:Body> <soap:Fault> <faulcode>soap:Server</faultcode><faultstring>Server was unable to process request. Payroll upload is mandatory.</faultstring> <detail/> </soap:Fault> </soap:Body>

An invalid response could due to be:

• LoginName invalid email or empty

• Invalid or empty password

• Invalid or empty TenantCode

• Empty payroll upload date or 01/01/0001 as value

• Input size exceeds 1,000 records per call

Was this article helpful?