lock
PATCH
apiportal/v1/Staff/{id}
Update staff member - replaces only supplied parameters
EXPANDexpand_more
Request Information
Roles
- Vendor_APIClient
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Staff community ID |
integer |
Required |
Body Parameters
Staff update details
spuStaff| Name | Description | Type | Additional information |
|---|---|---|---|
| SchoolStaffCode | string |
None. |
|
| StartDate | date |
None. |
|
| ActiveFlag | boolean |
None. |
|
| LeavingDate | date |
None. |
|
| CampusCode | string |
None. |
|
| YearLevelCode | integer |
None. |
|
| DepartmentCode | string |
None. |
Request Formats
A
{
"SchoolStaffCode": "sample string 1",
"StartDate": "2025-12-16T11:55:50.9619226+11:00",
"ActiveFlag": true,
"LeavingDate": "2025-12-16T11:55:50.9619226+11:00",
"CampusCode": "sample string 2",
"YearLevelCode": 3,
"DepartmentCode": "sample string 4"
}
<spuStaff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient"> <ActiveFlag>true</ActiveFlag> <CampusCode>sample string 2</CampusCode> <DepartmentCode>sample string 4</DepartmentCode> <LeavingDate>2025-12-16T11:55:50.9619226+11:00</LeavingDate> <SchoolStaffCode>sample string 1</SchoolStaffCode> <StartDate>2025-12-16T11:55:50.9619226+11:00</StartDate> <YearLevelCode>3</YearLevelCode> </spuStaff>
Sample not available.
EXPANDexpand_more
Response Information
Resource Description
ChangeEntitySeqModel
ChangeEntitySeqModel| Name | Description | Type | Additional information |
|---|---|---|---|
| EntitySeq | integer |
None. |
|
| Error | string |
None. |
|
| ValidationDetails | Collection of ValidationDetails |
None. |
Response Formats
A
{
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
}
<ChangeEntitySeqModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<Error>sample string 1</Error>
<ValidationDetails>
<ValidationDetails>
<FieldName>sample string 1</FieldName>
<Reason>sample string 2</Reason>
</ValidationDetails>
<ValidationDetails>
<FieldName>sample string 1</FieldName>
<Reason>sample string 2</Reason>
</ValidationDetails>
</ValidationDetails>
<EntitySeq>1</EntitySeq>
</ChangeEntitySeqModel>