Sign in

v2

latestOpenAPI 3.1.0Proprietary - Licensed to Authorized Customers Only2026-07-31611061.1 MB
EmployeePlacement

Create a new EmployeePlacement

Create a new EmployeePlacement

post/employee-placement

Request body

employeeIDstring uuid required

The ID of the employee the placement belongs to

schoolIDstring uuid required

The ID of the school the placement belongs to

signaturestring nullable

The employee's signature — a short code, usually their initials, used to identify the employee within the school on schedules, grade documents, and other printed material (e.g. "LM" for Lise Meitner).

titlestring nullable

The title of the employee

rolesEmployeePlacementRole[]

The roles of the employee

startDatestring date required

The start date of the placement for the employee

endDatestring date nullable

The end date of the placement for the employee

employmentPercentinteger nullable

The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%)

Example request

{
  "external": {
    "sourceID": "12345678"
  },
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "signature": "LM",
  "title": "Principal",
  "roles": [
    "Admin"
  ],
  "startDate": "2024-08-01",
  "endDate": "2024-08-01",
  "employmentPercent": 100
}

Response

Response for EmployeePlacement Create operation - returns the created EmployeePlacement

idstring uuid required

Unique identifier for the EmployeePlacement

employeeIDstring uuid required

The ID of the employee the placement belongs to

schoolIDstring uuid required

The ID of the school the placement belongs to

signaturestring nullable

The employee's signature — a short code, usually their initials, used to identify the employee within the school on schedules, grade documents, and other printed material (e.g. "LM" for Lise Meitner).

titlestring nullable

The title of the employee

rolesEmployeePlacementRole[]

The roles of the employee

startDatestring date required

The start date of the placement for the employee

endDatestring date nullable

The end date of the placement for the employee

archiveYearstring nullable

The year the placement was archived for the employee, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring.

archivedAtstring date-time nullable

The timestamp the placement was archived for the employee

employmentPercentinteger nullable

The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%)

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
    "updatedAt": "2024-01-15T14:45:00Z",
    "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
  },
  "external": {
    "sourceID": "12345678",
    "source": "ExternalIntegrationAPI"
  },
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "signature": "LM",
  "title": "Principal",
  "roles": [
    "Admin"
  ],
  "startDate": "2024-08-01",
  "endDate": "2024-08-01",
  "archiveYear": "2024_2025",
  "archivedAt": "2024-08-01T00:00:00Z",
  "employmentPercent": 100
}