Skip to main content
GET
Csharp (SDK)

Authorizations

Client-ID
string
header
required
Client-Secret
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the EmployeePlacement to retrieve

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Response for EmployeePlacement Get operation - returns the requested EmployeePlacement

EmployeePlacement holds the information about an employee's placement in a school.

id
string<uuid>
required

Unique identifier for the EmployeePlacement

Example:

"123e4567-e89b-12d3-a456-426614174000"

employeeID
string<uuid>
required

The ID of the employee the placement belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

schoolID
string<uuid>
required

The ID of the school the placement belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

startDate
string<date>
required

The start date of the placement for the employee

Example:

"2024-08-01"

meta
object

Metadata information for the EmployeePlacement

Example:
external
object | null

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Example:
signature
string | null

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).

Examples:

"LM"

null

title
string | null

The title of the employee

Examples:

"Principal"

null

roles
enum<string>[]

The roles of the employee

The role of the employee in the placement

Available options:
Admin,
CareTeam,
Manager,
MealPlanner,
OtherPersonnel,
Scheduler,
Teacher
Example:
endDate
string<date> | null

The end date of the placement for the employee

Examples:

"2024-08-01"

null

archiveYear
string | null

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.

Examples:

"2024_2025"

null

archivedAt
string<date-time> | null

The timestamp the placement was archived for the employee

Examples:

"2024-08-01T00:00:00Z"

null

employmentPercent
integer | null

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

Examples:

100

null