POST api/Pension/{employeeNo}/{schemeName}/{joiningDate}

Update a Pension Scheme for an Employee. The key for updates is the PensionScheme and the JoiningDate

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

schemeName

Pension Scheme Name

string

Required

joiningDate

joining Date in the format dd-MM-yyyy

date

Required

Body Parameters

In request Body: Employee Pension Details

PensionDetail
NameDescriptionTypeAdditional information
SchemeName

string

Required

JoiningDate

date

Required

LeavingDate

Must be after JoiningDate if present

date

None.

Membership

string

None.

CustomRef1

string

None.

CustomRef2

string

None.

SCONCode

string

None.

EmployeeContribution

decimal number

None.

EmployerContribution

decimal number

None.

EmployeePercent

decimal number

None.

EmployerPercent

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "SchemeName": "sample string 1",
  "JoiningDate": "2024-12-23T06:46:59.4328862+00:00",
  "LeavingDate": "2024-12-23T06:46:59.4328862+00:00",
  "Membership": "sample string 3",
  "CustomRef1": "sample string 4",
  "CustomRef2": "sample string 5",
  "SCONCode": "sample string 6",
  "EmployeeContribution": 1.0,
  "EmployerContribution": 1.0,
  "EmployeePercent": 1.0,
  "EmployerPercent": 1.0
}

application/xml, text/xml

Sample:
<PensionDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
  <CustomRef1>sample string 4</CustomRef1>
  <CustomRef2>sample string 5</CustomRef2>
  <EmployeeContribution>1</EmployeeContribution>
  <EmployeePercent>1</EmployeePercent>
  <EmployerContribution>1</EmployerContribution>
  <EmployerPercent>1</EmployerPercent>
  <JoiningDate>2024-12-23T06:46:59.4328862+00:00</JoiningDate>
  <LeavingDate>2024-12-23T06:46:59.4328862+00:00</LeavingDate>
  <Membership>sample string 3</Membership>
  <SCONCode>sample string 6</SCONCode>
  <SchemeName>sample string 1</SchemeName>
</PensionDetail>

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>