extractEmployeeEditsByIDNum Method

Table of Contents

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

Function

  • Returns a list of supervisor edit adjustments made to the selected employee’s time card in a defined period

Syntax

  • AeEditAry = AeXMLBridge.extractEmployeeEditsByIDNum(IDNum, DateRangeEnum, MinDate, MaxDate);

Parameters

  • String - employee ID
  • Enumeration - TDateRangeEnum
  • String - begin date (yyyy-mm-dd format)
  • String - end date (yyyy-mm-dd format)

Return Value

  • Returns an array of TAeEdit structures

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
string empID = "1234";                                                     
// using employee# 1234
 
TDateRangeEnum dateRange = TDateRangeEnum.drCustom;                        
// extract employee edits for past 90 days
 
string minDate = DateTime.Now.AddDays(-90).ToString("yyyy-MM-dd");         
string maxDate = DateTime.Now.ToString("yyyy-MM-dd");
 
try
{
   TAeEdit[] edits = ws.extractEmployeeEditsByIDNum(empID, dateRange, minDate, maxDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
im empID As String = "1234"
' using employee# 1234
 
Dim dateRange As TDateRangeEnum = TDateRangeEnum.drCustom
' extract employee edits for past 90 days
 
Dim minDate As String = DateTime.Now.AddDays(-90).ToString("yyyy-MM-dd")
' since we are using drCustom we need to set the begin and end dates
Dim maxDate As String = DateTime.Now.ToString("yyyy-MM-dd")
 
Try
    Dim edits As TAeEdit() = ws.extractEmployeeEditsByIDNum(empID, dateRange, minDate, maxDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • The SiteID value returned in the TAeEdit structure is the unique identifier for the edit. This value can then be used to reference the specific edit
  • Edits can only be modified from the previous period forward. If the edit falls further in the past, it is considered historical and cannot be edited
  • If the SiteID value is desired, the TDateRangeEnum must specify Previous, Current, or Next periods. All others will return a -1 for the SiteID value. This is because all other date ranges pull edits from data archives, which cannot be modified
  • When setting the TDateRange parameter, you can only use the drCurrPeriod or drPrevPeriod values

Possible Errors

  • Unable to locate employee with identifier
  • yyyy-mm-dd is required [Date supplied in invalid format]

Alternate Method

extractEmployeeEditsByFilekey

extractAttendanceMultiFormActivityUsingHyperQuery
extractEmployeeDailySummsByIDNum
extractEmployeeDailySummsInPeriodByIDNum
extractEmployeeDurationTotalsByIDNum
extractEmployeePeriodFrameByIDNum
extractEmployeePeriodShiftDetailsByIDNum
extractEmployeePeriodShiftsByIDNum
extractEmployeePeriodShiftTransactionsByIDNum
extractEmployeePeriodSummsByIDNum
extractEmployeeSummsByIDNum
extractEmployeeTransactionsByIDNum
extractPayPeriodSummaries
extractRangedTransactionsUsingHyperQuery
getManuallySelectedCalculatedData

Back to Top