PUT api/AbsenceExt/{employeeNo}

Add an Absence to an Employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

Body Parameters

In request Body: Employee Absence Details

AbsenceExtDetail
NameDescriptionTypeAdditional information
StartDate

date

Required

EndDate

Must be after StartDate if present

date

None.

AbsenceType

SSP,HOL,SMP,SAP,SPPA,SPPB,SHPPA,SHPPB,SPBP

string

None.

DueDate

Used with SMP, SPPB, SHPPB

date

None.

BirthDate

Used with SMP, SPPB, SHPPB

date

None.

Stillborn

Used with SMP, SPPB, SHPPB, SPBP

boolean

Nullable

MatchDate

Used with SAP, SPPA, SHPPA

date

None.

PlacedDate

Used with SAP, SPPA, SHPPA

date

None.

DeathDate

Used with SPBP

date

None.

StopPayment

boolean

None.

StopPaymentDate

date

None.

AWEOverride

Average Weekly Earning Override

decimal number

Nullable

Request Formats

application/json, text/json

Sample:
{
    "StartDate": "2022-02-08T00:00:00",
    "EndDate": "2022-02-09T00:00:00",
    "AbsenceType": "SSP",
    "DueDate": null,
    "BirthDate": null,
    "Stillborn": null,
    "MatchDate": null,
    "PlacedDate": null,
    "DeathDate": null,
    "StopPayment": false,
    "StopPaymentDate": "2022-02-08T00:00:00",
    "AWEOverride": 5.0
}

application/xml, text/xml

Sample:
<AbsenceExtDetail>
    <AWEOverride>5.0</AWEOverride>
    <AbsenceType>SSP</AbsenceType>
    <BirthDate>null</BirthDate>
    <DeathDate>null</DeathDate>
    <DueDate>null</DueDate>
    <EndDate>2022-02-09T00:00:00</EndDate>
    <MatchDate>null</MatchDate>
    <PlacedDate>null</PlacedDate>
    <StartDate>2022-02-08T00:00:00</StartDate>
    <Stillborn>null</Stillborn>
    <StopPayment>true</StopPayment>
    <StopPaymentDate>2022-02-08T00:00:00</StopPaymentDate>
</AbsenceExtDetail>

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>