extractEmployeeDurationTotalsByFilekey() Method

Table of Contents

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

Function

  • Returns a summarized list of employee calculations for a specified date range

Syntax

  • AePayLineAry = AeXMLBridge.extractEmployeeDurationTotalsByFilekey(Filekey, DurationDetailEnum, DateRangeEnum, MinDate, MaxDate);

Parameters

  • Integer - employee filekey
  • Enumeration - TDurationDetailEnum
  • Enumeration - TDateRangeEnum
  • String - being 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
16
17
18
19
20
21
22

int filekey = 1234;                                                        
// using employee# 1234
  
TDurationDetailEnum duration = TDurationDetailEnum.ddePayDes;              
// duration detail will be Pay Designations
  
TDateRangeEnum dateRange = TDateRangeEnum.drCustom;                        
// when using drCustom, must set values for begin and end date parameters

string minDate = DateTime.Now.AddDays(-60).ToString("yyyy-MM-dd");        
string maxDate = DateTime.Now.ToString("yyyy-MM-dd");
 // using prior 60 days

try
{
   TAePayLine[] paylines = ws.extractEmployeeDurationTotalsByFilekey(filekey, duration, dateRange, minDate, maxDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Dim filekey As Integer = 1234
' using employee# 1234
  
Dim duration As TDurationDetailEnum = TDurationDetailEnum.ddePayDes
' duration detail will be Pay Designations
  
Dim dateRange As TDateRangeEnum = TDateRangeEnum.drCustom
' when using drCustom, must set values for begin and end date parameters
Dim minDate As String = DateTime.Now.AddDays(-60).ToString("yyyy-MM-dd")
' using prior 60 days
Dim maxDate As String = DateTime.Now.ToString("yyyy-MM-dd")
  
Try
     Dim paylines As TAePayLine() = ws.extractEmployeeDurationTotalsByFilekey(filekey, duration, dateRange, minDate, maxDate)
Catch ex As Exception
     MessageBox.Show(ex.Message)
End Try

Remarks

  • When setting TDateRangeEnum to drCustom, you must enter the begin and end dates. Otherwise set these to nothing
  • If using custom dates they must follow the yyyy-mm-dd format

Possible Errors

  • No Such Employee with Filekey
  • yyyy-mm-dd is required [Date supplied in invalid format]

Preferred Method

extractEmployeeDurationTotalsByIDNum

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

Back to Top