List EmployeePlacements

Python (SDK)

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.list(limit=1, offset=0)

    while res is not None:
        # Handle items

        res = res.next()

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 100
  }
}

GET

employee-placement

Python (SDK)

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.list(limit=1, offset=0)

    while res is not None:
        # Handle items

        res = res.next()

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 100
  }
}

Authorizations

Client-ID

string

header

required

Client-Secret

string

header

required

Query Parameters

limit

integer

default:50

The maximum number of EmployeePlacements to return (default: 50) when listing EmployeePlacements

offset

integer

default:0

The number of EmployeePlacements to skip before starting to return results (default: 0) when listing EmployeePlacements

Response

Response for EmployeePlacement List operation - returns a paginated list of EmployeePlacement

data

object[]

Array of EmployeePlacement objects

Show child attributes

data.id

string<uuid>

required

Unique identifier for the EmployeePlacement

data.employeeID

string<uuid>

required

The ID of the employee the placement belongs to

data.schoolID

string<uuid>

required

The ID of the school the placement belongs to

data.startDate

string<date>

required

The start date of the placement for the employee

data.meta

object

Metadata information for the EmployeePlacement

Show child attributes

data.meta.createdAt

string<date-time>

required

Timestamp when the resource was created

data.meta.createdBy

string<uuid> | null

User who created the resource

data.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

data.meta.updatedBy

string<uuid> | null

User who last updated the resource

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"
}

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

Show child attributes

data.external.sourceID

string | null

The ID of the external source

data.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}

data.signature

string | null

The signature of the employee

data.title

string | null

The title of the employee

data.roles

enum<string>[]

The roles of the employee

The role of the employee in the placement

Available options:

Admin,

CareTeam,

Manager,

OtherPersonnel,

Scheduler,

Teacher

data.endDate

string<date> | null

The end date of the placement for the employee

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

data.archivedAt

string<date-time> | null

The timestamp the placement was archived for the employee

pagination

object

Pagination information

Show child attributes

pagination.offset

integer

required

Number of items to skip from the beginning of the result set

pagination.limit

integer

required

Maximum number of items to return in the result set

pagination.total

integer

required

Total number of items available for pagination

Example:

{ "offset": 0, "limit": 1, "total": 100 }

Update a Employee Create a new EmployeePlacement

⌘I

Getting started

Guides

Reference

List EmployeePlacements

Authorizations

Query Parameters

Response