PUT api/tenant/onboarding/provisioning/update/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

OnboardingProvisioningDTOW

Name	Type	Additional information
session_id	string	Required Max length: 100
proposed_number	string	Required Max length: 100
staff_category_code	string	Required Max length: 100
rec_category	integer	Required
user_on_ad	boolean	Required
sync_firstname	string	Max length: 100
sync_surname	string	Max length: 100
send_creation_email_to	integer	None.
creation_email_custom	string	Max length: 100
username	string	Required Max length: 100
designation_code	string	Max length: 500
position_code	string	Max length: 100
reports_to_staffNo	string	Required Max length: 100
employment_date	date	Required
a_confirm_date	date	None.
backup_officer_staffNo	string	Max length: 100
is_permanent_staff	boolean	Required
emp_duration_to	date	None.
ent_struc_type_code	string	Required Max length: 100
ent_struc_details_code	string	Required Max length: 100
grade_code	string	Required Max length: 100
on_payroll	boolean	Required
paygroup_code	string	Max length: 50
compute_pension	boolean	Required
compute_nhf	boolean	Required
compute_tax	boolean	Required
pay_newstaff_arrears	boolean	Required
title	string	Required Max length: 5
employee_surname	string	Required Max length: 100
employee_midname	string	Required Max length: 100
employee_firstname	string	Required Max length: 100
gender	string	Required
date_of_birth	date	Required
user_type	integer	None.
cost_centre	string	None.
roleNames	Collection of EmployeeProvisionDetailsDTOW	None.

Request Formats

application/json, text/json

Sample:

{
  "session_id": "sample string 1",
  "proposed_number": "sample string 2",
  "staff_category_code": "sample string 3",
  "rec_category": 4,
  "user_on_ad": true,
  "sync_firstname": "sample string 6",
  "sync_surname": "sample string 7",
  "send_creation_email_to": 1,
  "creation_email_custom": "sample string 8",
  "username": "sample string 9",
  "designation_code": "sample string 10",
  "position_code": "sample string 11",
  "reports_to_staffNo": "sample string 12",
  "employment_date": "2025-09-07T13:37:29.3953342+00:00",
  "a_confirm_date": "2025-09-07T13:37:29.3953342+00:00",
  "backup_officer_staffNo": "sample string 14",
  "is_permanent_staff": true,
  "emp_duration_to": "2025-09-07T13:37:29.3953342+00:00",
  "ent_struc_type_code": "sample string 16",
  "ent_struc_details_code": "sample string 17",
  "grade_code": "sample string 18",
  "on_payroll": true,
  "paygroup_code": "sample string 20",
  "compute_pension": true,
  "compute_nhf": true,
  "compute_tax": true,
  "pay_newstaff_arrears": true,
  "title": "sample string 25",
  "employee_surname": "sample string 26",
  "employee_midname": "sample string 27",
  "employee_firstname": "sample string 28",
  "gender": "sample string 29",
  "date_of_birth": "2025-09-07T13:37:29.3953342+00:00",
  "user_type": 31,
  "cost_centre": "sample string 32",
  "roleNames": [
    {
      "role_name": "sample string 1"
    },
    {
      "role_name": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<OnboardingProvisioningDTOW xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Xceed365EngageApi.core.DTOs.Writable">
  <a_confirm_date>2025-09-07T13:37:29.3953342+00:00</a_confirm_date>
  <backup_officer_staffNo>sample string 14</backup_officer_staffNo>
  <compute_nhf>true</compute_nhf>
  <compute_pension>true</compute_pension>
  <compute_tax>true</compute_tax>
  <cost_centre>sample string 32</cost_centre>
  <creation_email_custom>sample string 8</creation_email_custom>
  <date_of_birth>2025-09-07T13:37:29.3953342+00:00</date_of_birth>
  <designation_code>sample string 10</designation_code>
  <emp_duration_to>2025-09-07T13:37:29.3953342+00:00</emp_duration_to>
  <employee_firstname>sample string 28</employee_firstname>
  <employee_midname>sample string 27</employee_midname>
  <employee_surname>sample string 26</employee_surname>
  <employment_date>2025-09-07T13:37:29.3953342+00:00</employment_date>
  <ent_struc_details_code>sample string 17</ent_struc_details_code>
  <ent_struc_type_code>sample string 16</ent_struc_type_code>
  <gender>sample string 29</gender>
  <grade_code>sample string 18</grade_code>
  <is_permanent_staff>true</is_permanent_staff>
  <on_payroll>true</on_payroll>
  <pay_newstaff_arrears>true</pay_newstaff_arrears>
  <paygroup_code>sample string 20</paygroup_code>
  <position_code>sample string 11</position_code>
  <proposed_number>sample string 2</proposed_number>
  <rec_category>4</rec_category>
  <reports_to_staffNo>sample string 12</reports_to_staffNo>
  <roleNames>
    <EmployeeProvisionDetailsDTOW>
      <role_name>sample string 1</role_name>
    </EmployeeProvisionDetailsDTOW>
    <EmployeeProvisionDetailsDTOW>
      <role_name>sample string 1</role_name>
    </EmployeeProvisionDetailsDTOW>
  </roleNames>
  <send_creation_email_to>1</send_creation_email_to>
  <session_id>sample string 1</session_id>
  <staff_category_code>sample string 3</staff_category_code>
  <sync_firstname>sample string 6</sync_firstname>
  <sync_surname>sample string 7</sync_surname>
  <title>sample string 25</title>
  <user_on_ad>true</user_on_ad>
  <user_type>31</user_type>
  <username>sample string 9</username>
</OnboardingProvisioningDTOW>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OnboardingProvisioningDTOW'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.