Sign in

v2

latestOpenAPI 3.1.0Proprietary - Licensed to Authorized Customers Only2026-07-31611061.1 MB
StudentPlacement

Create a new StudentPlacement

Create a new StudentPlacement

post/student-placement

Request body

studentIDstring uuid required

The ID of the student the placement belongs to

schoolIDstring 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

hasChildcareboolean

Whether the student has childcare

childcareMaxHoursinteger nullable

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

motherTonguestring 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

swedishAsSecondLanguageboolean

Whether the student has Swedish as their second language

motherTongueParticipatesboolean

Whether the student participates in mother tongue education

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

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

startDatestring date required

The start date of the placement

endDatestring date nullable

The end date of the placement

Example request

{
  "external": {
    "sourceID": "12345678"
  },
  "studentID": "123e4567-e89b-12d3-a456-426614174000",
  "schoolID": "123e4567-e89b-12d3-a456-426614174000",
  "hasChildcare": true,
  "childcareMaxHours": 15,
  "motherTongue": "SWE",
  "modernLanguageInSchoolChoice": "deu",
  "modernLanguageInLanguageChoice": "fra",
  "startDate": "2024-08-01",
  "endDate": "2025-08-01"
}

Response

Response for StudentPlacement Create operation - returns the created StudentPlacement

idstring uuid required

Unique identifier for the StudentPlacement

studentIDstring uuid required

The ID of the student the placement belongs to

schoolIDstring 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

hasChildcareboolean

Whether the student has childcare

childcareMaxHoursinteger nullable

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

motherTonguestring 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

swedishAsSecondLanguageboolean

Whether the student has Swedish as their second language

motherTongueParticipatesboolean

Whether the student participates in mother tongue education

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

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

startDatestring date required

The start date of the placement

endDatestring date nullable

The end date of the placement

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

archivedAtstring date-time nullable

The timestamp the placement was archived for the student

Example response

{
  "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",
  "hasChildcare": true,
  "childcareMaxHours": 15,
  "motherTongue": "SWE",
  "modernLanguageInSchoolChoice": "deu",
  "modernLanguageInLanguageChoice": "fra",
  "startDate": "2024-08-01",
  "endDate": "2025-08-01",
  "archiveYear": "2024_2025",
  "archivedAt": "2024-08-01T00:00:00Z"
}