GET api/Leave/GetLeaveBalance?APIKey={APIKey}&LeaveTypeID={LeaveTypeID}&UserID={UserID}

APT to get leave Balance

Request Information

URI Parameters

Name	Type	Additional information
APIKey	string	None.
LeaveTypeID	integer	None.
UserID	integer	None.

Body Parameters

None.

Response Information

Resource Description

LeaveBalanceResponse

Name	Type	Additional information
LeaveBalanceResultList	Collection of LeaveBalanceResponseDataModel	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "leaveBalanceResultList": [
    {
      "parentLeaveTypeID": 1,
      "leaveTypeID": 2,
      "leaveType": "sample string 3",
      "allowedLeave": 4,
      "consumedLeave": 5.1,
      "availableLeave": 6.1
    },
    {
      "parentLeaveTypeID": 1,
      "leaveTypeID": 2,
      "leaveType": "sample string 3",
      "allowedLeave": 4,
      "consumedLeave": 5.1,
      "availableLeave": 6.1
    }
  ],
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<LeaveBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
  <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code>
  <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message>
  <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID>
  <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord>
  <LeaveBalanceResultList>
    <LeaveBalanceResponseDataModel>
      <AllowedLeave>4</AllowedLeave>
      <AvailableLeave>6.1</AvailableLeave>
      <ConsumedLeave>5.1</ConsumedLeave>
      <LeaveType>sample string 3</LeaveType>
      <LeaveTypeID>2</LeaveTypeID>
      <ParentLeaveTypeID>1</ParentLeaveTypeID>
    </LeaveBalanceResponseDataModel>
    <LeaveBalanceResponseDataModel>
      <AllowedLeave>4</AllowedLeave>
      <AvailableLeave>6.1</AvailableLeave>
      <ConsumedLeave>5.1</ConsumedLeave>
      <LeaveType>sample string 3</LeaveType>
      <LeaveTypeID>2</LeaveTypeID>
      <ParentLeaveTypeID>1</ParentLeaveTypeID>
    </LeaveBalanceResponseDataModel>
  </LeaveBalanceResultList>
</LeaveBalanceResponse>

multipart/form-data

Sample:

<LeaveBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord><LeaveBalanceResultList><LeaveBalanceResponseDataModel><AllowedLeave>4</AllowedLeave><AvailableLeave>6.1</AvailableLeave><ConsumedLeave>5.1</ConsumedLeave><LeaveType>sample string 3</LeaveType><LeaveTypeID>2</LeaveTypeID><ParentLeaveTypeID>1</ParentLeaveTypeID></LeaveBalanceResponseDataModel><LeaveBalanceResponseDataModel><AllowedLeave>4</AllowedLeave><AvailableLeave>6.1</AvailableLeave><ConsumedLeave>5.1</ConsumedLeave><LeaveType>sample string 3</LeaveType><LeaveTypeID>2</LeaveTypeID><ParentLeaveTypeID>1</ParentLeaveTypeID></LeaveBalanceResponseDataModel></LeaveBalanceResultList></LeaveBalanceResponse>