PUT api/HolidayScheme/{employeeNo}

Add holiday scheme details to an Employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

Body Parameters

In request Body: Employee Holiday Scheme Details

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.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

ResultWithMessage
NameDescriptionTypeAdditional information
result

'OK', 'Error'

string

None.

message

Returns if result is Error

string

None.

returnValue

string

None.

Response Formats

application/json, text/json

Sample:
{
    "result": "OK"
}

{
    "result": "Error",
    "message": "Unable to save: the..."
}

application/xml, text/xml

Sample:
<ResultWithMessage>
    <result>OK</result>
</ResultWithMessage>

<ResultWithMessage>  
    <result>Error</result>
    <message>Unable to save: the...</message>
</ResultWithMessage>