GET api/LeaveClass

Retrieves leave class configuration data with optional filtering by leave type.

Request Information

URI Parameters

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

Name	Description	Type	Additional information
page	Page number (default: 1)	integer	Default value is 1
pageSize	Number of records per page (default: 1000)	integer	Default value is 1000
leaveType	Optional leave type filter (e.g., A = Annual, S = Sick, R = RDO, L = Long Service)	string	None.

Body Parameters

None.

Response Information

Resource Description

Leave class configuration records grouped under a company identifier.

LeaveClassResponseView

Name	Type	Additional information
companyId	integer	None.
leaveTypes	Collection of LeaveClassView	None.
page	integer	None.
pageSize	integer	None.
totalCount	integer	None.
totalPages	integer	None.
countThisPage	integer	None.
hasPreviousPage	boolean	None.
hasNextPage	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "companyId": 1,
  "leaveTypes": [
    {
      "leaveTypesId": 2,
      "leaveType": "sample string 3",
      "classCode": 4,
      "description": "sample string 5",
      "leaveCode": "sample string 6",
      "prorataEntitle": 1.0,
      "prorataEach": "sample string 7",
      "prorataPeriod": 1.0,
      "prorataPeriodEach": "sample string 8",
      "entitleMax": 1.0,
      "entitleEach": "sample string 9",
      "entitlePeriod": 1.0,
      "entitlePeriodEach": "sample string 10",
      "isHourly": "sample string 11",
      "accrualRate": 1.0,
      "alPublicHoliday": "sample string 12",
      "slClassification": "sample string 13"
    },
    {
      "leaveTypesId": 2,
      "leaveType": "sample string 3",
      "classCode": 4,
      "description": "sample string 5",
      "leaveCode": "sample string 6",
      "prorataEntitle": 1.0,
      "prorataEach": "sample string 7",
      "prorataPeriod": 1.0,
      "prorataPeriodEach": "sample string 8",
      "entitleMax": 1.0,
      "entitleEach": "sample string 9",
      "entitlePeriod": 1.0,
      "entitlePeriodEach": "sample string 10",
      "isHourly": "sample string 11",
      "accrualRate": 1.0,
      "alPublicHoliday": "sample string 12",
      "slClassification": "sample string 13"
    }
  ],
  "page": 2,
  "pageSize": 3,
  "totalCount": 4,
  "totalPages": 5,
  "countThisPage": 6,
  "hasPreviousPage": true,
  "hasNextPage": true
}