Skip to main content
PATCH
Csharp (SDK)

Authorizations

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

Path Parameters

id
string<uuid>
required

The ID of the student placement to restore

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Response for StudentPlacement Restore operation

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

id
string<uuid>
required

Unique identifier for the StudentPlacement

Example:

"123e4567-e89b-12d3-a456-426614174000"

studentID
string<uuid>
required

The ID of the student the placement belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

schoolID
string<uuid>
required

The ID of the school the student is placed in

Example:

"123e4567-e89b-12d3-a456-426614174000"

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,
VUX,
VUXSFI
Example:

"GR"

startDate
string<date>
required

The start date of the placement

Example:

"2024-08-01"

meta
object

Metadata information for the StudentPlacement

Example:
external
object | null

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:
schoolYear
enum<string> | null

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

Example:

true

childcareMaxHours
integer | null

The maximum number of childcare hours per week for the student at this school

Examples:

15

null

motherTongue
string | null

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

Examples:

"SWE"

null

modernLanguageAlternative
enum<string> | null

The modern language alternative for the student

Available options:
EN,
ML,
SV,
SVA,
TN
Example:

"EN"

swedishAsSecondLanguage
boolean
default:false

Whether the student has Swedish as their second language

Example:

false

motherTongueParticipates
boolean
default:false

Whether the student participates in mother tongue education

Example:

false

modernLanguageInSchoolChoice
string | null

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

Examples:

"deu"

null

modernLanguageInLanguageChoice
string | null

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

Examples:

"fra"

null

endDate
string<date> | null

The end date of the placement

Examples:

"2025-08-01"

null

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.

Examples:

"2024_2025"

null

archivedAt
string<date-time> | null

The timestamp the placement was archived for the student

Examples:

"2024-08-01T00:00:00Z"

null