lock
POST
apiportal/v1/Staff
Add a new staff member from community
EXPANDexpand_more
Request Information
Roles
- Vendor_APIClient
URI Parameters
None.
Body Parameters
Staff creation details
Collection of spiStaff| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| SchoolStaffCode | string |
None. |
|
| StartDate | date |
None. |
|
| LeavingDate | date |
None. |
|
| CampusCode | string |
None. |
|
| YearLevelCode | integer |
None. |
|
| DepartmentCode | string |
None. |
Request Formats
A
[
{
"ID": 1,
"SchoolStaffCode": "sample string 2",
"StartDate": "2025-12-16T11:55:45.9956984+11:00",
"LeavingDate": "2025-12-16T11:55:45.9956984+11:00",
"CampusCode": "sample string 3",
"YearLevelCode": 4,
"DepartmentCode": "sample string 5"
},
{
"ID": 1,
"SchoolStaffCode": "sample string 2",
"StartDate": "2025-12-16T11:55:45.9956984+11:00",
"LeavingDate": "2025-12-16T11:55:45.9956984+11:00",
"CampusCode": "sample string 3",
"YearLevelCode": 4,
"DepartmentCode": "sample string 5"
}
]
<ArrayOfspiStaff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<spiStaff>
<CampusCode>sample string 3</CampusCode>
<DepartmentCode>sample string 5</DepartmentCode>
<ID>1</ID>
<LeavingDate>2025-12-16T11:55:45.9956984+11:00</LeavingDate>
<SchoolStaffCode>sample string 2</SchoolStaffCode>
<StartDate>2025-12-16T11:55:45.9956984+11:00</StartDate>
<YearLevelCode>4</YearLevelCode>
</spiStaff>
<spiStaff>
<CampusCode>sample string 3</CampusCode>
<DepartmentCode>sample string 5</DepartmentCode>
<ID>1</ID>
<LeavingDate>2025-12-16T11:55:45.9956984+11:00</LeavingDate>
<SchoolStaffCode>sample string 2</SchoolStaffCode>
<StartDate>2025-12-16T11:55:45.9956984+11:00</StartDate>
<YearLevelCode>4</YearLevelCode>
</spiStaff>
</ArrayOfspiStaff>
Sample not available.
EXPANDexpand_more
Response Information
Resource Description
Collection of CreateStaffRespModel| Name | Description | Type | Additional information |
|---|---|---|---|
| RowNum | integer |
None. |
|
| Result | CreateStaffModel |
None. |
Response Formats
A
[
{
"RowNum": 1,
"Result": {
"Staff": [
{
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
},
{
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
}
],
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
}
},
{
"RowNum": 1,
"Result": {
"Staff": [
{
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
},
{
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
}
],
"EntitySeq": 1,
"Error": "sample string 1",
"ValidationDetails": [
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
},
{
"FieldName": "sample string 1",
"Reason": "sample string 2"
}
]
}
}
]
<ArrayOfCreateStaffRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<CreateStaffRespModel>
<Result>
<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>
<Staff>
<_CreateStaffModel>
<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>
</_CreateStaffModel>
<_CreateStaffModel>
<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>
</_CreateStaffModel>
</Staff>
</Result>
<RowNum>1</RowNum>
</CreateStaffRespModel>
<CreateStaffRespModel>
<Result>
<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>
<Staff>
<_CreateStaffModel>
<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>
</_CreateStaffModel>
<_CreateStaffModel>
<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>
</_CreateStaffModel>
</Staff>
</Result>
<RowNum>1</RowNum>
</CreateStaffRespModel>
</ArrayOfCreateStaffRespModel>