GET api/HolidayScheme/available

Get a list of all holiday schemes available to an employee

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Holiday Schemes

Collection of HolidaySchemeDetail

Name	Description	Type	Additional 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	(Not settable via REST) Indicates whether the holiday scheme is allow to go negative.	boolean	None.
EndDate		date	None.
AverageRateOverride		decimal number	None.
EnhancedScheme	Applicable for hourly/daily schemes.	boolean	Nullable
EnhancedThreshold	Threshold value for the enhanced holiday scheme (if applicable)	decimal number	None.
EnhancedThresholdOverride	Threshold value override for the enhanced holiday scheme (if applicable)	decimal number	None.
TakenToDate	For enhanced holiday schemes only. How many enhanced holiday days have already been used up out of the threshold.	decimal number	None.
EnhancedAverageRate	Average rate for the enhanced holiday scheme (if applicable)	decimal number	None.
EnhancedAverageRateOverride	Average rate override for the enhanced holiday scheme (if applicable)	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SchemeName": "sample string 1",
    "RolledOverDays": 2.0,
    "EffectiveDate": "2025-10-26T01:49:29.0033919+01:00",
    "AccrueDaysOverride": 1.0,
    "AccruedYTD": 1.0,
    "TakenYTD": 1.0,
    "AverageRate": 1.0,
    "AllowNegative": true,
    "EndDate": "2025-10-26T01:49:29.0033919+01:00",
    "AverageRateOverride": 1.0,
    "EnhancedScheme": true,
    "EnhancedThreshold": 1.0,
    "EnhancedThresholdOverride": 1.0,
    "TakenToDate": 1.0,
    "EnhancedAverageRate": 1.0,
    "EnhancedAverageRateOverride": 1.0
  },
  {
    "SchemeName": "sample string 1",
    "RolledOverDays": 2.0,
    "EffectiveDate": "2025-10-26T01:49:29.0033919+01:00",
    "AccrueDaysOverride": 1.0,
    "AccruedYTD": 1.0,
    "TakenYTD": 1.0,
    "AverageRate": 1.0,
    "AllowNegative": true,
    "EndDate": "2025-10-26T01:49:29.0033919+01:00",
    "AverageRateOverride": 1.0,
    "EnhancedScheme": true,
    "EnhancedThreshold": 1.0,
    "EnhancedThresholdOverride": 1.0,
    "TakenToDate": 1.0,
    "EnhancedAverageRate": 1.0,
    "EnhancedAverageRateOverride": 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>2025-10-26T01:49:29.0033919+01:00</EffectiveDate>
    <EndDate>2025-10-26T01:49:29.0033919+01:00</EndDate>
    <EnhancedAverageRate>1</EnhancedAverageRate>
    <EnhancedAverageRateOverride>1</EnhancedAverageRateOverride>
    <EnhancedScheme>true</EnhancedScheme>
    <EnhancedThreshold>1</EnhancedThreshold>
    <EnhancedThresholdOverride>1</EnhancedThresholdOverride>
    <RolledOverDays>2</RolledOverDays>
    <SchemeName>sample string 1</SchemeName>
    <TakenToDate>1</TakenToDate>
    <TakenYTD>1</TakenYTD>
  </HolidaySchemeDetail>
  <HolidaySchemeDetail>
    <AccrueDaysOverride>1</AccrueDaysOverride>
    <AccruedYTD>1</AccruedYTD>
    <AllowNegative>true</AllowNegative>
    <AverageRate>1</AverageRate>
    <AverageRateOverride>1</AverageRateOverride>
    <EffectiveDate>2025-10-26T01:49:29.0033919+01:00</EffectiveDate>
    <EndDate>2025-10-26T01:49:29.0033919+01:00</EndDate>
    <EnhancedAverageRate>1</EnhancedAverageRate>
    <EnhancedAverageRateOverride>1</EnhancedAverageRateOverride>
    <EnhancedScheme>true</EnhancedScheme>
    <EnhancedThreshold>1</EnhancedThreshold>
    <EnhancedThresholdOverride>1</EnhancedThresholdOverride>
    <RolledOverDays>2</RolledOverDays>
    <SchemeName>sample string 1</SchemeName>
    <TakenToDate>1</TakenToDate>
    <TakenYTD>1</TakenYTD>
  </HolidaySchemeDetail>
</ArrayOfHolidaySchemeDetail>