Content Comparison

Titel

Association API

Status

Versie

Documentatie: 0.9.34

schemaVersion: 0.9.46

Datum

7 mei 17 juni 2025

Auteurs

Werkgroep Doorgifte Administratie

Acties

• Review en doorontwikkeling op basis van input LAS leveranciers

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

enrollmentId

string

uuid

Een unieke identifier voor het object

V

organisationId

string

uuid

De unieke identifier van de Onderwijsaanbieder (Organisation) die gegenereerd is door het Administratiesysteem onderwijsdeelnemer.

V*

student

object

UserReference

Een referentie naar een onderwijsdeelnemer.

Zie referentie Eindgebruiker

V

enrollmentType

string

ENUM

Het type inschrijving. Hierbij wordt een ENUM gehanteerd bestaande uit:

• study

• subject

study

V

Inschrijvingen op AangebodenOpleidingen worden minimaal beschikbaar gesteld.

De vullingsregels voor inschrijvingen op vakken moet nog bepaald worden.

study

string

uuid

Een referentie naar een AangebodenOpleiding (StudyOffering) object waarop de onderwijsdeelnemer is ingeschreven.

V*

Verwijzing naar studyOfferingId

Verplicht indien het enrollmentType study betreft.

studyPublicId

string

uuid

Een referentie naar een AangebodenOpleiding in RIO.

O

Verwijzing naar id in RIO.

studyYear

integer

integer

Het opleidingsjaar waarop deze Inschrijving van toepassing is.

1

V*

Verplicht indien het enrollmentType study of school betreft.

location

object

LocationReference

De locatie van de AangebodenOpleiding waar de Onderwijsdeelnemer op is ingeschreven.

Zie LocationReference

O

subject

string

uuid

Een referentie naar een AangebodenVak (SubjectOffering) object waarop de onderwijsdeelnemer is ingeschreven.

V*

Verwijzing naar subjectOfferingId

Verplicht indien het enrollmentType subject betreft.

schoolPeriod

string

uuid

Een referentie naar een Schoolperiode (SchoolPeriod) object waarbinnen de inschrijving valt.

V

Verwijzing naar schoolPeriodId

Waarde mag niet gewijzigd worden

beginDate

string

date

Begindatum van de inschrijving

2022-08-01

V

De begindatum van de inschrijving kan afwijken van de startdatum van de schoolperiode.

endDate

string

date

Einddatum van de inschrijving

2023-07-31

O

De einddatum is een verplicht veld indien de inschrijving eerder afloopt dan de schoolperiode.

status

string

ENUM

De status van dit object.

active
tobedeleted

V

De status is een verplicht veld en geef aan of het object al dan niet verwijderd kan worden.

dateCreated

string

datetime

Datum en tijdstip waarop de entiteit is aangemaakt

2017-07-21T17:32:28Z

V

dateLastModified

string

datetime

Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd

2022-08-11T15:31:12Z

V

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

assignmentId

string

string

Een unieke identifier voor het object

V

employee

object

UserReference

Een referentie naar een onderwijsmedewerker.

Zie referentie Eindgebruiker

V

assignmentType

string

ENUM

Het type inschrijving. Hierbij wordt een ENUM gehanteerd bestaande uit:

• class-teacher

• teacher

• coach

teacher

V

Het toewijzingstype betreft één van:

• Klassendocent (in het primair onderwijs ook wel leerkracht en in het voortgezet onderwijs mentor)

• Vakdocent (in het primair onderwijs ook wel leerkracht voor een vak en in het voortgezet onderwijs de vakdocent)

• Begeleider (in het primair onderwijs de individueel begeleider van een leerling en in het voortgezet onderwijs bijvoorbeeld de persoonlijke mentor)

group

string

string

Een referentie naar een Groep (Group) object waar de onderwijsmedewerker aan is toegewezen.

V*

Verwijzing naar groupId

Verplicht indien het assignmentType class-teacher of teacher betreft.

subject

string

string

Een referentie naar een AangebodenVak (SubjectOffering) object dat wordt onderwezen in de groepWerkgroep Administratiesystemen

V*

Verwijzing naar subjectOfferingId

Dit is een verplicht veld indien het assignmentType teacher betreft én de onderwijsmedewerker voor een enkel AangebodenVak toegewezen is aan de groep.

student

string

UserReference

Een referentie naar een onderwijsdeelnemer waar de onderwijsmedewerker aan is toegewezen.

Zie referentie Eindgebruiker

V*

Verplicht indien het assignmentType coach betreft.

schoolPeriod

string

string

Een referentie naar een Schoolperiode (SchoolPeriod) object waarbinnen de inschrijving valt.

V

Verwijzing naar schoolPeriodId

Waarde mag niet gewijzigd worden

beginDate

string

date

Begindatum van de toewijzing

2022-08-01

V

De begindatum van de toewijzing kan afwijken van de startdatum van de schoolperiode.

endDate

string

date

Einddatum van de toewijzing

2023-07-31

O

De einddatum is een verplicht veld indien de toewijzing eerder afloopt dan de schoolperiode.

status

string

ENUM

De status van dit object.

active
tobedeleted

V

De status is een verplicht veld en geef aan of het object al dan niet verwijderd kan worden.

dateCreated

string

datetime

Datum en tijdstip waarop de entiteit is aangemaakt

2017-07-21T17:32:28Z

V

dateLastModified

string

datetime

Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd

2022-08-11T15:31:12Z

V

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

groupId

string

string

De unieke identifier van de SchoolLesGroep

V

Waarde mag niet gewijzigd worden

groupName

string

string

Naam van de groep

A4bBiol

V

groupType

string

ENUM

The type groep. Hierbij wordt een ENUM gehanteerd:

• class

• lesson-group

class

V

class wordt gekozen indien het een stamgroep betreft.

lesson-group wordt gekozen indien het een lesgroep is.

students

array

UserReference

Referentie naar de onderwijsdeelnemers die lid zijn van de stamgroep of de lesgroep

Zie referentie Eindgebruiker

V

Onderwijsdeelnemers worden aan het Group object toegevoegd conform de volgende regels:

• Als de requestdatum na de begindatum van de groep zit: alle onderwijsdeelnemers die op de datum van de requestdatum daadwerkelijk lid zijn van de groep. Dus niet de onderwijsdeelnemers die in de toekomst lid worden van de groep.

• Als de requestdatum voor de begindatum van de groep zit: voor alle onderwijsdeelnemers die vanaf de begindatum in de groep zitten. (Dit is vooral handig om de groepen voor het volgende schooljaar uit te wisselen).

assignments

array

string

Een referentie naar een Toewijzing (Assignment) waarin een onderwijsmedewerker is toegewezen aan deze groep.

V

Verwijzing naar assignmentId

schoolPeriod

string

string

Een referentie naar een Schoolperiode (SchoolPeriod) object waarbinnen de inschrijving valt.

2021-2022

V

Verwijzing naar schoolPeriodId

Waarde mag niet gewijzigd worden

beginDate

string

date

Begindatum van de groep

2022-08-01

V

De begindatum van de groep kan afwijken van de startdatum van de schoolperiode.

endDate

string

date

Einddatum van de groep

2023-07-31

O

De einddatum is een verplicht veld indien de groep eerder afloopt dan de schoolperiode.

status

string

ENUM

De status van dit object.

active
tobedeleted

V

De status is een verplicht veld en geef aan of het object al dan niet verwijderd kan worden.

dateCreated

string

datetime

Datum en tijdstip waarop de entiteit is aangemaakt

2017-07-21T17:32:28Z

V

dateLastModified

string

datetime

Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd

2022-08-11T15:31:12Z

V