GET api/EmployeeLeaveForecasts/{id}

Gets the leave forecasts for an employee (employeeCode)

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

NameDescriptionTypeAdditional information
id

The employee's employee code.

string

Required

byDate

The date for the leave forecast.

date

Required

Body Parameters

None.

Response Information

Resource Description

EmployeeLeaveForecastView
NameDescriptionTypeAdditional information
EmpCode

string

None.

FirstName

string

None.

Surname

string

None.

LeaveType

string

None.

LeaveCode

string

None.

PostEntDate

date

None.

PostEntHours

decimal number

None.

PostEntDays

decimal number

None.

PostProDate

date

None.

PostProHours

decimal number

None.

PostProDays

decimal number

None.

CurrentAccrual
 Date

date

None.

CurrentAccrual
 Hours

decimal number

None.

CurrentAccrual
 Days

decimal number

None.

PreEntHours

decimal number

None.

PreEntDays

decimal number

None.

Pre78EntHours

decimal number

None.

Pre78EntDays

decimal number

None.

HoursPerDay

decimal number

None.

DaysPerWeek

decimal number

None.

FirstEntPeriod

boolean

None.

DefPostEntDate

date

None.

DefPostEntHours

decimal number

None.

DefPostEntDays

decimal number

None.

DefPostProDate

date

None.

DefPostProHours

decimal number

None.

DefPostProDays

decimal number

None.

DefTakenDate

date

None.

DefTakenHours

decimal number

None.

DefTakenDays

decimal number

None.

LatestBalance
 Date

date

None.

DailyAccrualHours
 Rate

decimal number

None.

Unprocessed
 Hours

decimal number

None.

UnprocessedDays

decimal number

None.

TakenHours

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "empCode": "sample string 2",
  "firstName": "sample string 3",
  "surname": "sample string 4",
  "leaveType": "sample string 5",
  "leaveCode": "sample string 6",
  "postEntDate": "2024-05-19T04:12:01.3288884+10:00",
  "postEntHours": 1.1,
  "postEntDays": 1.1,
  "postProDate": "2024-05-19T04:12:01.3288884+10:00",
  "postProHours": 1.1,
  "postProDays": 1.1,
  "currentAccrualDate": "2024-05-19T04:12:01.3288884+10:00",
  "currentAccrualHours": 1.1,
  "currentAccrualDays": 1.1,
  "preEntHours": 1.1,
  "preEntDays": 1.1,
  "pre78EntHours": 1.1,
  "pre78EntDays": 1.1,
  "hoursPerDay": 1.1,
  "daysPerWeek": 1.1,
  "firstEntPeriod": true,
  "defPostEntDate": "2024-05-19T04:12:01.3288884+10:00",
  "defPostEntHours": 1.1,
  "defPostEntDays": 1.1,
  "defPostProDate": "2024-05-19T04:12:01.3288884+10:00",
  "defPostProHours": 1.1,
  "defPostProDays": 1.1,
  "defTakenDate": "2024-05-19T04:12:01.3288884+10:00",
  "defTakenHours": 1.1,
  "defTakenDays": 1.1,
  "latestBalanceDate": "2024-05-19T04:12:01.3288884+10:00",
  "dailyAccrualHoursRate": 1.1,
  "unprocessedHours": 1.1,
  "unprocessedDays": 1.1,
  "takenHours": 1.1
}

application/xml, text/xml

Sample:
<EmployeeLeaveForecastView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <idEmployeeLeave>1</idEmployeeLeave>
  <EmpCode>sample string 2</EmpCode>
  <FirstName>sample string 3</FirstName>
  <Surname>sample string 4</Surname>
  <LeaveType>sample string 5</LeaveType>
  <LeaveCode>sample string 6</LeaveCode>
  <PostEntDate>2024-05-19T04:12:01.3288884+10:00</PostEntDate>
  <PostEntHours>1.1</PostEntHours>
  <PostEntDays>1.1</PostEntDays>
  <PostProDate>2024-05-19T04:12:01.3288884+10:00</PostProDate>
  <PostProHours>1.1</PostProHours>
  <PostProDays>1.1</PostProDays>
  <CurrentAccrualDate>2024-05-19T04:12:01.3288884+10:00</CurrentAccrualDate>
  <CurrentAccrualHours>1.1</CurrentAccrualHours>
  <CurrentAccrualDays>1.1</CurrentAccrualDays>
  <PreEntHours>1.1</PreEntHours>
  <PreEntDays>1.1</PreEntDays>
  <Pre78EntHours>1.1</Pre78EntHours>
  <Pre78EntDays>1.1</Pre78EntDays>
  <HoursPerDay>1.1</HoursPerDay>
  <DaysPerWeek>1.1</DaysPerWeek>
  <FirstEntPeriod>true</FirstEntPeriod>
  <DefPostEntDate>2024-05-19T04:12:01.3288884+10:00</DefPostEntDate>
  <DefPostEntHours>1.1</DefPostEntHours>
  <DefPostEntDays>1.1</DefPostEntDays>
  <DefPostProDate>2024-05-19T04:12:01.3288884+10:00</DefPostProDate>
  <DefPostProHours>1.1</DefPostProHours>
  <DefPostProDays>1.1</DefPostProDays>
  <DefTakenDate>2024-05-19T04:12:01.3288884+10:00</DefTakenDate>
  <DefTakenHours>1.1</DefTakenHours>
  <DefTakenDays>1.1</DefTakenDays>
  <LatestBalanceDate>2024-05-19T04:12:01.3288884+10:00</LatestBalanceDate>
  <DailyAccrualHoursRate>1.1</DailyAccrualHoursRate>
  <UnprocessedHours>1.1</UnprocessedHours>
  <UnprocessedDays>1.1</UnprocessedDays>
  <TakenHours>1.1</TakenHours>
</EmployeeLeaveForecastView>