--- title: "Search StudentPlacements" method: POST path: "/student-placement/_search" tags: ["StudentPlacement"] --- # Search StudentPlacements `POST /student-placement/_search` Search for `StudentPlacements` with filtering capabilities. ## Query parameters - `limit` integer - `offset` integer ## Request body - object - `filter` StudentPlacementFilter, required — Filter object for StudentPlacement - `equals` StudentPlacementFilterEquals — Equality/Inequality filter fields for StudentPlacement - `id` string, uuid, nullable — Unique identifier for the StudentPlacement - `meta` MetaFilterEquals — Equality/Inequality filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `createdBy` string, uuid, nullable — User who created the resource - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `updatedBy` string, uuid, nullable — User who last updated the resource - `external` ExternalFilterEquals — Equality/Inequality filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `studentID` string, uuid, nullable — The ID of the student the placement belongs to - `schoolID` string, uuid, nullable — The ID of the school the student is placed in - `schoolType` 'GR' | 'GRAN' | 'GY' | 'GYAN' | 'FS' | 'VUX' | 'VUXSFI' — The type of schooling the student is attending - `schoolYear` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' — The school year the student is attending - `hasChildcare` boolean, nullable — Whether the student has childcare - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `motherTongue` string, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` 'EN' | 'ML' | 'SV' | 'SVA' | 'TN' — The modern language alternative for the student - `swedishAsSecondLanguage` boolean, nullable — Whether the student has Swedish as their second language - `motherTongueParticipates` boolean, nullable — Whether the student participates in mother tongue education - `modernLanguageInSchoolChoice` string, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `startDate` string, date, nullable — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archiveYear` string, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `notEquals` StudentPlacementFilterEquals — Equality/Inequality filter fields for StudentPlacement - `id` string, uuid, nullable — Unique identifier for the StudentPlacement - `meta` MetaFilterEquals — Equality/Inequality filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `createdBy` string, uuid, nullable — User who created the resource - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `updatedBy` string, uuid, nullable — User who last updated the resource - `external` ExternalFilterEquals — Equality/Inequality filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `studentID` string, uuid, nullable — The ID of the student the placement belongs to - `schoolID` string, uuid, nullable — The ID of the school the student is placed in - `schoolType` 'GR' | 'GRAN' | 'GY' | 'GYAN' | 'FS' | 'VUX' | 'VUXSFI' — The type of schooling the student is attending - `schoolYear` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' — The school year the student is attending - `hasChildcare` boolean, nullable — Whether the student has childcare - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `motherTongue` string, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` 'EN' | 'ML' | 'SV' | 'SVA' | 'TN' — The modern language alternative for the student - `swedishAsSecondLanguage` boolean, nullable — Whether the student has Swedish as their second language - `motherTongueParticipates` boolean, nullable — Whether the student participates in mother tongue education - `modernLanguageInSchoolChoice` string, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `startDate` string, date, nullable — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archiveYear` string, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `greaterThan` StudentPlacementFilterRange — Range filter fields for StudentPlacement - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `startDate` string, date, nullable — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `smallerThan` StudentPlacementFilterRange — Range filter fields for StudentPlacement - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `startDate` string, date, nullable — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `greaterOrEqual` StudentPlacementFilterRange — Range filter fields for StudentPlacement - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `startDate` string, date, nullable — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `smallerOrEqual` StudentPlacementFilterRange — Range filter fields for StudentPlacement - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `startDate` string, date, nullable — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `contains` StudentPlacementFilterContains — Contains filter fields for StudentPlacement - `id` string[] — Unique identifier for the StudentPlacement - `meta` MetaFilterContains — Contains filter fields for Meta - `createdBy` string[] — User who created the resource - `updatedBy` string[] — User who last updated the resource - `external` ExternalFilterContains — Contains filter fields for External - `sourceID` string[] — The ID of the external source - `source` string[] — The source of the external information - `studentID` string[] — The ID of the student the placement belongs to - `schoolID` string[] — The ID of the school the student is placed in - `schoolType` StudentPlacementSchoolType[] — The school type for the student, if not provided on Create, the school type will be fetched from the school. - `schoolYear` SchoolYear[] — The school year the student is placed in - `hasChildcare` boolean[] — Whether the student has childcare - `childcareMaxHours` integer[] — The maximum number of childcare hours per week for the student at this school - `motherTongue` string[] — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` ModernLanguageAlternative[] — The modern language alternative for the student - `swedishAsSecondLanguage` boolean[] — Whether the student has Swedish as their second language - `motherTongueParticipates` boolean[] — Whether the student participates in mother tongue education - `modernLanguageInSchoolChoice` string[] — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string[] — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `startDate` string[] — The start date of the placement - `endDate` string[] — The end date of the placement - `archiveYear` string[] — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `notContains` StudentPlacementFilterContains — Contains filter fields for StudentPlacement - `id` string[] — Unique identifier for the StudentPlacement - `meta` MetaFilterContains — Contains filter fields for Meta - `createdBy` string[] — User who created the resource - `updatedBy` string[] — User who last updated the resource - `external` ExternalFilterContains — Contains filter fields for External - `sourceID` string[] — The ID of the external source - `source` string[] — The source of the external information - `studentID` string[] — The ID of the student the placement belongs to - `schoolID` string[] — The ID of the school the student is placed in - `schoolType` StudentPlacementSchoolType[] — The school type for the student, if not provided on Create, the school type will be fetched from the school. - `schoolYear` SchoolYear[] — The school year the student is placed in - `hasChildcare` boolean[] — Whether the student has childcare - `childcareMaxHours` integer[] — The maximum number of childcare hours per week for the student at this school - `motherTongue` string[] — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` ModernLanguageAlternative[] — The modern language alternative for the student - `swedishAsSecondLanguage` boolean[] — Whether the student has Swedish as their second language - `motherTongueParticipates` boolean[] — Whether the student participates in mother tongue education - `modernLanguageInSchoolChoice` string[] — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string[] — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `startDate` string[] — The start date of the placement - `endDate` string[] — The end date of the placement - `archiveYear` string[] — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `like` StudentPlacementFilterLike — LIKE filter fields for StudentPlacement - `meta` MetaFilterLike — LIKE filter fields for Meta - `external` ExternalFilterLike — LIKE filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `motherTongue` string, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageInSchoolChoice` string, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `archiveYear` string, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `notLike` StudentPlacementFilterLike — LIKE filter fields for StudentPlacement - `meta` MetaFilterLike — LIKE filter fields for Meta - `external` ExternalFilterLike — LIKE filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `motherTongue` string, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageInSchoolChoice` string, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `archiveYear` string, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `null` StudentPlacementFilterNull — Null filter fields for StudentPlacement - `meta` MetaFilterNull — Null filter fields for Meta - `createdBy` boolean, nullable — User who created the resource - `updatedAt` boolean, nullable — Timestamp when the resource was last updated - `updatedBy` boolean, nullable — User who last updated the resource - `external` ExternalFilterNull — Null filter fields for External - `sourceID` boolean, nullable — The ID of the external source - `source` boolean, nullable — The source of the external information - `schoolYear` boolean, nullable — The school year the student is placed in - `childcareMaxHours` boolean, nullable — The maximum number of childcare hours per week for the student at this school - `motherTongue` boolean, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` boolean, nullable — The modern language alternative for the student - `modernLanguageInSchoolChoice` boolean, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` boolean, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `endDate` boolean, nullable — The end date of the placement - `archiveYear` boolean, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `archivedAt` boolean, nullable — The timestamp the placement was archived for the student - `notNull` StudentPlacementFilterNull — Null filter fields for StudentPlacement - `meta` MetaFilterNull — Null filter fields for Meta - `createdBy` boolean, nullable — User who created the resource - `updatedAt` boolean, nullable — Timestamp when the resource was last updated - `updatedBy` boolean, nullable — User who last updated the resource - `external` ExternalFilterNull — Null filter fields for External - `sourceID` boolean, nullable — The ID of the external source - `source` boolean, nullable — The source of the external information - `schoolYear` boolean, nullable — The school year the student is placed in - `childcareMaxHours` boolean, nullable — The maximum number of childcare hours per week for the student at this school - `motherTongue` boolean, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` boolean, nullable — The modern language alternative for the student - `modernLanguageInSchoolChoice` boolean, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` boolean, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `endDate` boolean, nullable — The end date of the placement - `archiveYear` boolean, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `archivedAt` boolean, nullable — The timestamp the placement was archived for the student - `orCondition` boolean, required — OrCondition decides if this filter is within an OR-condition or AND-condition - `nestedFilters` StudentPlacementFilter[] — NestedFilters of the StudentPlacement, useful for more complex filters ## Response `200` Response for StudentPlacement Search operation - returns filtered StudentPlacement results - object - `data` StudentPlacement[] — Array of StudentPlacement objects - `id` string, uuid, required — Unique identifier for the StudentPlacement - `meta` Meta — Meta contains information about the creation and modification of a resource for auditing purposes - `createdAt` string, date-time, required — Timestamp when the resource was created - `createdBy` string, uuid, nullable — User who created the resource - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `updatedBy` string, uuid, nullable — User who last updated the resource - `external` External — External is a reusable object that can be used to store external information from another system, used for third-party integration tracking. - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `studentID` string, uuid, required — The ID of the student the placement belongs to - `schoolID` string, uuid, required — The ID of the school the student is placed in - `schoolType` 'GR' | 'GRAN' | 'GY' | 'GYAN' | 'FS' | 'VUX' | 'VUXSFI', required — The type of schooling the student is attending - `schoolYear` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' — The school year the student is attending - `hasChildcare` boolean — Whether the student has childcare - `childcareMaxHours` integer, nullable — The maximum number of childcare hours per week for the student at this school - `motherTongue` string, nullable — The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). - `modernLanguageAlternative` 'EN' | 'ML' | 'SV' | 'SVA' | 'TN' — The modern language alternative for the student - `swedishAsSecondLanguage` boolean — Whether the student has Swedish as their second language - `motherTongueParticipates` boolean — Whether the student participates in mother tongue education - `modernLanguageInSchoolChoice` string, nullable — The language code for the student's modern language in school choice (Skolans val). Language codes follow the ISO 639-2 standard (three-letter codes). - `modernLanguageInLanguageChoice` string, nullable — The language code for the student's modern language in language choice (Språkval, M2, B-språk). Language codes follow the ISO 639-2 standard (three-letter codes). - `startDate` string, date, required — The start date of the placement - `endDate` string, date, nullable — The end date of the placement - `archiveYear` string, nullable — The year the placement was archived for the student, in the format YYYY_YYYY where the first year is the autumn and the second year is the spring. - `archivedAt` string, date-time, nullable — The timestamp the placement was archived for the student - `pagination` Pagination — Pagination parameters for controlling result sets in list operations - `offset` integer, required — Number of items to skip from the beginning of the result set - `limit` integer, required — Maximum number of items to return in the result set - `total` integer, required — Total number of items available for pagination ## Other responses - `400` — Bad Request - The request was malformed or contained invalid parameters - `401` — Unauthorized - The request is missing valid authentication credentials - `403` — Forbidden - Request is authenticated, but the user is not allowed to perform the operation - `404` — Not Found - The requested resource does not exist - `409` — Conflict - The request could not be completed due to a conflict - `422` — Validation error for StudentPlacement Search operation - request data failed validation - `429` — Too Many Requests - When the rate limit has been exceeded - `500` — Internal Server Error - An unexpected server error occurred --- [API](https://skmtc.net/meitner/apis/directory-api.md) · [All operations](https://skmtc.net/meitner/apis/directory-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meitner/directory-api/revisions/014348a7bc35/schema)