POST api/Person/{employeeNo}

Update an Employee The key is the Employee No

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

Body Parameters

In request Body: Employee Person Details

PersonDetail
NameDescriptionTypeAdditional information
Person

PersonDetails

None.

AddressDetail

Required on Add

AddressDetails

None.

EmploymentDetail

EmploymentDetails

None.

NIDetail

NIDetails

None.

PaymentDetail

Must be entered when the method of payment is BACS

PaymentDetails

None.

MigratedDetail

MigratedDetails

Nullable

StarterStatementDetail

StarterStatementDetails

Nullable

P45Detail

P45Details

Nullable

TaxDetail

TaxDetails

Nullable

Request Formats

application/json, text/json

Sample:
{
    "Person": {
        "EmployeeID": 1582,
        "EmployeeNumber": "104856",
        "Title": "",
        "FirstName": "Jonathon",
        "MiddleNames": "",
        "LastName": "Hurt",
        "KnownAs": "",
        "DateOfBirth": "1973-05-14T00:00:00",
        "Gender": "M",
        "Email": "example@example.com",
        "PayslipNotification": false,
        "SMSPayslipNotification": false,
        "PostponeDate": null,
        "OptOutDate": null,
        "Method": "BACS",
        "HolidayScheme": "",
        "AccrueDaysOverride": null,
        "OSPScheme": ""
    },
    "AddressDetail": {
        "Date": "2021-07-22T00:00:00",
        "AddressLine1": "Dummy address 1",
        "AddressLine2": "Some line",
        "AddressLine3": "",
        "Town": "Norwich",
        "County": "Suffolk",
        "Postcode": "IP767TG"
    },
    "EmploymentDetail": {
        "DateOfJoining": "2021-07-23T00:00:00",
        "ServiceStartDate": "2021-07-22T00:00:00",
        "Payroll": "MONTHLY",
        "Workgroup": "FULLTIME",
        "HoursCategory": "D",
        "IrregularPayments": false,
        "ContractedHours": 37.5,
        "WorkerPayType": "Salaried",
        "OffPayrollWorker": false,
        "JobTitle": "",
        "Apprentice": false
    },
    "NIDetail": {
        "NINumber": "AA776878",
        "NITableLetter": "A",
        "Director": false,
        "NonCumulativeNI": false,
        "DirectorStartDate": null
    },
    "PaymentDetail": {
        "AccountName": "RICHARDBANK",
        "AccountNumber": "17380536",
        "SortCode": "111210",
        "RollNumber": ""
    },
    "MigratedDetail": {
        "Migrated": "Y",
        "MigratedTaxCode": "1257L",
        "MigratedWk1Mth1": false,
        "MigratedStudentLoanPlan": 1
    },
    "StarterStatementDetail": {
        "StarterStatement": "A",
        "StudentLoanPlanType": null,
        "StudentLoanNotRepaid": false,
        "StudentLoanRepayDirectly": false,
        "StudentLoanBeforeLast6April": false,
        "PostgraduateLoan": false,
        "PostgraduateLoanRepayDirectly": false,
        "PostgraduateLoanBeforeLast6April": false,        
        "NoStatementSigned": false
    },
    "P45Detail": {
        "P45EmployersReference": "",
        "P45LeavingDate": null,
        "P45PeriodNo": 0,
        "P45TaxablePay": 0.0,
        "P45TaxPaid": 0.0,
        "P45TaxCode": "",
        "P45Wk1Mth1": false,
        "P45TaxDistrictNo": "",
        "P45PayFrequency": ""
    },
    "TaxDetail": {
        "StartDate": "2021-07-23T00:00:00",
        "TaxCode": "1257L",
        "TaxBasis": false
    }    
}

application/xml, text/xml

Sample:
<PersonDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
  <AddressDetail>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressLine3>sample string 3</AddressLine3>
    <County>sample string 5</County>
    <Date>2024-12-23T06:59:27.1122023+00:00</Date>
    <Postcode>sample string 6</Postcode>
    <Town>sample string 4</Town>
  </AddressDetail>
  <EmploymentDetail>
    <Apprentice>true</Apprentice>
    <ContractedHours>1</ContractedHours>
    <DateOfJoining>2024-12-23T06:59:27.1122023+00:00</DateOfJoining>
    <HoursCategory>65</HoursCategory>
    <IrregularPayments>true</IrregularPayments>
    <JobTitle>sample string 8</JobTitle>
    <OffPayrollWorker>true</OffPayrollWorker>
    <Payroll>sample string 3</Payroll>
    <ServiceStartDate>2024-12-23T06:59:27.1122023+00:00</ServiceStartDate>
    <WorkerPayType>sample string 7</WorkerPayType>
    <Workgroup>sample string 4</Workgroup>
  </EmploymentDetail>
  <MigratedDetail>
    <Migrated>65</Migrated>
    <MigratedStudentLoanPlan>1</MigratedStudentLoanPlan>
    <MigratedTaxCode>sample string 2</MigratedTaxCode>
    <MigratedWk1Mth1>true</MigratedWk1Mth1>
  </MigratedDetail>
  <NIDetail>
    <Director>true</Director>
    <DirectorStartDate>2024-12-23T06:59:27.1122023+00:00</DirectorStartDate>
    <NINumber>sample string 1</NINumber>
    <NITableLetter>sample string 2</NITableLetter>
    <NonCumulativeNI>true</NonCumulativeNI>
  </NIDetail>
  <P45Detail>
    <P45EmployersReference>sample string 1</P45EmployersReference>
    <P45LeavingDate>2024-12-23T06:59:27.1122023+00:00</P45LeavingDate>
    <P45PayFrequency>sample string 6</P45PayFrequency>
    <P45PeriodNo>2</P45PeriodNo>
    <P45TaxCode>sample string 3</P45TaxCode>
    <P45TaxDistrictNo>sample string 5</P45TaxDistrictNo>
    <P45TaxPaid>1</P45TaxPaid>
    <P45TaxablePay>1</P45TaxablePay>
    <P45Wk1Mth1>true</P45Wk1Mth1>
  </P45Detail>
  <PaymentDetail>
    <AccountName>sample string 1</AccountName>
    <AccountNumber>sample string 2</AccountNumber>
    <RollNumber>sample string 4</RollNumber>
    <SortCode>sample string 3</SortCode>
  </PaymentDetail>
  <Person>
    <AccrueDaysOverride>1</AccrueDaysOverride>
    <DateOfBirth>2024-12-23T06:59:27.1122023+00:00</DateOfBirth>
    <Email>sample string 9</Email>
    <EmployeeID>1</EmployeeID>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <FirstName>sample string 3</FirstName>
    <Gender>65</Gender>
    <HolidayScheme>sample string 11</HolidayScheme>
    <KnownAs>sample string 6</KnownAs>
    <LastName>sample string 5</LastName>
    <Method>sample string 10</Method>
    <MiddleNames>sample string 4</MiddleNames>
    <OSPScheme>sample string 12</OSPScheme>
    <OptOutDate>2024-12-23T06:59:27.1122023+00:00</OptOutDate>
    <PayslipNotification>true</PayslipNotification>
    <PostponeDate>2024-12-23T06:59:27.1122023+00:00</PostponeDate>
    <SMSPayslipNotification>true</SMSPayslipNotification>
    <Title>sample string 2</Title>
  </Person>
  <StarterStatementDetail>
    <NoStatementSigned>true</NoStatementSigned>
    <PostgraduateLoan>true</PostgraduateLoan>
    <PostgraduateLoanBeforeLast6April>true</PostgraduateLoanBeforeLast6April>
    <PostgraduateLoanRepayDirectly>true</PostgraduateLoanRepayDirectly>
    <StarterStatement>65</StarterStatement>
    <StudentLoanBeforeLast6April>true</StudentLoanBeforeLast6April>
    <StudentLoanNotRepaid>true</StudentLoanNotRepaid>
    <StudentLoanPlanType>1</StudentLoanPlanType>
    <StudentLoanRepayDirectly>true</StudentLoanRepayDirectly>
  </StarterStatementDetail>
  <TaxDetail>
    <StartDate>2024-12-23T06:59:27.1122023+00:00</StartDate>
    <TaxBasis>true</TaxBasis>
    <TaxCode>sample string 2</TaxCode>
  </TaxDetail>
</PersonDetail>

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>