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


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

    res = m_client.student_placements.archive(id="123e4567-e89b-12d3-a456-426614174000")

    # Handle response
    print(res)
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
    "updatedAt": "2024-01-15T14:45:00Z",
    "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
  },
  "external": {
    "sourceID": "12345678",
    "source": "ExternalIntegrationAPI"
  },
  "studentID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolType": "GR",
  "schoolYear": "1",
  "hasChildcare": true,
  "motherTongue": "SWE",
  "startDate": "2024-08-01",
  "endDate": "2025-08-01",
  "archiveYear": "2024_2025",
  "archivedAt": "2024-08-01T00:00:00Z"
}

Authorizations

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

Path Parameters

​
id
string<uuid>
required

The ID of the student placement to archive

Response

Response for StudentPlacement Archive operation

StudentPlacement holds the placement information about a student in a specific school.

​
id
string<uuid>
required

Unique identifier for the StudentPlacement

​
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
enum<string>
required

The school type for the student, if not provided on Create, the school type will be fetched from the school.

Available options:
GR,
GRAN,
GY,
GYAN,
FS
Example:

"GR"

​
startDate
string<date>
required

The start date of the placement

​
meta
object

Metadata information for the StudentPlacement

Example:
{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
  "updatedAt": "2024-01-15T14:45:00Z",
  "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
}
​
external
object

External is a reusable object that can be used to store external information about the student placement from another system, used for third-party integration tracking.

Example:
{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}
​
schoolYear
enum<string>

The school year the student is placed in

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
Example:

"1"

​
hasChildcare
boolean
default:false

Whether the student has childcare

​
motherTongue
string | null

The mother tongue of the student. Language codes follow the ISO 639-3 standard (three-letter codes).

​
endDate
string<date> | null

The end date of the placement

​
archiveYear
string | null

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> | null

The timestamp the placement was archived for the student