extractEmployeeLeaveRequestsByIDNum() 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

  • Extract previously submitted employee leave requests within a specified date range

Syntax

  • AeTimeOffRequestAry = AEXMLBridge.extractEmployeeLeaveRequestsByIDNum(IDNum, RTOFilterEnum, StateID, MinDate, Max Date);

Parameters

  • String - employee ID
  • Enumeration - TRTOFilterEnum
  • Integer - state ID
  • 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
16
17
18
19
20
21
string empID = "1234";                                                    
 // using employee# 1234
 
TRTOFilterEnum filter = TRTOFilterEnum.rfCreated;                          
// look for requests created during the date range we pass
 
int stateID = 1;                                                          
 // 1-Requested, 2-Approved, 3-Unapproved, 4-Cancel

string minDate = DateTime.Now.ToString("yyyy-MM-dd");                      
string maxDate = DateTime.Now.AddDays(60).ToString("yyyy-MM-dd");
// setting the date range

try
{
   TAeTimeOffRequest[] requests = ws.extractEmployeeLeaveRequestsByIDNum(empID, filter, stateID, 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 empID As String = "1234"
' using employee# 1234
 
Dim filter As TRTOFilterEnum = TRTOFilterEnum.rfCreated
' look for requests created during the date range we pass
 
Dim stateID As Integer = 1
' 1-Requested, 2-Approved, 3-Unapproved, 4-Cancel
 
Dim minDate As String = DateTime.Now.ToString("yyyy-MM-dd")
' setting the date range
Dim maxDate As String = DateTime.Now.AddDays(60).ToString("yyyy-MM-dd")
 
Try
    Dim requests As TAeTimeOffRequest() = ws.extractEmployeeLeaveRequestsByIDNum(empID, filter, stateID, minDate, maxDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Date parameters must be entered in yyyy-mm-dd format
  • See sample code (above) for StateID values
  • StateID value is used only if TRTOFilterEnum is frState or frStateCreated (otherwise set to “1”)

Possible Errors

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

Alternate Method

extractEmployeeLeaveRequestsByFilekey

approveCancelLeaveRequestEntry
approveCancelLeaveRequestEntryMess
approveLeaveRequestEntry
approveLeaveRequestEntryEx
approveLeaveRequestEntryMess
denyCancelLeaveRequestEntry
denyCancelLeaveRequestEntryMess
denyLeaveRequestEntryEx
denyLeaveRequestEntryMess
describeLeaveRequestEntry
empCancelLeaveRequestEntry
empCancelLeaveRequestEntryMess
empRemoveLeaveRequestEntry
empRemoveLeaveRequestEntryMess
extractEmployeeLeaveRequest
extractEmployeeLeaveRequestHist
extractLeaveRequestsByState
extractTimeOffRequestStates
leaveRequestIsCancelable
leaveRequestIsRemovable
removeLeaveRequestEntry
submitTimeOffRequest
submitTimeOffRequestEx
submitTimeOffRequestMess

Back to Top