Skip to main content
PATCH
/
employee-placement
/
{id}
Python (SDK)
from datetime import date
from meitner import Meitner, models
import os


with Meitner(
    security=models.Security(
        client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
        client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
    ),
) as m_client:

    res = m_client.employee_placements.update(id="123e4567-e89b-12d3-a456-426614174000", start_date=date.fromisoformat("2024-08-01"), external={
        "source_id": "12345678",
    }, signature="LM", title="Principal", roles=[
        "Admin",
    ], end_date=date.fromisoformat("2024-08-01"))

    # Handle response
    print(res)
{
  "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"
}

Authorizations

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

Path Parameters

​
id
string<uuid>
required

The unique identifier of the EmployeePlacement to update

Example:

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

Body

application/json

Request body

​
startDate
string<date>
required

The start date of the placement for the employee

Example:

"2024-08-01"

​
external
object

External is the External-object used on Update and Create operations, since it should only be allowed to set SourceID for the guardian, the Source-field is not included.

Example:
{ "sourceID": "12345678" }
​
signature
string | null

The signature of the employee

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:
["Admin"]
​
endDate
string<date> | null

The end date of the placement for the employee

Examples:

"2024-08-01"

null

Response

Response for EmployeePlacement Update operation - returns the updated 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:
{
  "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
object

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:
{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}
​
signature
string | null

The signature of the employee

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:
["Admin"]
​
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