> ## Documentation Index > Fetch the complete documentation index at: https://docs.meitner.se/llms.txt > Use this file to discover all available pages before exploring further. # Search EmployeePlacements > Search for `EmployeePlacements` with filtering capabilities. ## OpenAPI ````yaml https://spec.speakeasy.com/meitner-2u8/api/directory-api-with-code-samples post /employee-placement/_search openapi: 3.1.0 info: title: Directory API description: Generated API documentation contact: name: Meitner url: https://meitner.se email: support@meitner.se license: name: Proprietary - Licensed to Authorized Customers Only url: https://meitner.se version: v1 servers: - url: https://api.meitner.se/directory/v1 description: Server to use in production x-speakeasy-server-id: production - url: https://api.staging.meitner.se/directory/v1 description: Server to use when building and testing the API x-speakeasy-server-id: staging security: - ClientCredentials: [] ClientSecret: [] - OAuth2: [] tags: - name: School description: > The `School` resource represents a school where daily operations occur. A school must exist before you can create StudentPlacements, EmployeePlacements, or Groups. This resource can be created, updated, listed, retrieved, and searched using the standard resource structure. - name: Group description: Group holds the information about a group of students. - name: Employee description: >- Employee holds the personal information about an employee in the organization. - name: EmployeePlacement description: >- EmployeePlacement holds the information about an employee's placement in a school. - name: Guardian description: Guardian holds the information about a guardian of a student. - name: Student description: >- Student holds the personal information about a student, information about the school is stored in the StudentPlacement-resource. - name: StudentPlacement description: >- StudentPlacement holds the placement information about a student in a specific school. - name: AuditEvent description: AuditEvent holds the information about an audit event. - name: GradeElementary description: > GradeElementary represents a grade awarded to a student in elementary school (Swedish: grundskola). Grades are scoped to the organization of the API key used. The SubjectCode field uses the subject code as defined by the Swedish school authorities (e.g. "MA" for Mathematics). - name: GradeUpperSecondary description: > GradeUpperSecondary represents a grade awarded to a student in upper secondary school (Swedish: gymnasieskola). Grades are scoped to the organization of the API key used. The CourseCode field uses the national course code as defined by the Swedish school authorities (e.g. "MATMAT01a"). - name: Unit description: > The `Unit` resource represents an organizational unit that schools can belong to. This resource can be created, updated, listed, retrieved, and searched using the standard resource structure. paths: /employee-placement/_search: post: tags: - EmployeePlacement summary: Search EmployeePlacements description: Search for `EmployeePlacements` with filtering capabilities. operationId: EmployeePlacementSearch parameters: - name: limit in: query description: >- The maximum number of EmployeePlacements to return (default: 50) when searching EmployeePlacements required: false schema: type: integer examples: - 1 default: 50 - name: offset in: query description: >- The number of EmployeePlacements to skip before starting to return results (default: 0) when searching EmployeePlacements required: false schema: type: integer examples: - 0 default: 0 requestBody: $ref: '#/components/requestBodies/EmployeePlacementSearch' responses: '200': $ref: '#/components/responses/EmployeePlacementSearch' description: >- Response for EmployeePlacement Search operation - returns filtered EmployeePlacement results '400': $ref: '#/components/responses/Error400ResponseBody' description: >- Bad Request error for EmployeePlacement Search operation - request contains invalid parameters '401': $ref: '#/components/responses/Error401ResponseBody' description: >- Unauthorized error for EmployeePlacement Search operation - authentication required '403': $ref: '#/components/responses/Error403ResponseBody' description: >- Forbidden error for EmployeePlacement Search operation - insufficient permissions '404': $ref: '#/components/responses/Error404ResponseBody' description: >- Not Found error for EmployeePlacement Search operation - resource does not exist '409': $ref: '#/components/responses/Error409ResponseBody' description: >- Conflict error for EmployeePlacement Search operation - request conflicts with current state '422': $ref: '#/components/responses/EmployeePlacementSearch422ResponseBody' description: >- Validation error for EmployeePlacement Search operation - request data failed validation '429': $ref: '#/components/responses/Error429ResponseBody' description: >- Rate Limit error for EmployeePlacement Search operation - too many requests '500': $ref: '#/components/responses/Error500ResponseBody' description: >- Internal Server error for EmployeePlacement Search operation - unexpected server error x-codeSamples: - lang: csharp label: Csharp (SDK) source: >- using Meitner; using Meitner.Models.Components; using System; using System.Collections.Generic; var sdk = new MeitnerSDK(security: new Security() { Option1 = new SecurityOption1() { ClientCredentials = "", ClientSecret = "", }, }); Models.Requests.EmployeePlacementSearchResponse? res = await sdk.EmployeePlacements.SearchAsync( employeePlacementSearch: new EmployeePlacementSearchRequestBody() { Filter = new EmployeePlacementSearchFilter() { Equals = new EmployeePlacementSearchEquals() { Id = "123e4567-e89b-12d3-a456-426614174000", Meta = new EmployeePlacementSearchEqualsMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), CreatedBy = "123e4567-e89b-12d3-a456-426614174000", UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedBy = "123e4567-e89b-12d3-a456-426614174000", }, External = new EmployeePlacementSearchEqualsExternal() { SourceID = "example", Source = "example", }, EmployeeID = "123e4567-e89b-12d3-a456-426614174000", SchoolID = "123e4567-e89b-12d3-a456-426614174000", Signature = "example", Title = "example", StartDate = DateOnly.Parse("2024-01-15"), EndDate = DateOnly.Parse("2024-01-15"), ArchiveYear = "example", ArchivedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), EmploymentPercent = 42, }, NotEquals = new EmployeePlacementSearchNotEquals() { Id = "123e4567-e89b-12d3-a456-426614174000", Meta = new EmployeePlacementSearchNotEqualsMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), CreatedBy = "123e4567-e89b-12d3-a456-426614174000", UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedBy = "123e4567-e89b-12d3-a456-426614174000", }, External = new EmployeePlacementSearchNotEqualsExternal() { SourceID = "example", Source = "example", }, EmployeeID = "123e4567-e89b-12d3-a456-426614174000", SchoolID = "123e4567-e89b-12d3-a456-426614174000", Signature = "example", Title = "example", StartDate = DateOnly.Parse("2024-01-15"), EndDate = DateOnly.Parse("2024-01-15"), ArchiveYear = "example", ArchivedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), EmploymentPercent = 42, }, GreaterThan = new EmployeePlacementSearchGreaterThan() { Meta = new EmployeePlacementSearchGreaterThanMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, StartDate = DateOnly.Parse("2024-01-15"), EndDate = DateOnly.Parse("2024-01-15"), ArchivedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), EmploymentPercent = 42, }, SmallerThan = new EmployeePlacementSearchSmallerThan() { Meta = new EmployeePlacementSearchSmallerThanMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, StartDate = DateOnly.Parse("2024-01-15"), EndDate = DateOnly.Parse("2024-01-15"), ArchivedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), EmploymentPercent = 42, }, GreaterOrEqual = new EmployeePlacementSearchGreaterOrEqual() { Meta = new EmployeePlacementSearchGreaterOrEqualMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, StartDate = DateOnly.Parse("2024-01-15"), EndDate = DateOnly.Parse("2024-01-15"), ArchivedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), EmploymentPercent = 42, }, SmallerOrEqual = new EmployeePlacementSearchSmallerOrEqual() { Meta = new EmployeePlacementSearchSmallerOrEqualMeta() { CreatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), UpdatedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), }, StartDate = DateOnly.Parse("2024-01-15"), EndDate = DateOnly.Parse("2024-01-15"), ArchivedAt = System.DateTime.Parse("2024-01-15T10:30:00Z").ToUniversalTime(), EmploymentPercent = 42, }, Contains = new EmployeePlacementSearchContains() { Id = new List() { "123e4567-e89b-12d3-a456-426614174000", }, Meta = new EmployeePlacementSearchContainsMeta() { CreatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, UpdatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, }, External = new EmployeePlacementSearchContainsExternal() { SourceID = new List() { "example", }, Source = new List() { "example", }, }, EmployeeID = new List() { "123e4567-e89b-12d3-a456-426614174000", }, SchoolID = new List() { "123e4567-e89b-12d3-a456-426614174000", }, Signature = new List() { "example", }, Title = new List() { "example", }, StartDate = new List() { DateOnly.Parse("2024-01-15"), }, EndDate = new List() { DateOnly.Parse("2024-01-15"), }, ArchiveYear = new List() { "example", }, EmploymentPercent = new List() { 42, }, }, NotContains = new EmployeePlacementSearchNotContains() { Id = new List() { "123e4567-e89b-12d3-a456-426614174000", }, Meta = new EmployeePlacementSearchNotContainsMeta() { CreatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, UpdatedBy = new List() { "123e4567-e89b-12d3-a456-426614174000", }, }, External = new EmployeePlacementSearchNotContainsExternal() { SourceID = new List() { "example", }, Source = new List() { "example", }, }, EmployeeID = new List() { "123e4567-e89b-12d3-a456-426614174000", }, SchoolID = new List() { "123e4567-e89b-12d3-a456-426614174000", }, Signature = new List() { "example", }, Title = new List() { "example", }, StartDate = new List() { DateOnly.Parse("2024-01-15"), }, EndDate = new List() { DateOnly.Parse("2024-01-15"), }, ArchiveYear = new List() { "example", }, EmploymentPercent = new List() { 42, }, }, Like = new EmployeePlacementSearchLike() { External = new EmployeePlacementSearchLikeExternal() { SourceID = "example", Source = "example", }, Signature = "example", Title = "example", ArchiveYear = "example", }, NotLike = new EmployeePlacementSearchNotLike() { External = new EmployeePlacementSearchNotLikeExternal() { SourceID = "example", Source = "example", }, Signature = "example", Title = "example", ArchiveYear = "example", }, Null = new EmployeePlacementSearchNull() { Meta = new EmployeePlacementSearchNullMeta() { CreatedBy = true, UpdatedAt = true, UpdatedBy = true, }, External = new EmployeePlacementSearchNullExternal() { SourceID = true, Source = true, }, Signature = true, Title = true, Roles = true, EndDate = true, ArchiveYear = true, ArchivedAt = true, EmploymentPercent = true, }, NotNull = new EmployeePlacementSearchNotNull() { Meta = new EmployeePlacementSearchNotNullMeta() { CreatedBy = true, UpdatedAt = true, UpdatedBy = true, }, External = new EmployeePlacementSearchNotNullExternal() { SourceID = true, Source = true, }, Signature = true, Title = true, Roles = true, EndDate = true, ArchiveYear = true, ArchivedAt = true, EmploymentPercent = true, }, OrCondition = true, }, }, limit: 1, offset: 0 ); while(res != null) { // handle items res = await res.Next!(); } - lang: python label: Python (SDK) source: |- from datetime import date from meitner import Meitner, models from meitner.utils import parse_datetime import os with Meitner( security=models.Security( option1=models.SecurityOption1( client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""), client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""), ), ), ) as m_client: res = m_client.employee_placements.search(filter_={ "equals": { "id": "123e4567-e89b-12d3-a456-426614174000", "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "created_by": "123e4567-e89b-12d3-a456-426614174000", "updated_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_by": "123e4567-e89b-12d3-a456-426614174000", }, "external": { "source_id": "example", "source": "example", }, "employee_id": "123e4567-e89b-12d3-a456-426614174000", "school_id": "123e4567-e89b-12d3-a456-426614174000", "signature": "example", "title": "example", "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archive_year": "example", "archived_at": parse_datetime("2024-01-15T10:30:00Z"), "employment_percent": 42, }, "not_equals": { "id": "123e4567-e89b-12d3-a456-426614174000", "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "created_by": "123e4567-e89b-12d3-a456-426614174000", "updated_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_by": "123e4567-e89b-12d3-a456-426614174000", }, "external": { "source_id": "example", "source": "example", }, "employee_id": "123e4567-e89b-12d3-a456-426614174000", "school_id": "123e4567-e89b-12d3-a456-426614174000", "signature": "example", "title": "example", "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archive_year": "example", "archived_at": parse_datetime("2024-01-15T10:30:00Z"), "employment_percent": 42, }, "greater_than": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), "employment_percent": 42, }, "smaller_than": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), "employment_percent": 42, }, "greater_or_equal": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), "employment_percent": 42, }, "smaller_or_equal": { "meta": { "created_at": parse_datetime("2024-01-15T10:30:00Z"), "updated_at": parse_datetime("2024-01-15T10:30:00Z"), }, "start_date": date.fromisoformat("2024-01-15"), "end_date": date.fromisoformat("2024-01-15"), "archived_at": parse_datetime("2024-01-15T10:30:00Z"), "employment_percent": 42, }, "contains": { "id": [ "123e4567-e89b-12d3-a456-426614174000", ], "meta": { "created_by": [ "123e4567-e89b-12d3-a456-426614174000", ], "updated_by": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "external": { "source_id": [ "example", ], "source": [ "example", ], }, "employee_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "school_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "signature": [ "example", ], "title": [ "example", ], "start_date": [ date.fromisoformat("2024-01-15"), ], "end_date": [ date.fromisoformat("2024-01-15"), ], "archive_year": [ "example", ], "employment_percent": [ 42, ], }, "not_contains": { "id": [ "123e4567-e89b-12d3-a456-426614174000", ], "meta": { "created_by": [ "123e4567-e89b-12d3-a456-426614174000", ], "updated_by": [ "123e4567-e89b-12d3-a456-426614174000", ], }, "external": { "source_id": [ "example", ], "source": [ "example", ], }, "employee_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "school_id": [ "123e4567-e89b-12d3-a456-426614174000", ], "signature": [ "example", ], "title": [ "example", ], "start_date": [ date.fromisoformat("2024-01-15"), ], "end_date": [ date.fromisoformat("2024-01-15"), ], "archive_year": [ "example", ], "employment_percent": [ 42, ], }, "like": { "external": { "source_id": "example", "source": "example", }, "signature": "example", "title": "example", "archive_year": "example", }, "not_like": { "external": { "source_id": "example", "source": "example", }, "signature": "example", "title": "example", "archive_year": "example", }, "null": { "meta": { "created_by": True, "updated_at": True, "updated_by": True, }, "external": { "source_id": True, "source": True, }, "signature": True, "title": True, "roles": True, "end_date": True, "archive_year": True, "archived_at": True, "employment_percent": True, }, "not_null": { "meta": { "created_by": True, "updated_at": True, "updated_by": True, }, "external": { "source_id": True, "source": True, }, "signature": True, "title": True, "roles": True, "end_date": True, "archive_year": True, "archived_at": True, "employment_percent": True, }, "or_condition": True, }, limit=1, offset=0) while res is not None: # Handle items res = res.next() components: requestBodies: EmployeePlacementSearch: description: Request body content: application/json: schema: type: object properties: filter: allOf: - $ref: '#/components/schemas/EmployeePlacementFilter' examples: - equals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 notEquals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 greaterThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 smallerThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 greaterOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 smallerOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 contains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 notContains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 like: external: sourceID: example source: example signature: example title: example archiveYear: example notLike: external: sourceID: example source: example signature: example title: example archiveYear: example 'null': meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true notNull: meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true orCondition: true description: Filter criteria to search for specific records required: - filter examples: requestExample: summary: Request body example value: filter: equals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 notEquals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 greaterThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 smallerThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 greaterOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 smallerOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 contains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 notContains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 like: external: sourceID: example source: example signature: example title: example archiveYear: example notLike: external: sourceID: example source: example signature: example title: example archiveYear: example 'null': meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true notNull: meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true orCondition: true required: true responses: EmployeePlacementSearch: description: >- Response for EmployeePlacement Search operation - returns filtered EmployeePlacement results headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: data: type: array examples: - - 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 items: allOf: - $ref: '#/components/schemas/EmployeePlacement' description: Array of EmployeePlacement objects pagination: allOf: - $ref: '#/components/schemas/Pagination' examples: - offset: 0 limit: 1 total: 100 description: Pagination information examples: responseExample: summary: Response body example value: 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' employmentPercent: 100 pagination: offset: 0 limit: 1 total: 100 Error400ResponseBody: description: Bad Request - The request was malformed or contained invalid parameters headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Bad Request error example value: error: code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 Error401ResponseBody: description: Unauthorized - The request is missing valid authentication credentials headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Unauthorized error example value: error: code: Unauthorized message: Authentication credentials are missing or invalid requestID: 550e8400-e29b-41d4-a716-446655440000 Error403ResponseBody: description: >- Forbidden - Request is authenticated, but the user is not allowed to perform the operation headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Forbidden error example value: error: code: Forbidden message: You do not have permission to perform this operation requestID: 550e8400-e29b-41d4-a716-446655440000 Error404ResponseBody: description: Not Found - The requested resource does not exist headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Not Found error example value: error: code: NotFound message: The requested resource could not be found requestID: 550e8400-e29b-41d4-a716-446655440000 Error409ResponseBody: description: Conflict - The request could not be completed due to a conflict headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Conflict error example value: error: code: Conflict message: The request conflicts with the current state of the resource requestID: 550e8400-e29b-41d4-a716-446655440000 EmployeePlacementSearch422ResponseBody: description: >- Validation error for EmployeePlacement Search operation - request data failed validation headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: UnprocessableEntity message: Validation failed for EmployeePlacement Search endpoint requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: validationError: summary: Validation error example value: error: code: UnprocessableEntity message: Validation failed for EmployeePlacement Search endpoint requestID: 550e8400-e29b-41d4-a716-446655440000 Error429ResponseBody: description: Too Many Requests - When the rate limit has been exceeded headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Rate Limited error example value: error: code: RateLimited message: Too many requests - rate limit exceeded requestID: 550e8400-e29b-41d4-a716-446655440000 Error500ResponseBody: description: Internal Server Error - An unexpected server error occurred headers: RateLimit-Limit: description: >- The maximum number of API requests you're permitted to make per hour. schema: type: integer examples: - 5000 RateLimit-Remaining: description: >- The number of API requests remaining in the current rate limit window. schema: type: integer examples: - 4999 RateLimit-Reset: description: >- The time at which the current rate limit window resets in UTC epoch milliseconds. schema: type: string examples: - '1728316800000' content: application/json: schema: type: object properties: error: allOf: - $ref: '#/components/schemas/Error' examples: - code: BadRequest message: The request contains invalid parameters or malformed data requestID: 550e8400-e29b-41d4-a716-446655440000 required: - error examples: errorExample: summary: Internal Server error example value: error: code: Internal message: An unexpected server error occurred requestID: 550e8400-e29b-41d4-a716-446655440000 schemas: EmployeePlacementFilter: type: object properties: equals: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterEquals' examples: - id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 - null description: Equality filters for EmployeePlacement nullable: true notEquals: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterEquals' examples: - id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 - null description: Inequality filters for EmployeePlacement nullable: true greaterThan: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 - null description: Greater than filters for EmployeePlacement nullable: true smallerThan: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 - null description: Smaller than filters for EmployeePlacement nullable: true greaterOrEqual: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 - null description: Greater than or equal filters for EmployeePlacement nullable: true smallerOrEqual: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterRange' examples: - meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 - null description: Smaller than or equal filters for EmployeePlacement nullable: true contains: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterContains' examples: - id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 - null description: Contains filters for EmployeePlacement nullable: true notContains: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterContains' examples: - id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 - null description: Not contains filters for EmployeePlacement nullable: true like: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterLike' examples: - external: sourceID: example source: example signature: example title: example archiveYear: example - null description: LIKE filters for EmployeePlacement nullable: true notLike: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterLike' examples: - external: sourceID: example source: example signature: example title: example archiveYear: example - null description: NOT LIKE filters for EmployeePlacement nullable: true 'null': allOf: - $ref: '#/components/schemas/EmployeePlacementFilterNull' examples: - meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true - null description: Null filters for EmployeePlacement nullable: true notNull: allOf: - $ref: '#/components/schemas/EmployeePlacementFilterNull' examples: - meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true - null description: Not null filters for EmployeePlacement nullable: true orCondition: type: boolean examples: - true description: >- OrCondition decides if this filter is within an OR-condition or AND-condition nestedFilters: type: array examples: - - equals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 notEquals: id: 123e4567-e89b-12d3-a456-426614174000 meta: createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 external: sourceID: example source: example employeeID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 signature: example title: example startDate: '2024-01-15' endDate: '2024-01-15' archiveYear: example archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 greaterThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 smallerThan: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 greaterOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 smallerOrEqual: meta: createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' startDate: '2024-01-15' endDate: '2024-01-15' archivedAt: '2024-01-15T10:30:00Z' employmentPercent: 42 contains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 notContains: id: - 123e4567-e89b-12d3-a456-426614174000 meta: createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 external: sourceID: - example source: - example employeeID: - 123e4567-e89b-12d3-a456-426614174000 schoolID: - 123e4567-e89b-12d3-a456-426614174000 signature: - example title: - example startDate: - '2024-01-15' endDate: - '2024-01-15' archiveYear: - example employmentPercent: - 42 like: external: sourceID: example source: example signature: example title: example archiveYear: example notLike: external: sourceID: example source: example signature: example title: example archiveYear: example 'null': meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true notNull: meta: createdBy: true updatedAt: true updatedBy: true external: sourceID: true source: true signature: true title: true roles: true endDate: true archiveYear: true archivedAt: true employmentPercent: true orCondition: true items: allOf: - $ref: '#/components/schemas/EmployeePlacementFilter' description: >- NestedFilters of the EmployeePlacement, useful for more complex filters required: - orCondition description: Filter object for EmployeePlacement EmployeePlacement: type: object properties: id: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: Unique identifier for the EmployeePlacement meta: allOf: - $ref: '#/components/schemas/Meta' examples: - createdAt: '2024-01-15T10:30:00Z' createdBy: 987fcdeb-51a2-43d1-b567-123456789abc updatedAt: '2024-01-15T14:45:00Z' updatedBy: 987fcdeb-51a2-43d1-b567-123456789abc description: Metadata information for the EmployeePlacement external: allOf: - $ref: '#/components/schemas/External' examples: - sourceID: '12345678' source: ExternalIntegrationAPI - null description: >- 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. nullable: true employeeID: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: The ID of the employee the placement belongs to schoolID: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: The ID of the school the placement belongs to signature: type: string examples: - LM - null description: >- 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). nullable: true title: type: string examples: - Principal - null description: The title of the employee nullable: true roles: type: array examples: - - Admin items: allOf: - $ref: '#/components/schemas/EmployeePlacementRole' description: The roles of the employee startDate: type: string examples: - '2024-08-01' format: date description: The start date of the placement for the employee endDate: type: string examples: - '2024-08-01' - null format: date description: The end date of the placement for the employee nullable: true archiveYear: type: string examples: - '2024_2025' - null description: >- 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. nullable: true archivedAt: type: string examples: - '2024-08-01T00:00:00Z' - null format: date-time description: The timestamp the placement was archived for the employee nullable: true employmentPercent: type: integer examples: - 100 - null description: >- The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%) nullable: true required: - id - employeeID - schoolID - startDate description: >- EmployeePlacement holds the information about an employee's placement in a school. Pagination: type: object properties: offset: type: integer examples: - 0 description: Number of items to skip from the beginning of the result set limit: type: integer examples: - 1 description: Maximum number of items to return in the result set total: type: integer examples: - 100 description: Total number of items available for pagination required: - offset - limit - total description: Pagination parameters for controlling result sets in list operations Error: type: object properties: code: allOf: - $ref: '#/components/schemas/ErrorCode' description: The specific error code indicating the type of error message: type: string examples: - example description: Human-readable error message providing additional details requestID: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 description: >- Unique identifier for the request that generated this error, used for logging and debugging required: - code - message - requestID description: >- Standard error response object containing error code, message, and request ID EmployeePlacementFilterEquals: type: object properties: id: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: Unique identifier for the EmployeePlacement nullable: true meta: allOf: - $ref: '#/components/schemas/MetaFilterEquals' examples: - createdAt: '2024-01-15T10:30:00Z' createdBy: 123e4567-e89b-12d3-a456-426614174000 updatedAt: '2024-01-15T10:30:00Z' updatedBy: 123e4567-e89b-12d3-a456-426614174000 - null description: Metadata information for the EmployeePlacement nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterEquals' examples: - sourceID: example source: example - null description: >- 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. nullable: true employeeID: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: The ID of the employee the placement belongs to nullable: true schoolID: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: The ID of the school the placement belongs to nullable: true signature: type: string examples: - example - null description: >- 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). nullable: true title: type: string examples: - example - null description: The title of the employee nullable: true roles: allOf: - $ref: '#/components/schemas/EmployeePlacementRole' description: The roles of the employee nullable: true startDate: type: string examples: - '2024-01-15' - null format: date description: The start date of the placement for the employee nullable: true endDate: type: string examples: - '2024-01-15' - null format: date description: The end date of the placement for the employee nullable: true archiveYear: type: string examples: - example - null description: >- 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. nullable: true archivedAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: The timestamp the placement was archived for the employee nullable: true employmentPercent: type: integer examples: - 42 - null description: >- The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%) nullable: true description: Equality/Inequality filter fields for EmployeePlacement EmployeePlacementFilterRange: type: object properties: meta: allOf: - $ref: '#/components/schemas/MetaFilterRange' examples: - createdAt: '2024-01-15T10:30:00Z' updatedAt: '2024-01-15T10:30:00Z' - null description: Metadata information for the EmployeePlacement nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterRange' description: >- 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. nullable: true startDate: type: string examples: - '2024-01-15' - null format: date description: The start date of the placement for the employee nullable: true endDate: type: string examples: - '2024-01-15' - null format: date description: The end date of the placement for the employee nullable: true archivedAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: The timestamp the placement was archived for the employee nullable: true employmentPercent: type: integer examples: - 42 - null description: >- The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%) nullable: true description: Range filter fields for EmployeePlacement EmployeePlacementFilterContains: type: object properties: id: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: Unique identifier for the EmployeePlacement meta: allOf: - $ref: '#/components/schemas/MetaFilterContains' examples: - createdBy: - 123e4567-e89b-12d3-a456-426614174000 updatedBy: - 123e4567-e89b-12d3-a456-426614174000 - null description: Metadata information for the EmployeePlacement nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterContains' examples: - sourceID: - example source: - example - null description: >- 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. nullable: true employeeID: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: The ID of the employee the placement belongs to schoolID: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: The ID of the school the placement belongs to signature: type: array examples: - - example items: type: string description: >- 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). title: type: array examples: - - example items: type: string description: The title of the employee roles: type: array items: allOf: - $ref: '#/components/schemas/EmployeePlacementRole' description: The roles of the employee startDate: type: array examples: - - '2024-01-15' items: type: string format: date description: The start date of the placement for the employee endDate: type: array examples: - - '2024-01-15' items: type: string format: date description: The end date of the placement for the employee archiveYear: type: array examples: - - example items: type: string description: >- 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. employmentPercent: type: array examples: - - 42 items: type: integer description: >- The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%) description: Contains filter fields for EmployeePlacement EmployeePlacementFilterLike: type: object properties: meta: allOf: - $ref: '#/components/schemas/MetaFilterLike' description: Metadata information for the EmployeePlacement nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterLike' examples: - sourceID: example source: example - null description: >- 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. nullable: true signature: type: string examples: - example - null description: >- 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). nullable: true title: type: string examples: - example - null description: The title of the employee nullable: true archiveYear: type: string examples: - example - null description: >- 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. nullable: true description: LIKE filter fields for EmployeePlacement EmployeePlacementFilterNull: type: object properties: meta: allOf: - $ref: '#/components/schemas/MetaFilterNull' examples: - createdBy: true updatedAt: true updatedBy: true - null description: Metadata information for the EmployeePlacement nullable: true external: allOf: - $ref: '#/components/schemas/ExternalFilterNull' examples: - sourceID: true source: true - null description: >- 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. nullable: true signature: type: boolean examples: - true - null description: >- 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). nullable: true title: type: boolean examples: - true - null description: The title of the employee nullable: true roles: type: boolean examples: - true - null description: The roles of the employee nullable: true endDate: type: boolean examples: - true - null description: The end date of the placement for the employee nullable: true archiveYear: type: boolean examples: - true - null description: >- 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. nullable: true archivedAt: type: boolean examples: - true - null description: The timestamp the placement was archived for the employee nullable: true employmentPercent: type: boolean examples: - true - null description: >- The percentage of employment for the employee at this school, represented as an integer (e.g., 100 for 100%, 50 for 50%) nullable: true description: Null filter fields for EmployeePlacement Meta: type: object properties: createdAt: type: string examples: - '2024-01-15T10:30:00Z' format: date-time description: Timestamp when the resource was created createdBy: type: string examples: - 987fcdeb-51a2-43d1-b567-123456789abc - null format: uuid description: User who created the resource nullable: true updatedAt: type: string examples: - '2024-01-15T14:45:00Z' - null format: date-time description: Timestamp when the resource was last updated nullable: true updatedBy: type: string examples: - 987fcdeb-51a2-43d1-b567-123456789abc - null format: uuid description: User who last updated the resource nullable: true required: - createdAt description: >- Meta contains information about the creation and modification of a resource for auditing purposes External: type: object properties: sourceID: type: string examples: - '12345678' - null description: The ID of the external source nullable: true source: type: string examples: - ExternalIntegrationAPI - null description: The source of the external information nullable: true description: >- External is a reusable object that can be used to store external information from another system, used for third-party integration tracking. EmployeePlacementRole: type: string enum: - Admin - CareTeam - Manager - MealPlanner - OtherPersonnel - Scheduler - Teacher description: The role of the employee in the placement ErrorCode: type: string enum: - BadRequest - Unauthorized - Forbidden - NotFound - Conflict - UnprocessableEntity - RateLimited - Internal description: Standard error codes used in API responses MetaFilterEquals: type: object properties: createdAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was created nullable: true createdBy: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: User who created the resource nullable: true updatedAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was last updated nullable: true updatedBy: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 - null format: uuid description: User who last updated the resource nullable: true description: Equality/Inequality filter fields for Meta ExternalFilterEquals: type: object properties: sourceID: type: string examples: - example - null description: The ID of the external source nullable: true source: type: string examples: - example - null description: The source of the external information nullable: true description: Equality/Inequality filter fields for External MetaFilterRange: type: object properties: createdAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was created nullable: true updatedAt: type: string examples: - '2024-01-15T10:30:00Z' - null format: date-time description: Timestamp when the resource was last updated nullable: true description: Range filter fields for Meta ExternalFilterRange: type: object description: Range filter fields for External MetaFilterContains: type: object properties: createdBy: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: User who created the resource updatedBy: type: array examples: - - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: User who last updated the resource description: Contains filter fields for Meta ExternalFilterContains: type: object properties: sourceID: type: array examples: - - example items: type: string description: The ID of the external source source: type: array examples: - - example items: type: string description: The source of the external information description: Contains filter fields for External MetaFilterLike: type: object description: LIKE filter fields for Meta ExternalFilterLike: type: object properties: sourceID: type: string examples: - example - null description: The ID of the external source nullable: true source: type: string examples: - example - null description: The source of the external information nullable: true description: LIKE filter fields for External MetaFilterNull: type: object properties: createdBy: type: boolean examples: - true - null description: User who created the resource nullable: true updatedAt: type: boolean examples: - true - null description: Timestamp when the resource was last updated nullable: true updatedBy: type: boolean examples: - true - null description: User who last updated the resource nullable: true description: Null filter fields for Meta ExternalFilterNull: type: object properties: sourceID: type: boolean examples: - true - null description: The ID of the external source nullable: true source: type: boolean examples: - true - null description: The source of the external information nullable: true description: Null filter fields for External securitySchemes: ClientCredentials: type: apiKey name: Client-ID in: header ClientSecret: type: apiKey name: Client-Secret in: header OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: /oauth/token scopes: {} ````