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

  • Extracts previously submitted employee leave requests by request state ID

Syntax

  • AeTimeOffRequestAry = AeXMLBridge.extractLeaveRequestsByState(StateID, ActiveStatusEnum, MinDate, MaxDate);

Parameters

  • Integer - State ID
  • Enumeration - TActiveStatusEnum
  • 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
int stateID = 1;                                                           
// 1 = submitted

TActiveStatusEnum activeStatus = TActiveStatusEnum.asActive;               
// selecting only active employees
 
string beginDate = DateTime.Now.ToString("yyyy-MM-dd");                  
string endDate = DateTime.Now.AddDays(30).ToString("yyyy-MM-dd");
  // set date range of leave rquests

try
{
   TAeTimeOffRequest[] reqs = ws.extractLeaveRequestsByState(stateID, activeStatus, beginDate, endDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Dim stateID As Integer = 1
' 1 = submitted
 
Dim activeStatus As TActiveStatusEnum = TActiveStatusEnum.asActive
' selecting only active employees
 
Dim beginDate As String = DateTime.Now.ToString("yyyy-MM-dd")
' set date range of leave rquests
Dim endDate As String = DateTime.Now.AddDays(30).ToString("yyyy-MM-dd")
 
Try
    Dim reqs As TAeTimeOffRequest() = ws.extractLeaveRequestsByState(stateID, activeStatus, beginDate, endDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Use extractTimeOffRequestStates to retrieve a list of valid Time Off Request statuses
  • Date parameters must be entered in yyyy-mm-dd format

Possible Errors

  • yyyy-mm-dd is required [Date supplied in invalid format]
  • invalid state ID

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

Back to Top