getEmployeeACAPeriods Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Related Methods

Function

  • Returns information on an employee’s ACA periods for a selected date range

Syntax

  • AeEmpACAPeriodAry = AeXMLBridge.getEmployeeACAPeriods(Filekey, PeriodBegin, PeriodEnd);

Parameters

  • Integer - employee filekey
  • String - begin date (yyyy-MM-dd format)
  • String - end date (yyyy-MM-dd format)

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
int filekey = 1234;                                                        
// using employee 1234
 
string beginDate = DateTime.Now.AddDays(-120).ToString("yyyy-MM-dd");      
// setting date range parameters
string endDate = DateTime.Now.ToString("yyyy-MM-dd");
 
try
{
   TAeEmpACAPeriod[] periods = ws.getEmployeeACAPeriods(filekey, beginDate, endDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
Dim filekey As Integer = 1234
' using employee 1234
 
Dim beginDate As String = DateTime.Now.AddDays(-120).ToString("yyyy-MM-dd")
' setting date range parameters
Dim endDate As String = DateTime.Now.ToString("yyyy-MM-dd")
 
Try
    Dim periods As TAeEmpACAPeriod() = ws.getEmployeeACAPeriods(filekey, beginDate, endDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • This call can return an empty structure

Possible Errors

  • No Such Employee with Filekey
  • yyyy-mm-dd is required [Invalid argument to date encode]

changeEmployeeACAFullTimeStatus
closeEmployeeMeasurementPeriod
extractACAEmployeesFTStatusAsOf
extractACALEDSummaries
getClosedEmployeeMeasurementPeriods
getControlGroups
getEmployeeACAByIDNum
getEmployeeACADateRange
getEmployeeEarliestStabilityPeriodStart
getEmployeeMeasurementPeriodRecommendation
getEmployeeMeasurementPeriodWasClosed
getEmptyEmployeeACA
getExpiredUnaddressedMeasurementPeriods
getFirstDateOfACAServiceHours
restartEmployeeACAPeriods
reverseClosedEmployeeMeasurementPeriod
revertEmployeeACAAssignments
setEmployeeACA
submitEmployeeEarnings

Back to Top