GET api/HolidayScheme/{employeeNo}

Get a list of all holiday scheme details for an employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

Body Parameters

None.

Response Information

Resource Description

All Employee Holiday Scheme Details

Collection of HolidaySchemeDetail
NameDescriptionTypeAdditional information
SchemeName

string

Required

RolledOverDays

Top Up Schemes: Annual Entitlement. All others: Carried Forward (Hours or Days based on scheme)

decimal number

None.

EffectiveDate

date

Required

AccrueDaysOverride

decimal number

None.

AccruedYTD

decimal number

None.

TakenYTD

decimal number

None.

AverageRate

decimal number

None.

AllowNegative

boolean

None.

EndDate

date

None.

AverageRateOverride

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SchemeName": "sample string 1",
    "RolledOverDays": 2.0,
    "EffectiveDate": "2024-12-23T06:50:27.7784793+00:00",
    "AccrueDaysOverride": 1.0,
    "AccruedYTD": 1.0,
    "TakenYTD": 1.0,
    "AverageRate": 1.0,
    "AllowNegative": true,
    "EndDate": "2024-12-23T06:50:27.7784793+00:00",
    "AverageRateOverride": 1.0
  },
  {
    "SchemeName": "sample string 1",
    "RolledOverDays": 2.0,
    "EffectiveDate": "2024-12-23T06:50:27.7784793+00:00",
    "AccrueDaysOverride": 1.0,
    "AccruedYTD": 1.0,
    "TakenYTD": 1.0,
    "AverageRate": 1.0,
    "AllowNegative": true,
    "EndDate": "2024-12-23T06:50:27.7784793+00:00",
    "AverageRateOverride": 1.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfHolidaySchemeDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
  <HolidaySchemeDetail>
    <AccrueDaysOverride>1</AccrueDaysOverride>
    <AccruedYTD>1</AccruedYTD>
    <AllowNegative>true</AllowNegative>
    <AverageRate>1</AverageRate>
    <AverageRateOverride>1</AverageRateOverride>
    <EffectiveDate>2024-12-23T06:50:27.7784793+00:00</EffectiveDate>
    <EndDate>2024-12-23T06:50:27.7784793+00:00</EndDate>
    <RolledOverDays>2</RolledOverDays>
    <SchemeName>sample string 1</SchemeName>
    <TakenYTD>1</TakenYTD>
  </HolidaySchemeDetail>
  <HolidaySchemeDetail>
    <AccrueDaysOverride>1</AccrueDaysOverride>
    <AccruedYTD>1</AccruedYTD>
    <AllowNegative>true</AllowNegative>
    <AverageRate>1</AverageRate>
    <AverageRateOverride>1</AverageRateOverride>
    <EffectiveDate>2024-12-23T06:50:27.7784793+00:00</EffectiveDate>
    <EndDate>2024-12-23T06:50:27.7784793+00:00</EndDate>
    <RolledOverDays>2</RolledOverDays>
    <SchemeName>sample string 1</SchemeName>
    <TakenYTD>1</TakenYTD>
  </HolidaySchemeDetail>
</ArrayOfHolidaySchemeDetail>