HR Leave Request
|
URL |
Verbs |
Function |
Available |
|
/HRLeaveRequest |
GET |
Query a list of all HR Leave Requests |
2019.1 |
|
/HRLeaveRequest/<reference> |
GET |
Query a single HR Leave Request by its reference |
2019.1 |
| /HRLeaveRequest | POST | Add a new HR Leave Request | 2019.1 |
| /HRLeaveRequest/<reference> | POST | Update an existing HR Leave Request | 2019.1 |
Supported modifiers
|
Query String |
Definition |
Sample
|
Available |
|---|---|---|---|
| status | Return HR Leave Requests of a particular status, supports array of values delimited by | | status=Approved | 2023.2 – &status= Approval|Approved array of values supported |
| treeName and treeBranch | Return a list of HR Leave Requests assigned to a nominated branch of a nominated tree | treeName=Colour-AUS&treeBranch=Blue | |
| person | Return a list of HR Leave Requests for a specific HR Person | person=1000 | |
| leaveType | Return HR Leave Requests of a particular type | leaveType=201 | |
| fromDate | Return HR Leave Requests that end before this date | fromDate=2017-01-12 | |
| toDate | Return HR Leave Requests that start after this date | toDate=2018-01-31 | |
| action |
Allow you to perform the following actions on a HR Leave Request
|
action=submit or action=cancel | |
| assignedTeam | Return a list of HR Leave Requests for a specific Team | assignedTeam=HR Monthly | 2023.1 |
| canBeApprovedByUser | Return a list of HR Leave Requests that can be approved by a User | canBeApprovedByUser=Super | 2023.1 |
| canBeApprovedByTeam | Return a list of HR Leave Requests that can be approved by any Team member | canBeApprovedByTeam=HR Monthly | 2023.1 |
Security Linked Menu
|
Menu Item
|
Located
|
|---|---|
| Leave Request Entry | HR / Leave Planning |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<HRLeaveRequest>
<Reference>1000</Reference>
<Reason/>
<Edition>8</Edition>
<Person>1000</Person>
<LeaveType>202</LeaveType>
<Status>Approved</Status>
<IsEmailOnApproval>true</IsEmailOnApproval>
<Notes/>
<DateAdvance>2011-06-17</DateAdvance>
<DateFrom>2011-06-18</DateFrom>
<DateTo>2011-06-22</DateTo>
<IsTimeRange>false</IsTimeRange>
<TimeFrom>00:00:00</TimeFrom>
<TimeTo>00:00:00</TimeTo>
<UseEnteredLeave>false</UseEnteredLeave>
<EnteredLeave>0.0000</EnteredLeave>
<CalculatedDays>5.0000</CalculatedDays>
<CalculatedHours>40.0000</CalculatedHours>
<CalculatedWeeks>0.6000</CalculatedWeeks>
<CancelReason/>
<RejectedReason/>
<IsEnterable>false</IsEnterable>
<CanBeCancelled>true</CanBeCancelled>
<CanBeDeleted>false</CanBeDeleted>
<CanBeSubmitted>false</CanBeSubmitted>
<UserDefinedFields collection='true' count='0'/>
<Trees collection='true' count='0'/>
</HRLeaveRequest>