getEmployeeMeasurementPeriodRecommendation 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 the recommendation on how to close the employee’s measurement period

Syntax

  • AeACAMPeriodRecommendation = AeXMLBridge.getEmployeeMeasurementPeriodRecommendation(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 with filekey 1234

string periodBegin = DateTime.Now.AddDays(-180).ToString("yyyy-MM-dd");        
// setting date parameters
string periodEnd = DateTime.Now.ToString("yyyy-MM-dd");
 
try
{
   TAeACAMperiodRecommendation = ws.getEmployeeMeasurementPeriodRecommendation(filekey, periodBegin, periodEnd);
}
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 with filekey 1234
 
Dim periodBegin As String = DateTime.Now.AddDays(-180).ToString("yyyy-MM-dd")
' setting date parameters
Dim periodEnd As String = DateTime.Now.ToString("yyyy-MM-dd")
 
Try
    TAeACAMperiodRecommendation = ws.getEmployeeMeasurementPeriodRecommendation(filekey, periodBegin, periodEnd)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • None

Possible Errors

  • No Such Employee with Filekey
  • yyyy-mm-dd is required [Date supplied in invalid format]
  • Unable to locate Stability Period starting after

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

Back to Top