> ## 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. # Archive a student placement > Archive a student placement. **Recommended usage:** We recommend only archiving student placements that have a passed end date. When building syncs from external systems and a studentPlacement is removed, we recommend the following workflow: 1. Set the `endDate` to the date when the studentPlacement was removed from the external system 2. Wait approximately 5 days before archiving the student placement This grace period allows time to correct any mistakes made by administrators in the external system before the placement is permanently archived. ## OpenAPI ````yaml https://spec.speakeasy.com/meitner-2u8/api/directory-api-with-code-samples patch /student-placement/{id}/archive 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: /student-placement/{id}/archive: patch: tags: - StudentPlacement summary: Archive a student placement description: > Archive a student placement. **Recommended usage:** We recommend only archiving student placements that have a passed end date. When building syncs from external systems and a studentPlacement is removed, we recommend the following workflow: 1. Set the `endDate` to the date when the studentPlacement was removed from the external system 2. Wait approximately 5 days before archiving the student placement This grace period allows time to correct any mistakes made by administrators in the external system before the placement is permanently archived. operationId: StudentPlacementArchive parameters: - name: id in: path description: The ID of the student placement to archive required: true schema: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid responses: '200': $ref: '#/components/responses/StudentPlacementArchive' description: Response for StudentPlacement Archive operation '400': $ref: '#/components/responses/Error400ResponseBody' description: >- Bad Request error for StudentPlacement Archive operation - request contains invalid parameters '401': $ref: '#/components/responses/Error401ResponseBody' description: >- Unauthorized error for StudentPlacement Archive operation - authentication required '403': $ref: '#/components/responses/Error403ResponseBody' description: >- Forbidden error for StudentPlacement Archive operation - insufficient permissions '404': $ref: '#/components/responses/Error404ResponseBody' description: >- Not Found error for StudentPlacement Archive operation - resource does not exist '409': $ref: '#/components/responses/Error409ResponseBody' description: >- Conflict error for StudentPlacement Archive operation - request conflicts with current state '429': $ref: '#/components/responses/Error429ResponseBody' description: >- Rate Limit error for StudentPlacement Archive operation - too many requests '500': $ref: '#/components/responses/Error500ResponseBody' description: >- Internal Server error for StudentPlacement Archive operation - unexpected server error x-codeSamples: - lang: csharp label: Csharp (SDK) source: >- using Meitner; using Meitner.Models.Components; var sdk = new MeitnerSDK(security: new Security() { Option1 = new SecurityOption1() { ClientCredentials = "", ClientSecret = "", }, }); var res = await sdk.StudentPlacements.ArchiveAsync(id: "123e4567-e89b-12d3-a456-426614174000"); // handle response - lang: python label: Python (SDK) source: |- from meitner import Meitner, models 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.student_placements.archive(id="123e4567-e89b-12d3-a456-426614174000") # Handle response print(res) components: responses: StudentPlacementArchive: description: Response for StudentPlacement Archive 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: allOf: - $ref: '#/components/schemas/StudentPlacement' examples: responseExample: summary: Response body example value: 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 studentID: 123e4567-e89b-12d3-a456-426614174000 schoolID: 123e4567-e89b-12d3-a456-426614174000 schoolType: GR schoolYear: '1' hasChildcare: true childcareMaxHours: 15 motherTongue: SWE modernLanguageAlternative: EN swedishAsSecondLanguage: false motherTongueParticipates: false modernLanguageInSchoolChoice: deu modernLanguageInLanguageChoice: fra startDate: '2024-08-01' endDate: '2025-08-01' archiveYear: '2024_2025' archivedAt: '2024-08-01T00:00:00Z' 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 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: StudentPlacement: type: object properties: id: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: Unique identifier for the StudentPlacement 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 StudentPlacement 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 student placement from another system, used for third-party integration tracking. nullable: true studentID: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: The ID of the student the placement belongs to schoolID: type: string examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid description: The ID of the school the student is placed in schoolType: allOf: - $ref: '#/components/schemas/StudentPlacementSchoolType' examples: - GR description: >- The school type for the student, if not provided on Create, the school type will be fetched from the school. schoolYear: allOf: - $ref: '#/components/schemas/SchoolYear' examples: - '1' - null description: The school year the student is placed in nullable: true hasChildcare: type: boolean examples: - true description: Whether the student has childcare default: false childcareMaxHours: type: integer examples: - 15 - null description: >- The maximum number of childcare hours per week for the student at this school nullable: true motherTongue: type: string examples: - SWE - null description: >- The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes). nullable: true modernLanguageAlternative: allOf: - $ref: '#/components/schemas/ModernLanguageAlternative' examples: - EN - null description: The modern language alternative for the student nullable: true swedishAsSecondLanguage: type: boolean examples: - false description: Whether the student has Swedish as their second language default: false motherTongueParticipates: type: boolean examples: - false description: Whether the student participates in mother tongue education default: false modernLanguageInSchoolChoice: type: string examples: - deu - null description: >- 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). nullable: true modernLanguageInLanguageChoice: type: string examples: - fra - null description: >- 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). nullable: true startDate: type: string examples: - '2024-08-01' format: date description: The start date of the placement endDate: type: string examples: - '2025-08-01' - null format: date description: The end date of the placement nullable: true archiveYear: type: string examples: - '2024_2025' - null description: >- 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. nullable: true archivedAt: type: string examples: - '2024-08-01T00:00:00Z' - null format: date-time description: The timestamp the placement was archived for the student nullable: true required: - id - studentID - schoolID - schoolType - startDate description: >- StudentPlacement holds the placement information about a student in a specific school. 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 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. StudentPlacementSchoolType: type: string enum: - GR - GRAN - GY - GYAN - FS - VUX - VUXSFI description: The type of schooling the student is attending SchoolYear: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' description: The school year the student is attending ModernLanguageAlternative: type: string enum: - EN - ML - SV - SVA - TN description: The modern language alternative for the student ErrorCode: type: string enum: - BadRequest - Unauthorized - Forbidden - NotFound - Conflict - UnprocessableEntity - RateLimited - Internal description: Standard error codes used in API responses 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: {} ````