Inleiding

Zermelo is actief in het Nederlands Voortgezet Onderwijs en ondersteunt scholen bij het maken van zowel de roosters als de formatie. De Zermelo API bevat daaraan gerelateerde gegevens. Voor algemene informatie over ons bedrijf, zie zermelo.nl. Deze documentatie is voor ontwikkelaars die de Zermelo API willen gebruiken.

Als u begint met het ontwikkelen van een koppeling met Zermelo, is het verstandig dat te doen met een Partner Portal. Dit is een Zermelo Portal, net zoals scholen dat hebben. U kunt zo’n Portal bij ons aanvragen via partners@zermelo.nl, waar u ook terecht kunt voor vragen waar u niet uitkomt met behulp van deze documentatie en een eerlijke inspanning van uw kant.

Als u tegen onze API aan wilt gaan praten, raden we u aan om u ook te abonneren op onze nieuwsbrief API-updates (voor ontwikkelaars). Zo blijft u op de hoogte van de nieuwste mogelijkheden, en eventuele wijzigingen waar u als koppelpartner wat mee moet.

Voor informatie over het verkrijgen van toegang tot de API kunt u terecht op Authenticatie en autorisatie. Voor informatie over de vorm van een request en response kijkt u op De Zermelo API. Onder Endpoints vindt u per endpoint informatie over de velden en filters van dat endpoint.

Heeft u al een koppeling, en wilt u weten hoe u deze om kunt zetten naar de nieuwe partner-rechten? Kijk dan op Migreren naar partner rechten!

Op deze pagina houden we wijzigingen bij die relevant zijn voor API-koppelingen. Dit kunnen functionele wijzigingen zijn aan ondersteunde velden, of (het aankondigen van) wijzigingen die niet backward-compatible zijn.

Backward-compatible wijzigingen zoals het toevoegen van (een nieuw veld aan) een endpoint zullen over het algemeen niet vermeld worden, maar zijn terug te vinden in de documentatie van het betreffende endpoint.

Changelog

Releasedatum	Versienummer	Wijziging	Toelichting
2026-06-08	26.06.0	`changed` veld op afspraken, zie appointments.	Klap uit We introduceren het `changed` filter, als vervanging voor het veelgebruikte `modified` veld op `appointments`. Mocht je in bestaande koppelingen filteren op het `modified` veld, vervang dit dan door `changed`.
2026-04-13	26.04.0	Eerste release “Partners” koppelsysteem	Klap uit Ondersteuning voor klanten om API koppelingen in te richten via het “Partners” systeem. Voor informatie over het migreren van bestaande koppelingen, zie Migreren naar partner rechten

Authenticatie en autorisatie

In het Portal kan een beheerder een Partner aanmaken en daar rechten aan koppelen. Hoe dit in zijn werk gaat staat op onze handleiding voor gebruikers. De beheerder kan bij die partner ook een authcode aanmaken. Deze authcode is eenmalig in te wisselen voor een token. Dat gaat als volgt:

POST /api/oauth/token?code=123456789012

response

{
  "access_token": "abc123abc123abc123abc123ab",
  "token_type": "bearer",
  "expires_in": 123456
}

Sla dit token na het ophalen direct ergens veilig op, want het is geen tweede keer op te halen!

Vervolgens kunt u dit token in ieder request meesturen in de Authorization header: Authorization: Bearer <access_token>.

Om te achterhalen welke rechten uw token heeft, kunt u gebruik maken van het endpoint /api/partners/~me

GET /api/partners/~me
Authorization: Bearer abc123abc123abc123abc123ab

response

{
  "name": "Partner",
  "token": {
    "expirationDate": "19-01-2038",
    "expires": 2147483647,
    "token": "abc1**********************",
    "creationDate": "01-01-1970",
    "created": 0
  },
  "endpoints": [
    {
      "writeFields": [],
      "readFields": [
        "firstName",
        "lastName",
        "code",
        "prefix"
      ],
      "endpoint": "users",
      "filterFields": [
        "firstName",
        "lastName",
        "code",
        "prefix",
        "fields",
        "schoolInSchoolYear"
      ]
    }
  ],
  "schoolInSchoolYears": [
    {
      "schoolYear": 2025,
      "school": {
        "id": 1,
        "name": "VoorbeeldSchool"
      },
      "id": 1001702
    },
    {
      "schoolYear": 2026,
      "school": {
        "id": 1,
        "name": "VoorbeeldSchool"
      },
      "id": 1001802
    }
  ]
}

Dit geeft u informatie over uw partner token zelf, met name tot wanneer het geldig is. Ook ziet u aan welke roosterprojecten van het Portal u als partner gekoppeld bent. En u ziet de endpoints waar u toegang tot hebt gekregen met de precieze velden die u mag opvragen.

De Zermelo API

De Zermelo API is een JSON REST-API die zich bevindt op https://<portalnaam>.zportal.nl/api.

Naast authenticatie zijn bij ieder verzoek (als koppelpartner) twee request parameters verplicht:

schoolInSchoolYear=...: een komma-gescheiden lijst id’s van roosterprojecten waar u rechten voor heeft.
fields=...: een komma-gescheiden lijst van de velden die u in het antwoord wilt krijgen.

Geldigde waardes voor zowel schoolInSchoolYear als fields zijn te verkrijgen via het /api/partners/~me endpoint. Hiervoor zijn bovenstaande parameters niet nodig. Zie Authenticatie en autorisatie voor meer informatie.

Naast deze parameters is het mogelijk andere parameters op te geven om de resultaten van het verzoek te filteren. Welke parameters mogelijk zijn verschilt per endpoint. Zie daarvoor de documentatie van dat endpoint. Op enkele endpoints zijn meer parameters nodig. Als u een request op zo’n endpoint doet, krijgt u daar een melding over. Een verzoek zou er als volgt uit kunnen zien:

GET /api/groupindepartments?schoolInSchoolYear=1001702,1001703&fields=id,departmentOfBranch,name,extendedName,yearOfEducation,isMainGroup

De respons van een API-verzoek is een JSON-object met de volgende standaardvorm:

{
    "response": {
        "status": <http-status>,
        "message": "",
        "details": "",
        "eventId": 0,
        "startRow": 0,
        "endRow": 0,
        "totalRows": 0,
        "data": [
            <een lijst met JSON-objecten>
        ]
    }
}

De velden message, details, en eventId zijn alleen gevuld in het geval van een foutmelding. Dit zult u kunnen herkennen aan de http-status. Mocht het nodig zijn om met Zermelo te communiceren over het probleem, dan is dit interessante informatie.

In de meeste gevallen zult u natuurlijk "status": 200 zien en geeft totalRows het aantal teruggegeven objecten. De objecten zelf vindt u in de lijst data.

Wat betekent ‘Ondersteund’ bij een veld?

In de documentatie per endpoint worden velden en filters verdeeld in bakjes ‘ondersteund’ en ‘niet ondersteund’.

Ondersteund

Over ondersteunde velden doen wij de volgende beloftes:

het veld betekent wat je zou verwachten dat het betekent aan de hand van de documentatie
het veld is geschikt om te verwerken in een koppeling
bij wijzigingen aan het veld die niet backward-compatible zijn…
- kondigen we dat tijdig aan
- bieden we een migratie-pad

Niet-ondersteund

Niet ondersteunde velden zijn simpelweg de velden waarvoor we een van bovenstaande beloftes niet hebben gedaan. Dat kan zijn omdat we de velden ongeschikt achten om te verwerken in een koppeling, of omdat we de flexibiliteit willen behouden om de betekenis van het veld aan te passen.

Het kan echter ook zijn omdat we nog niet bedacht hebben dat een koppeling het veld zou willen gebruiken. Als u denkt dat dit laatste het geval is: laat het ons weten!

Migreren naar partner rechten

Door de jaren heen zijn er verschillende manieren geweest om koppelingen rechten te geven. Voor een groot deel zijn die manieren gebaseerd geweest op hoe gewone gebruikers in het Zermelo Portal rechten krijgen. Daardoor is het vaak lastig om precies de juiste rechten te geven voor een koppeling.

De nieuwe Partner rechten zijn expliciet bedoeld om koppelpartijen toegang te geven tot precies de gegevens die nodig zijn voor een koppeling.

Uiteindelijk alles migreren

Het is op termijn de bedoeling dat alle koppelingen werken via partnerrechten. Voor veel koppelingen is het nu al mogelijk om over te gaan. Voor andere koppelingen zal er nog functionaliteit ontbreken. Loopt u ergens tegenaan, of ontbreekt er iets wat nodig is voor uw koppeling? Laat het ons weten!

Omdat we willen dat scholen een expliciete keuze maken welke rechten ze toekennen aan een partner, kunnen we bestaande koppelingen niet automatisch migreren. De school zal voor elke koppeling een partner aan moeten maken met de juiste rechten.

Wat gaat er veranderen?

API-versies

De API-versie gaat weg uit de URL. In plaats van /api/v3/endpoint maakt u nu gebruik van /api/endpoint. De rechten die u als partner krijgt werken alleen op dit nieuwe pad.

Tokens inwisselen en rechten inzien

Bij het aanmaken van een token krijgt de school niet langer het access_token terug, maar een authcode die eenmalig inwisselbaar is voor het token. De school stuurt deze code naar u op.

Daarnaast is er een nieuw endpoint /partners/~me waar u in kunt zien tot welke gegevens u toegang heeft.

Op Authenticatie en autorisatie staat meer uitleg en een voorbeeld. Op onze gebruikershandleiding staat uitleg voor scholen over het inrichten van een Partner.

Verplichte request parameters

De request parameters fields=... en schoolInSchoolYear=... worden op alle endpoints verplicht. Meer informatie over deze parameters vindt u op De Zermelo API

`X-Impersonated-By`

De impersonation header gaat er op termijn uit. In plaats daarvan is het als partner mogelijk om op /api/liveschedule requests te doen met student=X,week=Y,schoolInSchoolYear=Z. We zijn nog aan het onderzoeken hoe we de migratie voor koppelingen die nu gebruik maken van impersonation zo soepel mogelijk te maken.

Wat kan er nog niet?

Wij zijn nog druk in de weer met het uitbreiden van de mogelijkheden van het Partners-systeem. Zoals met ieder project in aanbouw, zijn er dus zaken die nog niet werken, of nog niet werken zoals we willen.

Als uw koppeling gebruik maakt van functionaliteit die nog ontbreekt, kunt u nog niet over. Wellicht is het al wel mogelijk om in uw Partner Portal te experimenteren met de functionaliteit die al wel aangeboden wordt. Houd onze API-mailing in de gaten voor uitbreidingen waardoor u misschien wel over kunt!

Voor het uitbreiden van de mogelijkheden richten wij ons in eerste instantie op de volgende zaken:

Bewerken

Momenteel is het alleen mogelijk om leesrechten te geven aan Partners. We zien inschrijven/uitschrijven via /liveschedule en gebruikersbeheer via /users als de belangrijkste endpoints om bewerken op mogelijk te maken. Als u andere uitbreidingen nodig heeft voor uw koppeling, laat het dan weten!

Endpoints ontbreken

We hebben bij het toevoegen van endpoints aan deze documentatie en het Partners-systeem gefocust op endpoints die vaker door koppelpartijen aangesproken worden. Daar zullen ongetwijfeld endpoints ontbreken.

Velden/filters zijn niet ‘Ondersteund’

We zijn terughoudend geweest in het bestempelen van velden als ‘ondersteund’ zodat we niet vastzitten aan functionaliteit waar niemand gebruik van maakt. Als u gebruik maakt van een veld wat nu als niet ondersteund te boek staat, horen wij het graag! Misschien vinden wij ook dat het ondersteund zou moeten zijn, of misschien hebben wij een alternatieve route om gegevens op te halen.

/appointments (Afspraakversies)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
appointmentInstance	Afspraak ID	long	✅	✅
appointmentLastModified	Laatst gewijzigd	timestamp	✅	❌
branchOfSchool	Vestiging	long	✅	✅
cancelled	Uitval	boolean	✅	✅
changeDescription	Wijzigingen	string	✅	✅
choosableInDepartmentCodes	Vak-op-afdeling	string[]	✅	❌
content	Onderwerp van de afspraak	string	✅	❌
created	Aangemaakt	timestamp	✅	✅
end	Eindtijd	timestamp	✅	✅
endTimeSlot	Laatste lesuur	integer	✅	✅
endTimeSlotName	Laatste lesuur	string	✅	✅
groupChanged	Groep gewijzigd	boolean	✅	✅
groups	Groep	string[]	✅	❌
hidden	Verwijderd	boolean	✅	✅
id	ID	long	✅	✅
lastModified	Laatst gewijzigd	timestamp	✅	❌
locationChanged	Lokaal gewijzigd	boolean	✅	✅
locations	Lokalen	string[]	✅	❌
optional	Keuzeles	boolean	✅	✅
schedulerRemark	Opmerking van de roostermaker	string	✅	✅
start	Starttijd	timestamp	✅	✅
startTimeSlot	Eerste lesuur	integer	✅	✅
startTimeSlotName	Eerste lesuur	string	✅	✅
students	Leerlingen	string[]	✅	❌
subjects	Vak	string[]	✅	✅
teacherChanged	Docent gewijzigd	boolean	✅	✅
teachers	Docent	string[]	✅	✅
timeChanged	Tijd gewijzigd	boolean	✅	✅
type	Type	string	✅	✅
valid	Geldig	boolean	✅	✅

Details

`appointmentInstance` long immutable

Afspraak ID

`appointmentLastModified` timestamp

Laatst gewijzigd

extra details:
Laatst gewijzigd tijd, exclusief wijzigingen aan leerlingdeelname

`branchOfSchool` long immutable

Vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`cancelled` boolean

Uitval

`changeDescription` string

Wijzigingen

`choosableInDepartmentCodes` string[]

Vak-op-afdeling

extra details:
De vakcodes, vooraf gegaan door de afdeling. Bijvoorbeeld: h4.entl

`content` string

Onderwerp van de afspraak

`created` timestamp

Aangemaakt

`end` timestamp verplicht bij aanmaken

Eindtijd

`endTimeSlot` integer

Laatste lesuur

extra details:
Het volgnummer van het eind-lesuur. Gebruik voor de weergave het veld endTimeSlotNamebereik: [1,-]

`endTimeSlotName` string

Laatste lesuur

`groupChanged` boolean

Groep gewijzigd

`groups` string[]

Groep

`hidden` boolean

Verwijderd

`id` long

`lastModified` timestamp

Laatst gewijzigd

extra details:
Laatst gewijzigd tijd, inclusief wijzigingen aan leerlingdeelname

`locationChanged` boolean

Lokaal gewijzigd

`locations` string[]

Lokalen

`optional` boolean

Keuzeles

extra details:
Geeft aan of de school deze les ziet als keuzeles. Merk op dat deze waarde geen technische gevolgen heeft: het is mogelijk dat er leerlingen zijn die verplicht aanwezig moeten zijn bij een keuzeles, of leerlingen die de keuze hebben om naar een niet-optionele les te gaan.

`schedulerRemark` string

Opmerking van de roostermaker

`start` timestamp verplicht bij aanmaken

Starttijd

`startTimeSlot` integer

Eerste lesuur

extra details:
Het volgnummer van het start-lesuur. Gebruik voor de weergave het veld startTimeSlotNamebereik: [1,-]

`startTimeSlotName` string

Eerste lesuur

`students` string[]

Leerlingen
verwijst naar: students.userCode (Leerlingen)

`subjects` string[]

Vak

`teacherChanged` boolean

Docent gewijzigd

`teachers` string[]

Docent

`timeChanged` boolean

Tijd gewijzigd

`type` string verplicht bij aanmaken immutable

Type
mogelijke waardes: exam, activity, lesson, talk, meeting, interlude

`valid` boolean

Geldig

ondersteunde extra filters

Filternaam	Omschrijving	Type
changed	beperk tot afspraken met wijzigingen	boolean
fields	opgevraagde velden	string
includeHidden	vraag ook verwijderde afspraakversies op	boolean
modifiedSince	beperk tot afspraakversies met een wijziging (inclusief leerlingdeelname) sinds het opgegeven moment	timestamp
schoolInSchoolYear	afspraken in de opgegeven roosterprojecten	long

Details

`changed` boolean

beperk tot afspraken met wijzigingen

`fields` string

opgevraagde velden

`includeHidden` boolean

vraag ook verwijderde afspraakversies op

`modifiedSince` timestamp

beperk tot afspraakversies met een wijziging (inclusief leerlingdeelname) sinds het opgegeven moment

extra details:
U kunt modifiedSince gebruiken om alleen wijzigingen op te vragen ten opzichte van de vorige keer dat u een verzoek heeft gedaan.

Om geen gegevens te missen, moet u een aantal richtlijnen volgen:

de verzoeken moeten, afgezien van modifiedSince, exact dezelfde parameters meegeven;
de waarde voor modifiedSince moet de hoogste waarde van lastModified zijn die u in het antwoord op uw vorige verzoek heeft ontvangen;
het verzoek moet de parameter includeHidden=true meegeven om verwijdering van afspraakversies op te merken.

`schoolInSchoolYear` long

afspraken in de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
alternativeSubject	Vak	string	✅	❌
availableSpace	Aantal nog beschikbare plekken	integer	✅	❌
base	Niet gebruiken	boolean	✅	✅
branch	Vestiging	string	✅	✅
cancelledReason	Uitvalcategorie	string	✅	❌
capacity	Capaciteit (maximaal aantal deelnemers)	integer	✅	❌
capacityManually	Capaciteit (maximaal aantal deelnemers) handmatig?	boolean	✅	❌
choosableInDepartments	Vak-op-afdeling	long[]	✅	✅
courses	Course id’s	long[]	✅	❌
creator	Aangemaakt door	string	✅	✅
departmentsOfBranches	Afdeling	long[]	✅	❌
expectedStudentCount	Verwacht aantal leerlingen	integer	✅	❌
expectedStudentCountOnline	Verwacht aantal online leerlingen	integer	✅	❌
extraStudentSource	Extra leerlingbron	string	✅	✅
groupsInDepartments	Groep	long[]	✅	✅
ignoreSubstitutions	Vervangingen formatief negeren	boolean	✅	✅
locationsOfBranch	Lokaal	long[]	✅	✅
modified	Niet gebruiken	boolean	✅	✅
moved	Niet gebruiken	boolean	✅	✅
new	Niet gebruiken	boolean	✅	✅
onlineLocationUrl	Online locatie	string	✅	❌
onlineStudents	Online leerlingen	string[]	✅	❌
onlineTeachers	Online docent	string[]	✅	❌
remark	Opmerking van de roostermaker en onderwerp van de afspraak	string	✅	❌
teachingTime	Onderwijstijd	integer	✅	❌
teachingTimeManually	Onderwijstijd handmatig?	boolean	✅	❌
udmUUID	UDM UUID	uuid	✅	❌

Details

`alternativeSubject` string

Vak

`availableSpace` integer

Aantal nog beschikbare plekken

`base` boolean

Niet gebruiken

`branch` string

Vestiging
verwijst naar: branches.id (Vestigingen)

`cancelledReason` string

Uitvalcategorie
mogelijke waardes: teachers, students, changedPlanning

`capacity` integer

Capaciteit (maximaal aantal deelnemers)

`capacityManually` boolean

Capaciteit (maximaal aantal deelnemers) handmatig?

`choosableInDepartments` long[]

Vak-op-afdeling
verwijst naar: choosableindepartments.id (Vak-op-afdeling)

`courses` long[]

Course id’s
verwijst naar: courses.id (Lesgroepen)

`creator` string

Aangemaakt door
verwijst naar: users.code (Gebruikers)

`departmentsOfBranches` long[]

Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`expectedStudentCount` integer

Verwacht aantal leerlingen
bereik: [0,-]

`expectedStudentCountOnline` integer

Verwacht aantal online leerlingen
bereik: [0,-]

`extraStudentSource` string

Extra leerlingbron
mogelijke waardes: departmentOfBranch, branchOfSchool

`groupsInDepartments` long[]

Groep
verwijst naar: groupindepartments.id (Roostergroepen)

`ignoreSubstitutions` boolean

Vervangingen formatief negeren

`locationsOfBranch` long[]

Lokaal
verwijst naar: locationofbranches.id (Lokalen)

`modified` boolean

Niet gebruiken

extra details:
Gebruik het extra filter changed om te filteren op afspraken met wijzigingen

`moved` boolean

Niet gebruiken

`new` boolean

Niet gebruiken

`onlineLocationUrl` string

Online locatie

`onlineStudents` string[]

Online leerlingen

`onlineTeachers` string[]

Online docent

`remark` string

Opmerking van de roostermaker en onderwerp van de afspraak

`teachingTime` integer

Onderwijstijd
bereik: [0,-]

`teachingTimeManually` boolean

Onderwijstijd handmatig?

`udmUUID` uuid

UDM UUID

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
appointmentModifiedSince	waarvan met een wijziging (exclusief leerlingdeelname) sinds het opgegeven moment	timestamp
containsStudentsFromDepartmentOfBranch	afspraken waar een leerling van een van de opgegeven afdelingen aan deel zou kunnen nemen	long
containsStudentsFromGroupInDepartment	afspraken waar een leerling van een van de opgegeven roostergroepen aan deel zou kunnen nemen	long
containsTeachersFromTeacherTeam	afspraken met een docent van een van de opgegeven teams	long
departmentOfBranch	afspraken met een vak of groep van de opgegeven afdelingen	long
endWeekOffset	afspraken tot een week relatief geteld vanaf de huidige week (gebruik samen met startWeekOffset)	integer
extraStudentSourceForDepartment	afspraken waar extra leerlingen van de opgegeven afdelingen zich voor kunnen inschrijven	long
hasCreator	persoonlijke afspraken aangemaakt door docenten	boolean
possibleStudents	afspraken waar een van de opgegeven leerlingen aan deel zou kunnen nemen	string
startWeekOffset	afspraken vanaf een week relatief geteld vanaf de huidige week (gebruik samen met endWeekOffset)	integer
user	afspraken waar een van de opgegeven gebruikers aan verbonden is	string

Details

`appointmentModifiedSince` timestamp

waarvan met een wijziging (exclusief leerlingdeelname) sinds het opgegeven moment

`containsStudentsFromDepartmentOfBranch` long

afspraken waar een leerling van een van de opgegeven afdelingen aan deel zou kunnen nemen
verwijst naar: departmentsofbranches.id (Afdelingen)

`containsStudentsFromGroupInDepartment` long

afspraken waar een leerling van een van de opgegeven roostergroepen aan deel zou kunnen nemen
verwijst naar: groupindepartments.id (Roostergroepen)

`containsTeachersFromTeacherTeam` long

afspraken met een docent van een van de opgegeven teams

`departmentOfBranch` long

afspraken met een vak of groep van de opgegeven afdelingen
verwijst naar: departmentsofbranches.id (Afdelingen)

`endWeekOffset` integer

afspraken tot een week relatief geteld vanaf de huidige week (gebruik samen met startWeekOffset)

`extraStudentSourceForDepartment` long

afspraken waar extra leerlingen van de opgegeven afdelingen zich voor kunnen inschrijven
verwijst naar: departmentsofbranches.id (Afdelingen)

`hasCreator` boolean

persoonlijke afspraken aangemaakt door docenten

`possibleStudents` string

afspraken waar een van de opgegeven leerlingen aan deel zou kunnen nemen
verwijst naar: users.code (Gebruikers)

`startWeekOffset` integer

afspraken vanaf een week relatief geteld vanaf de huidige week (gebruik samen met endWeekOffset)

`user` string

afspraken waar een van de opgegeven gebruikers aan verbonden is
verwijst naar: users.code (Gebruikers)

/branchesofschools (Vestigingen in project)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branch	Vestiging	string	✅	✅
id	ID	long	✅	✅
schoolInSchoolYear	Project	long	✅	✅

Details

`branch` string verplicht bij aanmaken

Vestiging
verwijst naar: branches.code (Vestigingen)

`id` long

`schoolInSchoolYear` long verplicht bij aanmaken immutable

Project
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
name	Naam	string	✅	❌

Details

`name` string

Naam

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
archived	vestigingsactivaties waarvan het project de opgegeven archiefstatus heeft	boolean
schoolYear	vestigingen actief in het opgegeven schooljaar	integer

Details

`archived` boolean

vestigingsactivaties waarvan het project de opgegeven archiefstatus heeft

`schoolYear` integer

vestigingen actief in het opgegeven schooljaar

/branches (Vestigingen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
code	Vestigingscode	string	✅	✅
name	Naam	string	✅	✅
somCode	Exportcode LAS	string	✅	✅
somUuid	Somtoday Connect vestiging	uuid	✅	✅

Details

`code` string verplicht bij aanmaken immutable

Vestigingscode

`name` string

Naam

`somCode` string

Exportcode LAS

`somUuid` uuid

Somtoday Connect vestiging

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	vestigingen binnen de opgegeven roosterprojecten	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

vestigingen binnen de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren

Details

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/choosableindepartments (Vak-op-afdeling)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
departmentOfBranch	Afdeling	long	✅	✅
id	ID	long	✅	✅
subject	Keuze	long	✅	✅

Details

`departmentOfBranch` long verplicht bij aanmaken immutable

Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`id` long

`subject` long verplicht bij aanmaken immutable

Keuze
verwijst naar: subjectselectionsubjects.id (Keuzes)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	de velden die u wilt opvragen bij dit verzoek	string
schoolInSchoolYear	beperk tot vak-op-afdelingen binnen een roosterproject	long

Details

`fields` string

de velden die u wilt opvragen bij dit verzoek

`schoolInSchoolYear` long

beperk tot vak-op-afdelingen binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
clockHoursPerLesson	Klokuur per les	float	✅	✅
clockHoursPerLessonManually	Klokuur per les handmatig?	boolean	✅	✅
courseType	Vaktype	string	✅	✅
departmentOfBranchCode	Afdelingscode	string	✅	❌
departmentPercentageSupplementCount	Aanvulling door afdelingspercentage	float	✅	❌
excludedSegments	Pakketdelen zelfstudie	long[]	✅	❌
excludedSegmentsManually	Pakketdelen zelfstudie handmatig?	boolean	✅	✅
exemptionStudentCount	Prognostisch aantal leerlingen met betrokkenheid vrijstelling	float	✅	❌
exemptionStudentCountByDepartment	Prognostisch aantal leerlingen met betrokkenheid vrijstelling	json	✅	❌
expectedGroupCount	Verwacht aantal groepen	integer	✅	❌
expectedStudentCount	Verwacht aantal leerlingen	float	✅	✅
expectedStudentCountAlgorithm	Rekenmethode voor verwacht aantal leerlingen	string	✅	✅
expectedStudentCountChoosable	Opleiding voor verwacht aantal leerlingen	long	✅	✅
expectedStudentCountDepartmentPercentage	Verwacht afdelingspercentage	integer	✅	✅
expectedTeacherCount	Verwacht aantal docenten	integer	✅	✅
expectedTeacherCountManually	Verwacht aantal docenten handmatig?	boolean	✅	✅
iltCode	Elementcode	integer	✅	❌
isExam	Examenvak	boolean	✅	✅
lessonDemand	Lesvraag	float	✅	❌
lessonHoursInClassPeriods	Lesuren	json[]	✅	✅
maxGroupSize	Maximale groepsgrootte	integer	✅	✅
maxGroupSizeManually	Maximale groepsgrootte handmatig?	boolean	✅	✅
plannedGroups	Geplande groepen	long[]	✅	✅
qualifiedCode	Roostercode inclusief afdeling	string	✅	❌
regularStudentCount	Prognostisch aantal leerlingen met betrokkenheid regulier	float	✅	❌
regularStudentCountByDepartment	Prognostisch aantal leerlingen met betrokkenheid regulier	json	✅	❌
scheduleCode	Roostercode	string	✅	❌
scroungeSegments	Pakketdelen sprokkelen	long[]	✅	❌
scroungeSegmentsManually	Pakketdelen sprokkelen handmatig?	boolean	✅	✅
scroungeStudentCount	Prognostisch aantal leerlingen met betrokkenheid sprokkelen	float	✅	❌
scroungeStudentCountByDepartment	Prognostisch aantal leerlingen met betrokkenheid sprokkelen	json	✅	❌
sectionOfBranch	Sectie	long	✅	✅
sectionOfBranchAbbreviation	Sectieafkorting	string	✅	❌
selfstudyStudentCount	Prognostisch aantal leerlingen met betrokkenheid zelfstudie	float	✅	❌
selfstudyStudentCountByDepartment	Prognostisch aantal leerlingen met betrokkenheid zelfstudie	json	✅	❌
studentCanEdit	Bewerkbaar door lln?	boolean	✅	✅
studentCountCorrection	Leerling-correctie	float	✅	✅
studentCountCorrectionManually	Leerling-correctie handmatig?	boolean	✅	✅
studentThreshold	Drempelwaarde: minimum verwacht aantal leerlingen voor één groep	integer	✅	✅
subjectCode	Keuzecode	string	✅	❌
subjectName	Keuzenaam	string	✅	❌
subjectScheduleCode	Roostercode vak	string	✅	❌
subjectType	Keuzetype	string	✅	✅
teachingLevel	Bevoegdheidsgraad	string	✅	✅
teachingLevelManually	Bevoegdheidsgraad handmatig?	boolean	✅	✅

Details

`clockHoursPerLesson` float

Klokuur per les
bereik: [0.0,-]

`clockHoursPerLessonManually` boolean

Klokuur per les handmatig?

`courseType` string

Vaktype
mogelijke waardes: optional, department, mandatory

`departmentOfBranchCode` string

Afdelingscode

`departmentPercentageSupplementCount` float

Aanvulling door afdelingspercentage

`excludedSegments` long[]

Pakketdelen zelfstudie

`excludedSegmentsManually` boolean

Pakketdelen zelfstudie handmatig?

`exemptionStudentCount` float

Prognostisch aantal leerlingen met betrokkenheid vrijstelling
bereik: [0.0,-]

`exemptionStudentCountByDepartment` json

Prognostisch aantal leerlingen met betrokkenheid vrijstelling

extra details:
Het prognostisch aantal leerlingen met betrokkenheid vrijstelling, uitgesplitst naar afdeling van herkomst

`expectedGroupCount` integer

Verwacht aantal groepen
bereik: [0,-]

`expectedStudentCount` float

Verwacht aantal leerlingen
bereik: [0.0,-]

`expectedStudentCountAlgorithm` string

Rekenmethode voor verwacht aantal leerlingen
mogelijke waardes: manually, supplementedCount, count, choosable, departmentPercentage

`expectedStudentCountChoosable` long

Opleiding voor verwacht aantal leerlingen
verwijst naar: choosableindepartments.id (Vak-op-afdeling)

`expectedStudentCountDepartmentPercentage` integer

Verwacht afdelingspercentage
bereik: [0,100]

`expectedTeacherCount` integer

Verwacht aantal docenten
bereik: [0,-]

`expectedTeacherCountManually` boolean

Verwacht aantal docenten handmatig?

`iltCode` integer

Elementcode

extra details:
Elementcode Integrale Leerlingtelling (ILT-code)

`isExam` boolean

Examenvak

`lessonDemand` float

Lesvraag
bereik: [0.0,-]

`lessonHoursInClassPeriods` json[]

Lesuren

`maxGroupSize` integer

Maximale groepsgrootte
bereik: [0,-]

`maxGroupSizeManually` boolean

Maximale groepsgrootte handmatig?

`plannedGroups` long[]

Geplande groepen

`qualifiedCode` string

Roostercode inclusief afdeling

`regularStudentCount` float

Prognostisch aantal leerlingen met betrokkenheid regulier
bereik: [0.0,-]

`regularStudentCountByDepartment` json

Prognostisch aantal leerlingen met betrokkenheid regulier

extra details:
Het prognostisch aantal leerlingen met betrokkenheid regulier, uitgesplitst naar afdeling van herkomst

`scheduleCode` string

Roostercode

`scroungeSegments` long[]

Pakketdelen sprokkelen

`scroungeSegmentsManually` boolean

Pakketdelen sprokkelen handmatig?

`scroungeStudentCount` float

Prognostisch aantal leerlingen met betrokkenheid sprokkelen
bereik: [0.0,-]

`scroungeStudentCountByDepartment` json

Prognostisch aantal leerlingen met betrokkenheid sprokkelen

extra details:
Het prognostisch aantal leerlingen met betrokkenheid sprokkelen, uitgesplitst naar afdeling van herkomst

`sectionOfBranch` long

Sectie
verwijst naar: sectionofbranches.id (Sectie-activaties)

`sectionOfBranchAbbreviation` string

Sectieafkorting

`selfstudyStudentCount` float

Prognostisch aantal leerlingen met betrokkenheid zelfstudie
bereik: [0.0,-]

`selfstudyStudentCountByDepartment` json

Prognostisch aantal leerlingen met betrokkenheid zelfstudie

extra details:
Het prognostisch aantal leerlingen met betrokkenheid zelfstudie, uitgesplitst naar afdeling van herkomst

`studentCanEdit` boolean

Bewerkbaar door lln?

`studentCountCorrection` float

Leerling-correctie

`studentCountCorrectionManually` boolean

Leerling-correctie handmatig?

`studentThreshold` integer

Drempelwaarde: minimum verwacht aantal leerlingen voor één groep
bereik: [0,-]

`subjectCode` string

Keuzecode

`subjectName` string

Keuzenaam

`subjectScheduleCode` string

Roostercode vak

extra details:
Niet gebruiken; zie veld scheduleCode

`subjectType` string

Keuzetype
mogelijke waardes: education, subject, profile

`teachingLevel` string

Bevoegdheidsgraad
mogelijke waardes: 1egraads, 2egraads

`teachingLevelManually` boolean

Bevoegdheidsgraad handmatig?

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot vak-op-afdelingen binnen een vestiging	long
referenceWeek	specificeer de week voor de tellingen per vak-op-afdeling	week
schoolYear	beperk tot vak-op-afdelingen binnen een schooljaar	integer

Details

`branchOfSchool` long

beperk tot vak-op-afdelingen binnen een vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`referenceWeek` week

specificeer de week voor de tellingen per vak-op-afdeling

`schoolYear` integer

beperk tot vak-op-afdelingen binnen een schooljaar

/contracts (Contracten)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
employee	Werknemerscode	string	✅	✅
end	Eind	datum	✅	✅
id	ID	long	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅
start	Start	datum	✅	✅

Details

`employee` string verplicht bij aanmaken immutable

Werknemerscode
verwijst naar: employees.userCode (Werknemers)

`end` datum

Eind

`id` long

`schoolInSchoolYear` long verplicht bij aanmaken immutable

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`start` datum

Start

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	de velden die u wilt opvragen bij dit verzoek	string

Details

`fields` string

de velden die u wilt opvragen bij dit verzoek

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
availabilityManually	Beschikbaarheidsomvang handmatig?	boolean	✅	❌
availableDayParts	Dagdelen	integer	✅	❌
availableDays	Dagen	integer	✅	❌
clockHoursBalance	Saldo planning	integer	✅	❌
clockHoursBalancePreviousYear	Saldo vorig jaar	integer	✅	✅
clockHoursGeneralTasks	Algemene schooltaken	integer	✅	❌
clockHoursGeneralTasksManually	AST handmatig?	boolean	✅	✅
clockHoursGross	Totale omvang (klu)	integer	✅	❌
clockHoursLessonRelief	Lesverlichting (op basis van persoonlijk budget)	integer	✅	❌
clockHoursLessonReliefManually	Lesverlichting handmatig	boolean	✅	✅
clockHoursLessons	Reguliere inzet lessen	integer	✅	❌
clockHoursLessonsManually	Inzet lessen handmatig?	boolean	✅	✅
clockHoursLessonsMax	Maximaal aantal lessen in klokuren	integer	✅	❌
clockHoursNet	Inzetbare uren	integer	✅	❌
clockHoursNetManually	Inzetbare uren handmatig?	boolean	✅	✅
clockHoursProfessionalDevelopment	Deskundigheidsbevordering	integer	✅	❌
clockHoursProfessionalDevelopmentManually	DESK handmatig?	boolean	✅	✅
clockHoursTaskRelief	Taakverlichting (op basis van persoonlijk budget)	integer	✅	❌
clockHoursTaskReliefManually	Taakverlichting handmatig	boolean	✅	✅
clockHoursTasks	Reguliere inzet taken	integer	✅	❌
clockHoursToAuxiliaryProjects	Inzet nevenprojecten (klu)	integer	✅	❌
commencementSchool	Op school vanaf	datum	✅	❌
commencementTeaching	Docent vanaf	datum	✅	❌
compensationAbsenceHours	Klokuren opgenomen compensatieverlof	integer	✅	❌
dateOfBirth	Geboortedatum	datum	✅	❌
defaultFunctionCategory	Standaard functiecategorie	string	✅	✅
developmentTime	Ontwikkeltijd	integer	✅	❌
developmentTimeBudget	Ontwikkeltijd recht	integer	✅	❌
developmentTimeManually	Ontwikkeltijd handmatig?	boolean	✅	✅
durationManually	Duur handmatig?	boolean	✅	✅
email	Email	string	✅	❌
employeeNumber	Personeelsnummer	string	✅	❌
employerCostBasisMaintenance	Indicatie kosten aanstellingen onderhoud	integer	✅	❌
employerCostBasisPlanning	Indicatie kosten aanstellingen planning	integer	✅	❌
employerCostLeaveReductionMaintenance	Indicatie kostenreductie verlof onderhoud	integer	✅	❌
employerCostLeaveReductionPlanning	Indicatie kostenreductie verlof planning	integer	✅	❌
employerCostPostingBalanceMaintenance	Indicatie verrekening nevenprojecten onderhoud	integer	✅	❌
employerCostPostingBalancePlanning	Indicatie verrekening nevenprojecten planning	integer	✅	❌
employerCostTotalMaintenance	Indicatie kosten totaal onderhoud	integer	✅	❌
employerCostTotalPlanning	Indicatie kosten totaal planning	integer	✅	❌
employerCostsPercentage	Werkgeverslasten(%)	float	✅	✅
extensionsDevelopmentTime	Ontwikkeltijd-toeslag uitbreidingen	integer	✅	✅
extensionsGeneralTasks	AST-toeslag uitbreidingen	integer	✅	❌
extensionsGeneralTasksManually	AST-toeslag uitbreidingen handmatig?	boolean	✅	✅
extensionsProfessionalDevelopment	DESK-toeslag uitbreidingen	integer	✅	❌
extensionsProfessionalDevelopmentManually	DESK-toeslag uitbreidingen handmatig?	boolean	✅	✅
extraWork	Inzet meerwerk	integer	✅	❌
extraWorkAllowance	Toeslag voor meerwerk	integer	✅	❌
extraWorkAllowanceBasis	Bruto toeslag voor meerwerk	integer	✅	❌
firstName	Voornaam	string	✅	❌
fteNet	Totale omvang (fte)	float	✅	❌
ftePermanent	Aanstelling planning vast	float	✅	❌
fteTemporary	Aanstelling planning tijdelijk	float	✅	❌
fteToAuxiliaryProjects	Inzet nevenprojecten (fte)	float	✅	❌
fteYearLeave	Verlof Planning	float	✅	❌
fullMonthlySalary	Voltijds bruto maandsalaris	integer	✅	❌
gender	Geslacht	string	✅	❌
hasLessonReliefStarter	Startersregeling?	boolean	✅	❌
hourlySalary	Bruto uurloon	float	✅	❌
hourlySalaryManually	Bruto uurloon handmatig?	boolean	✅	✅
isMainContract	Hoofdcontract	boolean	✅	✅
lastName	Achternaam	string	✅	❌
leavesDevelopmentTime	Ontwikkeltijd-aftrek onderhoudsverloven	integer	✅	✅
leavesGeneralTasks	AST-aftrek onderhoudsverloven	integer	✅	❌
leavesGeneralTasksManually	AST-aftrek onderhoudsverloven handmatig?	boolean	✅	✅
leavesProfessionalDevelopment	DESK-aftrek onderhoudsverloven	integer	✅	❌
leavesProfessionalDevelopmentManually	DESK-aftrek onderhoudsverloven handmatig?	boolean	✅	✅
lessonHoursSectionAssignments	Aantal geplande lesuren in secties	float	✅	❌
lessonHoursSurplusAllowance	Toeslag lesoverschot	integer	✅	❌
lessonHoursSurplusAllowanceManually	Toeslag lesoverschot handmatig?	boolean	✅	✅
lessonHoursSurplusAllowanceViaSectionAssignments	Toeslag lesoverschot obv sectieverdeling	integer	✅	❌
lessonHoursTeachingAssignments	Aantal toegekende lesuren	float	✅	❌
lessonReducingTasks	Lesreducerende taken	integer	✅	❌
lessonReplacement	Inzet lessen als vervanger	integer	✅	❌
lessonSpace	Lesruimte	integer	✅	❌
lessonsMax	Maximaal aantal lessen	float	✅	❌
lessonsMaxManually	Maximaal aantal lessen handmatig?	boolean	✅	✅
lessonsToPlan	Het te plannen aantal lessen	float	✅	❌
mainBranchOfSchool	Hoofdvestiging	long	✅	✅
mainContract	Hoofdcontract ID	long	✅	❌
maintenanceJobClockHoursBudget	Budget (klu) uitbreidingen	integer	✅	❌
maintenanceJobFteBudget	Budget (fte) uitbreidingen	float	✅	❌
maintenanceLeaveClockHoursBudget	Totaal (klu) onderhoudsverloven	integer	✅	❌
maintenanceLeaveFteBudget	Totaal (fte) onderhoudsverloven	float	✅	❌
personalBudgetStatus	Persoonlijk budget status	string	✅	❌
postedBranches	Afdelingen op nevenvestigingen	long[]	✅	❌
postings	Nevenvestigingen	long[]	✅	✅
prefix	Tussenvoegsel	string	✅	❌
previousSalaryScale	Salarisschaal voorgaand schooljaar	long	✅	❌
previousSalaryStep	Salaristrede voorgaand schooljaar	integer	✅	❌
privateComment	Opmerking voor beheerder	string	✅	✅
publicComment	Opmerking voor docent	string	✅	✅
replacementBalance	Saldo vervanging	integer	✅	❌
reservationReplacement	Boeking van planning naar onderhoud	integer	✅	✅
salaryScale	Salarisschaal	long	✅	✅
salaryStep	Salaristrede	integer	✅	✅
school	School	long	✅	❌
schoolInSchoolYearName	Roosterprojectnaam	string	✅	❌
schoolName	Schoolnaam	string	✅	❌
schoolYear	Schooljaar	integer	✅	✅
substitutionQuota	Meerwerkquotum	integer	✅	❌
substitutionQuotaManually	Meerwerkquotum handmatig?	boolean	✅	✅
taskBalance	Taaksaldo	integer	✅	❌
taskLessonSpace	Beschikbaar voor lessen en taken	integer	✅	❌
taskReplacement	Inzet taken als vervanger	integer	✅	❌
taskSpace	Taakruimte	integer	✅	❌
taskSurplus	Taakoverschot	integer	✅	❌
teacherTeam	Hoofdteam	long	✅	✅

Details

`availabilityManually` boolean

Beschikbaarheidsomvang handmatig?

extra details:
Niet gebruiken, gebruik het veld op /schedulepreferences

`availableDayParts` integer

Dagdelen

extra details:
Niet gebruiken, gebruik het veld op /schedulepreferences

`availableDays` integer

Dagen

extra details:
Niet gebruiken, gebruik het veld op /schedulepreferences

`clockHoursBalance` integer

Saldo planning

`clockHoursBalancePreviousYear` integer

Saldo vorig jaar

`clockHoursGeneralTasks` integer

Algemene schooltaken

`clockHoursGeneralTasksManually` boolean

AST handmatig?

`clockHoursGross` integer

Totale omvang (klu)

`clockHoursLessonRelief` integer

Lesverlichting (op basis van persoonlijk budget)

`clockHoursLessonReliefManually` boolean

Lesverlichting handmatig

`clockHoursLessons` integer

Reguliere inzet lessen

`clockHoursLessonsManually` boolean

Inzet lessen handmatig?

`clockHoursLessonsMax` integer

Maximaal aantal lessen in klokuren

`clockHoursNet` integer

Inzetbare uren

`clockHoursNetManually` boolean

Inzetbare uren handmatig?

`clockHoursProfessionalDevelopment` integer

Deskundigheidsbevordering

`clockHoursProfessionalDevelopmentManually` boolean

DESK handmatig?

`clockHoursTaskRelief` integer

Taakverlichting (op basis van persoonlijk budget)

`clockHoursTaskReliefManually` boolean

Taakverlichting handmatig

`clockHoursTasks` integer

Reguliere inzet taken

`clockHoursToAuxiliaryProjects` integer

Inzet nevenprojecten (klu)

`commencementSchool` datum

Op school vanaf

`commencementTeaching` datum

Docent vanaf

`compensationAbsenceHours` integer

Klokuren opgenomen compensatieverlof

`dateOfBirth` datum

Geboortedatum

`defaultFunctionCategory` string

Standaard functiecategorie
mogelijke waardes: OP, OOP, DIR

`developmentTime` integer

Ontwikkeltijd

`developmentTimeBudget` integer

Ontwikkeltijd recht

`developmentTimeManually` boolean

Ontwikkeltijd handmatig?

`durationManually` boolean

Duur handmatig?

`email` string

`employeeNumber` string

Personeelsnummer

`employerCostBasisMaintenance` integer

Indicatie kosten aanstellingen onderhoud

`employerCostBasisPlanning` integer

Indicatie kosten aanstellingen planning

`employerCostLeaveReductionMaintenance` integer

Indicatie kostenreductie verlof onderhoud

`employerCostLeaveReductionPlanning` integer

Indicatie kostenreductie verlof planning

`employerCostPostingBalanceMaintenance` integer

Indicatie verrekening nevenprojecten onderhoud

`employerCostPostingBalancePlanning` integer

Indicatie verrekening nevenprojecten planning

`employerCostTotalMaintenance` integer

Indicatie kosten totaal onderhoud

`employerCostTotalPlanning` integer

Indicatie kosten totaal planning

`employerCostsPercentage` float

Werkgeverslasten(%)

`extensionsDevelopmentTime` integer

Ontwikkeltijd-toeslag uitbreidingen
bereik: [0,-]

`extensionsGeneralTasks` integer

AST-toeslag uitbreidingen
bereik: [0,-]

`extensionsGeneralTasksManually` boolean

AST-toeslag uitbreidingen handmatig?

`extensionsProfessionalDevelopment` integer

DESK-toeslag uitbreidingen
bereik: [0,-]

`extensionsProfessionalDevelopmentManually` boolean

DESK-toeslag uitbreidingen handmatig?

`extraWork` integer

Inzet meerwerk

`extraWorkAllowance` integer

Toeslag voor meerwerk

`extraWorkAllowanceBasis` integer

Bruto toeslag voor meerwerk

`firstName` string

Voornaam

`fteNet` float

Totale omvang (fte)

`ftePermanent` float

Aanstelling planning vast

`fteTemporary` float

Aanstelling planning tijdelijk

`fteToAuxiliaryProjects` float

Inzet nevenprojecten (fte)

`fteYearLeave` float

Verlof Planning

`fullMonthlySalary` integer

Voltijds bruto maandsalaris

`gender` string

Geslacht
mogelijke waardes: f, m

`hasLessonReliefStarter` boolean

Startersregeling?

`hourlySalary` float

Bruto uurloon

`hourlySalaryManually` boolean

Bruto uurloon handmatig?

`isMainContract` boolean

Hoofdcontract

`lastName` string

Achternaam

`leavesDevelopmentTime` integer

Ontwikkeltijd-aftrek onderhoudsverloven
bereik: [0,-]

`leavesGeneralTasks` integer

AST-aftrek onderhoudsverloven
bereik: [0,-]

`leavesGeneralTasksManually` boolean

AST-aftrek onderhoudsverloven handmatig?

`leavesProfessionalDevelopment` integer

DESK-aftrek onderhoudsverloven
bereik: [0,-]

`leavesProfessionalDevelopmentManually` boolean

DESK-aftrek onderhoudsverloven handmatig?

`lessonHoursSectionAssignments` float

Aantal geplande lesuren in secties

`lessonHoursSurplusAllowance` integer

Toeslag lesoverschot

`lessonHoursSurplusAllowanceManually` boolean

Toeslag lesoverschot handmatig?

`lessonHoursSurplusAllowanceViaSectionAssignments` integer

Toeslag lesoverschot obv sectieverdeling

`lessonHoursTeachingAssignments` float

Aantal toegekende lesuren

`lessonReducingTasks` integer

Lesreducerende taken

`lessonReplacement` integer

Inzet lessen als vervanger

`lessonSpace` integer

Lesruimte

`lessonsMax` float

Maximaal aantal lessen

`lessonsMaxManually` boolean

Maximaal aantal lessen handmatig?

`lessonsToPlan` float

Het te plannen aantal lessen

`mainBranchOfSchool` long

Hoofdvestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`mainContract` long

Hoofdcontract ID

`maintenanceJobClockHoursBudget` integer

Budget (klu) uitbreidingen

`maintenanceJobFteBudget` float

Budget (fte) uitbreidingen

`maintenanceLeaveClockHoursBudget` integer

Totaal (klu) onderhoudsverloven

`maintenanceLeaveFteBudget` float

Totaal (fte) onderhoudsverloven

`personalBudgetStatus` string

Persoonlijk budget status

`postedBranches` long[]

Afdelingen op nevenvestigingen
verwijst naar: branchesofschools.id (Vestigingen in project)

`postings` long[]

Nevenvestigingen

`prefix` string

Tussenvoegsel

`previousSalaryScale` long

Salarisschaal voorgaand schooljaar

`previousSalaryStep` integer

Salaristrede voorgaand schooljaar

`privateComment` string

Opmerking voor beheerder

`publicComment` string

Opmerking voor docent

`replacementBalance` integer

Saldo vervanging

`reservationReplacement` integer

Boeking van planning naar onderhoud

`salaryScale` long

Salarisschaal

`salaryStep` integer

Salaristrede

`school` long

School

`schoolInSchoolYearName` string

Roosterprojectnaam

`schoolName` string

Schoolnaam

`schoolYear` integer

Schooljaar

`substitutionQuota` integer

Meerwerkquotum
bereik: [0,-]

`substitutionQuotaManually` boolean

Meerwerkquotum handmatig?

`taskBalance` integer

Taaksaldo

`taskLessonSpace` integer

Beschikbaar voor lessen en taken

`taskReplacement` integer

Inzet taken als vervanger

`taskSpace` integer

Taakruimte

`taskSurplus` integer

Taakoverschot

`teacherTeam` long

Hoofdteam

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot contracten met uren binnen de opgegeven vestiging	long
relatedToEmployee	beperk tot contracten hangend aan een van de projecten waar de opgegeven medewerker ook een contract voor heeft	string
schoolFunction	beperk tot contracten met deze schoolfunctie	string
section	beperk tot contracten met uren binnen de opgegeven sectie	long
sectionOfBranch	beperk tot contracten met uren binnen de opgegeven sectie op een vestiging	long
year	beperk tot contracten hangend aan projecten startend in dit kalenderjaar	integer

Details

`branchOfSchool` long

beperk tot contracten met uren binnen de opgegeven vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`relatedToEmployee` string

beperk tot contracten hangend aan een van de projecten waar de opgegeven medewerker ook een contract voor heeft
verwijst naar: employees.userCode (Werknemers)

`schoolFunction` string

beperk tot contracten met deze schoolfunctie
mogelijke waardes: BOARD, CUSTOM_DEPARTMENT, STUDENT_ADMINISTRATION, CUSTOM_GROUP, CUSTOM_TEAM, PERSONNEL_ADMINISTRATION, SCHOOL_LEADER, CUSTOM_SECTION, CUSTOM_PROJECT, DEAN, PARENT_TEACHER_NIGHT_SCHEDULER, PARTICIPATION_COORDINATOR, MENTOR, TEAM_LEADER, SCHEDULER, SECTION_LEADER

`section` long

beperk tot contracten met uren binnen de opgegeven sectie
verwijst naar: sections.id (Secties)

`sectionOfBranch` long

beperk tot contracten met uren binnen de opgegeven sectie op een vestiging
verwijst naar: sectionofbranches.id (Sectie-activaties)

`year` integer

beperk tot contracten hangend aan projecten startend in dit kalenderjaar

/courses (Lesgroepen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branchCode	Vestiging	string	✅	✅
choosableInDepartment	Vak op afdeling	long	✅	❌
departmentCode	Afdeling	string	✅	✅
educationTypes	Opleidingstypes	string[]	✅	❌
groupName	Groepsnaam	string	✅	❌
id	ID	long	✅	✅
iltCode	ILT code vak	integer	✅	❌
schoolYear	Schooljaar	integer	✅	✅
students	Leerlingen	json[]	✅	❌
subjectCode	Vakcode	string	✅	❌
subjectName	Vaknaam	string	✅	❌
teachers	Docenten	json[]	✅	❌
yearOfEducation	Leerjaar	integer	✅	❌

Details

`branchCode` string

Vestiging

`choosableInDepartment` long

Vak op afdeling
verwijst naar: choosableindepartments.id (Vak-op-afdeling)

`departmentCode` string

Afdeling

`educationTypes` string[]

Opleidingstypes

`groupName` string

Groepsnaam

`id` long

`iltCode` integer

ILT code vak

`schoolYear` integer

Schooljaar

`students` json[]

Leerlingen

`subjectCode` string

Vakcode

`subjectName` string

Vaknaam

`teachers` json[]

Docenten

`yearOfEducation` integer

Leerjaar

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot lesgroepen binnen een roosterproject	long
student	beperk tot lesgroepen van een leerling	string
teacher	beperk tot lesgroepen van een docent	string

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot lesgroepen binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`student` string

beperk tot lesgroepen van een leerling

`teacher` string

beperk tot lesgroepen van een docent

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren

Details

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/departmentsofbranches (Afdelingen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branchOfSchool	Vestiging	long	✅	✅
code	Code / naam	string	✅	✅
id	ID	long	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅

Details

`branchOfSchool` long verplicht bij aanmaken immutable

Vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`code` string verplicht bij aanmaken

Code / naam

`id` long

`schoolInSchoolYear` long

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branchOfSchoolCode	Vestiging	string	✅	❌
clockHoursPerLesson	Klokuur per les	float	✅	✅
clockHoursPerLessonManually	Klokuur per les handmatig?	boolean	✅	✅
defaultEnrollmentValidationType	Inschrijfcontrole	string	✅	❌
defaultMaximalLessonEnrollmentPerWeek	Maximaal aantal inschrijvingen voor lessen per week	integer	✅	✅
defaultMaximalLessonsPerWeek	Maximaal aantal te volgen lessen per week	integer	✅	✅
defaultMinimalLessonEnrollmentPerWeek	Minimaal aantal inschrijvingen voor lessen per week	integer	✅	✅
defaultMinimalLessonsPerWeek	Minimaal aantal te volgen lessen per week	integer	✅	✅
educationType	LAS-onderwijssoort	string	✅	✅
educations	Opleidingen	long[]	✅	❌
excludedSegments	Pakketdelen zelfstudie	long[]	✅	✅
expectedInflow	Verwachte instroom	float	✅	✅
expectedInflowManually	Verwachte instroom handmatig?	boolean	✅	✅
expectedMainGroupCount	Verwacht aantal stamklassen	integer	✅	✅
expectedMainGroupCountManually	Verwacht aantal stamklassen handmatig?	boolean	✅	✅
expectedStudentCount	Verwacht aantal leerlingen	float	✅	✅
expectedStudentCountManually	Verwacht aantal leerlingen handmatig?	boolean	✅	✅
mainGroupAuthority	Stamklasindeling	string	✅	❌
maxGroupSize	Maximale groepsgrootte	integer	✅	✅
maxGroupSizeManually	Maximale groepsgrootte handmatig?	boolean	✅	✅
maximalExtraEnrollmentPerSubject	Maximaal aantal inschrijvingen voor lessen per vak per week	integer	✅	✅
minimalExtraEnrollmentPerSubject	Minimaal aantal inschrijvingen voor lessen per vak per week	integer	✅	✅
participationThreshold	Drempel zichtbaarheid voor leerling	percentage	✅	✅
profiles	Profielen	long[]	✅	❌
prognosticInflow	Instroom (prog)	float	✅	❌
prognosticStudentCount	Aantal leerlingen (prog)	float	✅	❌
schoolInSchoolYearId	Roosterproject (niet gebruiken!)	long	✅	❌
schoolInSchoolYearName	Roosterproject	string	✅	❌
scroungeSegments	Pakketdelen sprokkelen	long[]	✅	✅
studentCount	Aantal leerlingen (abs)	integer	✅	❌
studentCountCorrection	Leerling-correctie	float	✅	✅
studentCountCorrectionManually	Leerling-correctie handmatig?	boolean	✅	✅
studentsMayViewSubjectSelections	Keuzepakketten zichtbaar?	boolean	✅	✅
subjectSelectionDeadline	Uiterste inleverdatum pakketten	datum	✅	✅
teacherTeams	Teams	long[]	✅	✅
teachingLevel	Bevoegdheidsgraad	string	✅	❌
weekTimeTable	Weekindeling	long	✅	✅
yearOfEducation	Jaarlaag	integer	✅	✅

Details

`branchOfSchoolCode` string

Vestiging

`clockHoursPerLesson` float

Klokuur per les
bereik: [0.0,-]

`clockHoursPerLessonManually` boolean

Klokuur per les handmatig?

`defaultEnrollmentValidationType` string

Inschrijfcontrole
mogelijke waardes: ENROLLMENTS, LESSONS

`defaultMaximalLessonEnrollmentPerWeek` integer

Maximaal aantal inschrijvingen voor lessen per week
bereik: [0,-]

`defaultMaximalLessonsPerWeek` integer

Maximaal aantal te volgen lessen per week
bereik: [0,-]

`defaultMinimalLessonEnrollmentPerWeek` integer

Minimaal aantal inschrijvingen voor lessen per week
bereik: [0,-]

`defaultMinimalLessonsPerWeek` integer

Minimaal aantal te volgen lessen per week
bereik: [0,-]

`educationType` string

LAS-onderwijssoort

`educations` long[]

Opleidingen

`excludedSegments` long[]

Pakketdelen zelfstudie

`expectedInflow` float

Verwachte instroom
bereik: [0.0,-]

`expectedInflowManually` boolean

Verwachte instroom handmatig?

`expectedMainGroupCount` integer

Verwacht aantal stamklassen
bereik: [0,-]

`expectedMainGroupCountManually` boolean

Verwacht aantal stamklassen handmatig?

`expectedStudentCount` float

Verwacht aantal leerlingen
bereik: [0.0,-]

`expectedStudentCountManually` boolean

Verwacht aantal leerlingen handmatig?

`mainGroupAuthority` string

Stamklasindeling
mogelijke waardes: scheduler, teamleader

`maxGroupSize` integer

Maximale groepsgrootte
bereik: [0,-]

`maxGroupSizeManually` boolean

Maximale groepsgrootte handmatig?

`maximalExtraEnrollmentPerSubject` integer

Maximaal aantal inschrijvingen voor lessen per vak per week
bereik: [0,-]

`minimalExtraEnrollmentPerSubject` integer

Minimaal aantal inschrijvingen voor lessen per vak per week
bereik: [0,-]

`participationThreshold` percentage

Drempel zichtbaarheid voor leerling
bereik: [0.0,1.0]

`profiles` long[]

Profielen

`prognosticInflow` float

Instroom (prog)
bereik: [0.0,-]

`prognosticStudentCount` float

Aantal leerlingen (prog)
bereik: [0.0,-]

`schoolInSchoolYearId` long

Roosterproject (niet gebruiken!)
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`schoolInSchoolYearName` string

Roosterproject

`scroungeSegments` long[]

Pakketdelen sprokkelen

`studentCount` integer

Aantal leerlingen (abs)

`studentCountCorrection` float

Leerling-correctie

`studentCountCorrectionManually` boolean

Leerling-correctie handmatig?

`studentsMayViewSubjectSelections` boolean

Keuzepakketten zichtbaar?

`subjectSelectionDeadline` datum

Uiterste inleverdatum pakketten

`teacherTeams` long[]

Teams

`teachingLevel` string

Bevoegdheidsgraad
mogelijke waardes: 1egraads, 2egraads

`weekTimeTable` long

Weekindeling

`yearOfEducation` integer

Jaarlaag
bereik: [1,9]

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
schoolYear	beperk tot afdelingen binnen een schooljaar	integer
teacherTeam	beperk tot afdelingen horende bij een team	long

Details

`schoolYear` integer

beperk tot afdelingen binnen een schooljaar

`teacherTeam` long

beperk tot afdelingen horende bij een team

/employeeabsences (Afwezigheden)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
id	Id	long	✅	✅

Details

`id` long

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	de velden die u wilt opvragen bij dit verzoek	string
schoolInSchoolYear	afwezigheden binnen de opgegeven roosterprojecten	long

Details

`fields` string

de velden die u wilt opvragen bij dit verzoek

`schoolInSchoolYear` long

afwezigheden binnen de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
absenceDuration	Verlofomvang (klu)	float	✅	✅
absenceDurationManually	Verlofomvang handmatig	boolean	✅	✅
absenceType	Afwezigheidstype	integer	✅	❌
absenceTypeCode	Afwezigheidstype	string	✅	❌
absenceTypePriority	Afwezigheidstype prioriteit	integer	✅	❌
contract	Contract ID	long	✅	✅
created	Aangemaakt	timestamp	✅	✅
definitive	Definitive	boolean	✅	✅
employee	Werknemerscode	string	✅	✅
end	Eind	timestamp	✅	✅
firstName	Voornaam	string	✅	❌
lastModified	Laatst gewijzigd	timestamp	✅	✅
lastModifiedBy	Laatst gewijzigd door	string	✅	✅
lastName	Achternaam	string	✅	❌
leave	Gekoppeld verlof	long	✅	✅
linkedToStructuralLeave	Gekoppeld aan planning/onderhoudsverlof	boolean	✅	❌
prefix	Tussenvoegsel	string	✅	❌
privateComment	Opmerking voor beheerder	string	✅	✅
start	Start	timestamp	✅	✅

Details

`absenceDuration` float

Verlofomvang (klu)

`absenceDurationManually` boolean

Verlofomvang handmatig

`absenceType` integer verplicht bij aanmaken

Afwezigheidstype
mogelijke waardes: 0, 1, 2, 3, 4, 5, 6, 7

`absenceTypeCode` string

Afwezigheidstype

`absenceTypePriority` integer

Afwezigheidstype prioriteit

`contract` long verplicht bij aanmaken immutable

Contract ID
verwijst naar: contracts.id (Contracten)

`created` timestamp

Aangemaakt

`definitive` boolean

Definitive

`employee` string

Werknemerscode
verwijst naar: employees.userCode (Werknemers)

`end` timestamp verplicht bij aanmaken

Eind

`firstName` string

Voornaam

`lastModified` timestamp

Laatst gewijzigd

`lastModifiedBy` string

Laatst gewijzigd door
verwijst naar: users.code (Gebruikers)

`lastName` string

Achternaam

`leave` long

Gekoppeld verlof

`linkedToStructuralLeave` boolean

Gekoppeld aan planning/onderhoudsverlof

`prefix` string

Tussenvoegsel

`privateComment` string

Opmerking voor beheerder

`start` timestamp verplicht bij aanmaken

Start

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot afwezigheden binnen een vestiging	long
endDate	beperk tot afwezigheden tot en met de opgegeven dag	datum
endWeek	beperk tot afwezigheden tot en met de opgegeven week	week
relatedToEmployee	usercode van medewerker waarvoor u de aanwezigheid van collega’s wilt opvragen	string
sectionOfBranch	beperk tot afwezigheden binnen een sectie	long
startDate	beperk tot afwezigheden vanaf de opgegeven dag	datum
startWeek	beperk tot afwezigheden vanaf de opgegeven week	week
teacherTeam	beperk tot afwezigheden binnen een team	long
unlinked	beperk tot afwezigheden die niet gelinkt zijn met een (niet incidenteel) verlof	boolean

Details

`branchOfSchool` long

beperk tot afwezigheden binnen een vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`endDate` datum

beperk tot afwezigheden tot en met de opgegeven dag

`endWeek` week

beperk tot afwezigheden tot en met de opgegeven week

`relatedToEmployee` string

usercode van medewerker waarvoor u de aanwezigheid van collega’s wilt opvragen

`sectionOfBranch` long

beperk tot afwezigheden binnen een sectie
verwijst naar: sectionofbranches.id (Sectie-activaties)

`startDate` datum

beperk tot afwezigheden vanaf de opgegeven dag

`startWeek` week

beperk tot afwezigheden vanaf de opgegeven week

`teacherTeam` long

beperk tot afwezigheden binnen een team

`unlinked` boolean

beperk tot afwezigheden die niet gelinkt zijn met een (niet incidenteel) verlof

/employees (Werknemers)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
commencementSchool	Op school vanaf	datum	✅	✅
commencementTeaching	Docent vanaf	datum	✅	✅
created	Aangemaakt	timestamp	✅	✅
email	Email	string	✅	❌
employeeNumber	Personeelsnummer	string	✅	✅
firstName	Voornaam	string	✅	❌
lastModified	Laatst gewijzigd	timestamp	✅	✅
lastModifiedBy	Laatst gewijzigd door	string	✅	✅
lastName	Achternaam	string	✅	❌
prefix	Tussenvoegsel	string	✅	❌
userCode	Gebruiker	string	✅	✅

Details

`commencementSchool` datum

Op school vanaf

`commencementTeaching` datum

Docent vanaf

`created` timestamp

Aangemaakt

`email` string

`employeeNumber` string

Personeelsnummer

`firstName` string

Voornaam

`lastModified` timestamp

Laatst gewijzigd

`lastModifiedBy` string

Laatst gewijzigd door
verwijst naar: users.code (Gebruikers)

`lastName` string

Achternaam

`prefix` string

Tussenvoegsel

`userCode` string verplicht bij aanmaken immutable

Gebruiker
verwijst naar: users.code (Gebruikers)

ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot werknemers gerelateerd aan een vestiging binnen een roosterproject	long
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot werknemers gerelateerd aan een roosterproject	long

Details

`branchOfSchool` long

beperk tot werknemers gerelateerd aan een vestiging binnen een roosterproject
verwijst naar: branchesofschools.id (Vestigingen in project)

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot werknemers gerelateerd aan een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
city	Plaats	string	✅	❌
dateOfBirth	Geboortedatum	datum	✅	❌
gender	Geslacht	string	✅	❌
houseNumber	Huisnummer	string	✅	❌
postalCode	Postcode	string	✅	❌
roles	Rollen	string[]	✅	❌
street	Straat	string	✅	❌
user	Gebruiker	string	✅	❌

Details

`city` string

Plaats

`dateOfBirth` datum

Geboortedatum

`gender` string

Geslacht
mogelijke waardes: f, m

`houseNumber` string

Huisnummer

`postalCode` string

Postcode

`roles` string[]

Rollen

extra details:
Niet gebruiken, gaat binnenkort verwijderd worden

`street` string

Straat

`user` string

Gebruiker

extra details:
Niet gebruiken, gaat uitgefaseerd worden

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
archived	beperk tot werknemers die wel/niet gearchiveerd zijn	boolean
teacherTeam	beperk tot werknemers gerelateerd aan een team binnen een roosterproject	long

Details

`archived` boolean

beperk tot werknemers die wel/niet gearchiveerd zijn

`teacherTeam` long

beperk tot werknemers gerelateerd aan een team binnen een roosterproject

/enrollmentstatuspersubject (Inschrijfstatussen per vak)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
choosableInDepartment	Vak-op-afdeling	long	✅	✅
plannedOptionalLessonAttendance	Geplande aanwezigheid optionele lessen	integer	✅	✅
plannedOptionalLessons	Aangeboden optionele lessen	integer	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅
student	Leerling	string	✅	✅
week	Week	week	✅	✅

Details

`choosableInDepartment` long

Vak-op-afdeling
verwijst naar: choosableindepartments.id (Vak-op-afdeling)

`plannedOptionalLessonAttendance` integer

Geplande aanwezigheid optionele lessen
bereik: [0,-]

`plannedOptionalLessons` integer

Aangeboden optionele lessen
bereik: [0,-]

`schoolInSchoolYear` long

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`student` string

Leerling
verwijst naar: students.userCode (Leerlingen)

`week` week

Week

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
activeLessonAttendance	Verwacht aantal lessen	integer	✅	✅
cancelledLessonAttendance	Uitgevallen lessen (met uitvalreden de docent)	integer	✅	✅
choosableInDepartmentCode	Vak-op-afdeling	string	✅	✅
departmentOfBranch	Afdeling	long	✅	✅
isMandatorySubject	Verplichte lesbetrokkenheid	boolean	✅	✅
lessonHoursInClassPeriod	Aantal lesuren volgens de lessentabel	integer	✅	✅
maxRecommendedLessons	Maximaal aantal aangeraden lessen per week	integer	✅	✅
mentorGroup	Mentorgroep	long	✅	✅
minRecommendedLessons	Minimaal aantal aangeraden lessen per week	integer	✅	✅
plannedMandatoryLessonAttendance	Geplande aanwezigheid verplichte lessen	integer	✅	✅
plannedMandatoryLessons	Aangeboden verplichte lessen	integer	✅	✅
studentInDepartment	Leerling	long	✅	✅
subject	Vak	long	✅	✅

Details

`activeLessonAttendance` integer

Verwacht aantal lessen
bereik: [0,-]

`cancelledLessonAttendance` integer

Uitgevallen lessen (met uitvalreden de docent)
bereik: [0,-]

`choosableInDepartmentCode` string

Vak-op-afdeling

`departmentOfBranch` long

Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`isMandatorySubject` boolean

Verplichte lesbetrokkenheid

`lessonHoursInClassPeriod` integer

Aantal lesuren volgens de lessentabel

`maxRecommendedLessons` integer

Maximaal aantal aangeraden lessen per week
bereik: [0,-]

`mentorGroup` long

Mentorgroep
verwijst naar: groupindepartments.id (Roostergroepen)

`minRecommendedLessons` integer

Minimaal aantal aangeraden lessen per week
bereik: [0,-]

`plannedMandatoryLessonAttendance` integer

Geplande aanwezigheid verplichte lessen
bereik: [0,-]

`plannedMandatoryLessons` integer

Aangeboden verplichte lessen
bereik: [0,-]

`studentInDepartment` long

Leerling
verwijst naar: studentsindepartments.id (Afdelingsdeelnames)

`subject` long

Vak

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
groupInDepartment	beperk tot statistieken voor leerlingen in de opgegeven mentorgroep	long[]

Details

`groupInDepartment` long[]

beperk tot statistieken voor leerlingen in de opgegeven mentorgroep
verwijst naar: groupindepartments.id (Roostergroepen)

/enrollmentstatus (Inschrijfstatussen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
lessonEnrollment	Aantal inschrijvingen voor lessen	integer	✅	✅
maximalLessonEnrollment	Maximaal aantal inschrijvingen voor lessen per week	integer	✅	✅
minimalLessonEnrollment	Minimaal aantal inschrijvingen voor lessen per week	integer	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅
student	Leerling	string	✅	✅
week	Week	week	✅	✅

Details

`lessonEnrollment` integer

Aantal inschrijvingen voor lessen
bereik: [0,-]

`maximalLessonEnrollment` integer

Maximaal aantal inschrijvingen voor lessen per week
bereik: [0,-]

`minimalLessonEnrollment` integer

Minimaal aantal inschrijvingen voor lessen per week
bereik: [0,-]

`schoolInSchoolYear` long

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`student` string

Leerling
verwijst naar: students.userCode (Leerlingen)

`week` week

Week

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
activityEnrollment	Aantal inschrijvingen voor activiteiten	integer	✅	✅
concurrentPlannedAttendance	Aantal dubbele afspraken	integer	✅	✅
departmentOfBranch	Afdeling	long	✅	✅
enrollmentValidationType	Inschrijfcontrole	string	✅	✅
examEnrollment	Aantal inschrijvingen voor toetsen	integer	✅	✅
maximalLessons	Maximaal aantal te volgen lessen per week	integer	✅	✅
mentorGroup	Mentorgroep	long	✅	✅
minimalLessons	Minimaal aantal te volgen lessen per week	integer	✅	✅
name	De code van de afdeling van deze status	string	✅	❌
plannedActivityAttendance	Verwacht aantal activiteiten	integer	✅	✅
plannedAttendance	Verwacht aantal afspraken	integer	✅	✅
plannedExamAttendance	Verwacht aantal toetsen	integer	✅	✅
plannedLessonAttendance	Verwacht aantal lessen	integer	✅	✅
status	Status	json[]	✅	❌
studentInDepartment	Leerling	long	✅	✅

Details

`activityEnrollment` integer

Aantal inschrijvingen voor activiteiten
bereik: [0,-]

`concurrentPlannedAttendance` integer

Aantal dubbele afspraken
bereik: [0,-]

`departmentOfBranch` long

Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`enrollmentValidationType` string

Inschrijfcontrole
mogelijke waardes: ENROLLMENTS, LESSONS

`examEnrollment` integer

Aantal inschrijvingen voor toetsen
bereik: [0,-]

`maximalLessons` integer

Maximaal aantal te volgen lessen per week
bereik: [0,-]

`mentorGroup` long

Mentorgroep
verwijst naar: groupindepartments.id (Roostergroepen)

`minimalLessons` integer

Minimaal aantal te volgen lessen per week
bereik: [0,-]

`name` string

De code van de afdeling van deze status

extra details:
Niet gebruiken. Vraag de code van een afdeling op bij afdelingen

`plannedActivityAttendance` integer

Verwacht aantal activiteiten
bereik: [0,-]

`plannedAttendance` integer

Verwacht aantal afspraken
bereik: [0,-]

`plannedExamAttendance` integer

Verwacht aantal toetsen
bereik: [0,-]

`plannedLessonAttendance` integer

Verwacht aantal lessen
bereik: [0,-]

`status` json[]

Status

`studentInDepartment` long

Leerling
verwijst naar: studentsindepartments.id (Afdelingsdeelnames)

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/familymembers (Ouders/verzorgers)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
email	Email	string	✅	❌
firstName	Voornaam	string	✅	❌
lastName	Achternaam	string	✅	❌
prefix	Tussenvoegsel	string	✅	❌
students	Kinderen	string[]	✅	✅
userCode	Gebruiker	string	✅	✅

Details

`email` string

`firstName` string

Voornaam

`lastName` string

Achternaam

`prefix` string

Tussenvoegsel

`students` string[]

Kinderen
verwijst naar: students.userCode (Leerlingen)

`userCode` string verplicht bij aanmaken immutable

Gebruiker
verwijst naar: users.code (Gebruikers)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot ouders met een kind dat deelneemt aan een roosterproject	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot ouders met een kind dat deelneemt aan een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
archived	Gearchiveerd	boolean	✅	✅
city	Plaats	string	✅	❌
houseNumber	Huisnummer	string	✅	❌
includedForRequests	Deelname aan ouderavonden	boolean	✅	✅
magisterUUID	Magister UUID	uuid	✅	❌
postalCode	Postcode	string	✅	❌
scheduleFill		long	✅	✅
scheduleSpanWidthFactor	Wenselijkheid van een smal ouderavondrooster	long	✅	✅
scheduleWidth	Ouderavondwens	long	✅	✅
somUUID	Somtoday UUID	uuid	✅	❌
street	Straat	string	✅	❌

Details

`archived` boolean

Gearchiveerd

`city` string

Plaats

`houseNumber` string

Huisnummer

`includedForRequests` boolean

Deelname aan ouderavonden

extra details:
Voor ouders met deze eigenschap worden gespreksmogelijkheden aangemaakt bij ouderavonden

`magisterUUID` uuid

Magister UUID

`postalCode` string

Postcode

`scheduleFill` long

extra details:
Onderdeel van de specificatie van een ouderavondroosterwens: in een reeks van scheduleWidth momenten vinden maximaal scheduleFill gesprekken plaats

`scheduleSpanWidthFactor` long

Wenselijkheid van een smal ouderavondrooster

`scheduleWidth` long

Ouderavondwens

extra details:
Onderdeel van de specificatie van een ouderavondroosterwens: in een reeks van scheduleWidth momenten vinden maximaal scheduleFill gesprekken plaats

`somUUID` uuid

Somtoday UUID

`street` string

Straat

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
hasPassword	beperk tot werknemers die wel/geen wachtwoord hebben	boolean
ldap	beperk tot werknemers die wel/geen moeten inloggen via LDAP	boolean
parentTeacherNight	beperk tot ouders verbonden aan een ouderavond	long

Details

`hasPassword` boolean

beperk tot werknemers die wel/geen wachtwoord hebben

`ldap` boolean

beperk tot werknemers die wel/geen moeten inloggen via LDAP

`parentTeacherNight` long

beperk tot ouders verbonden aan een ouderavond
verwijst naar: parentteachernights.id (Ouderavonden)

/groupindepartments (Roostergroepen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
id	id	long	✅	✅

Details

`id` long

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot roostergroepen binnen een roosterproject	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot roostergroepen binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
departmentOfBranch	Afdeling	long	✅	✅
educations	Opleidingen	long[]	✅	❌
extendedName	Volledige naam	string	✅	❌
isMainGroup	Stamklas	boolean	✅	✅
isMentorGroup	Mentorgroep	boolean	✅	✅
mentorUserCodes	Mentor(en)	string[]	✅	❌
name	Naam	string	✅	✅
studentInDepartments	Leerlingen	long[]	✅	❌
yearOfEducation	Jaarlaag	integer	✅	❌

Details

`departmentOfBranch` long verplicht bij aanmaken immutable

Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`educations` long[]

Opleidingen

`extendedName` string

Volledige naam

extra details:
Naam van de groep inclusief afdeling

`isMainGroup` boolean

Stamklas

`isMentorGroup` boolean

Mentorgroep

`mentorUserCodes` string[]

Mentor(en)
verwijst naar: employees.userCode (Werknemers)

`name` string verplicht bij aanmaken

Naam

`studentInDepartments` long[]

Leerlingen
verwijst naar: studentsindepartments.id (Afdelingsdeelnames)
extra details:
Leerlingen in deze roostergroep. Voor stamklassen (isMainGroup): leerlingen die deze groep als stamklas hebben. Anders ook leerlingen die hier op een andere manier aan verbonden zijn, bijvoorbeeld als mentorgroep of deelname aan een gerelateerde geplande groep.

`yearOfEducation` integer

Jaarlaag
bereik: [1,9]

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot roostergroepen binnen een vestiging	long
isMentorOrMainGroup	beperk tot roostergroepen die wel/niet stamklas of mentorgroep zijn	boolean
schoolYear	beperk tot roostergroepen binnen een schooljaar	integer

Details

`branchOfSchool` long

beperk tot roostergroepen binnen een vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`isMentorOrMainGroup` boolean

beperk tot roostergroepen die wel/niet stamklas of mentorgroep zijn

`schoolYear` integer

beperk tot roostergroepen binnen een schooljaar

/holidays (Vakanties)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
end	Eind	datum	✅	✅
id	ID	long	✅	✅
name	Naam	string	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅
start	Start	datum	✅	✅

Details

`end` datum verplicht bij aanmaken

Eind

extra details:
Laatste dag van de vakantie

`id` long

`name` string verplicht bij aanmaken

Naam

extra details:
Naam van de vakantie

`schoolInSchoolYear` long verplicht bij aanmaken immutable

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)
extra details:
Roosterproject waar de vakantie bij hoort

`start` datum verplicht bij aanmaken

Start

extra details:
Eerste dag van de vakantie

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren

Details

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/jobs (Aanstellingen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
contract	Werknemerscode	long	✅	✅
created	Aangemaakt	timestamp	✅	✅
durationManually	Duur handmatig?	boolean	✅	✅
employmentType	Dienstverband	string	✅	❌
end	Eind	datum	✅	✅
fte	WTF jaarequivalent	float	✅	✅
fteReal	WTF	float	✅	✅
functionCategory	Functiecategorie	string	✅	❌
id	id	long	✅	✅
lastModified	Laatst gewijzigd	timestamp	✅	✅
lastModifiedBy	Laatst gewijzigd door	string	✅	✅
start	Start	datum	✅	✅

Details

`contract` long verplicht bij aanmaken immutable

Werknemerscode
verwijst naar: contracts.id (Contracten)

`created` timestamp

Aangemaakt

`durationManually` boolean

Duur handmatig?

`employmentType` string

Dienstverband
mogelijke waardes: vast, tijdelijk

`end` datum

Eind

`fte` float

WTF jaarequivalent
bereik: [0.0,-]

`fteReal` float

WTF
bereik: [0.0,-]

`functionCategory` string

Functiecategorie
mogelijke waardes: OP, OOP, DIR

`id` long

`lastModified` timestamp

Laatst gewijzigd

`lastModifiedBy` string

Laatst gewijzigd door
verwijst naar: users.code (Gebruikers)

`start` datum

Start

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	aanstellingen binnen de opgegeven roosterprojecten	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

aanstellingen binnen de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
clockHoursGross	Bruto klokuren	float	✅	❌
employee	Code	string	✅	❌
employerCost	Indicatie werkgeverskosten	long	✅	❌
externalId	Extern id	string	✅	✅
firstName	Voornaam	string	✅	❌
fteManually	WTF jaarequivalent handmatig?	boolean	✅	✅
functionCategoryManually	Functiecategorie handmatig?	boolean	✅	✅
lastName	Achternaam	string	✅	❌
prefix	Tussenvoegsel	string	✅	❌
privateComment	Opmerking voor beheerder	string	✅	✅
projectBudget	Geldstroom	long	✅	✅
publicComment	Opmerking voor docent	string	✅	✅
type	Dienstverband	string	✅	✅

Details

`clockHoursGross` float

Bruto klokuren

extra details:
We houden dit aantal bij op 1 decimaal nauwkeurig, opdat we in het contract correct kunnen zijn op gehele klokuren, waar de formatieberekening uitsluitend mee werkt.

`employee` string

Code
verwijst naar: employees.userCode (Werknemers)

`employerCost` long

Indicatie werkgeverskosten

`externalId` string

Extern id

`firstName` string

Voornaam

`fteManually` boolean

WTF jaarequivalent handmatig?

`functionCategoryManually` boolean

Functiecategorie handmatig?

`lastName` string

Achternaam

`prefix` string

Tussenvoegsel

`privateComment` string

Opmerking voor beheerder

`projectBudget` long

Geldstroom

`publicComment` string

Opmerking voor docent

`type` string

Dienstverband

extra details:
Niet gebruiken, gebruik employmentType

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
teacherTeam	aanstellingen binnen een team	long
week	aanstellingen geldig in de opgegeven weken	week

Details

`teacherTeam` long

aanstellingen binnen een team

`week` week

aanstellingen geldig in de opgegeven weken

/liveschedule (Liverooster afspraken)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
appointments	Afspraken	json[]	✅	❌
replacements	Vervangingen	json[]	✅	❌
status	Weekstatus	json[]	✅	❌
user	Gebruiker	string	✅	❌
week	Week	week	✅	✅

Details

`appointments` json[]

Afspraken

`replacements` json[]

Vervangingen

`status` json[]

Weekstatus

`user` string

Gebruiker
verwijst naar: users.code (Gebruikers)

`week` week

Week

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	liverooster van een deelnemer aan een van de opgegeven roosterprojecten	long
student	liverooster van de opgegeven leerling	string
teacher	liverooster van de opgegeven docent	string

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

liverooster van een deelnemer aan een van de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`student` string

liverooster van de opgegeven leerling

`teacher` string

liverooster van de opgegeven docent

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren

Details

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/locationofbranches (Lokalen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
branchOfSchool	Hoofdvestiging	integer	✅	✅	✅
id	ID	long	✅	✅	✅
name	Naam	string	✅	✅	✅
schoolInSchoolYear	Roosterproject	integer	✅	✅	❌

Details

`branchOfSchool` integer verplicht bij aanmaken

Hoofdvestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`id` long

`name` string verplicht bij aanmaken

Naam

`schoolInSchoolYear` integer

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
allowMeetings	Lokaal beschikbaar voor werknemers om afspraken in te plannen	boolean	✅	✅	✅
courseCapacity	Capaciteit (les)	integer	✅	✅	✅
parentteachernightCapacity	Capaciteit (ouderavond)	integer	✅	✅	✅
secondaryBranches	Nevenvestigingen	integer[]	✅	✅	✅
supportsConcurrentAppointments	Lokaal geschikt voor meerdere gelijktijdige afspraken	boolean	✅	✅	✅

Details

`allowMeetings` boolean

Lokaal beschikbaar voor werknemers om afspraken in te plannen

`courseCapacity` integer

Capaciteit (les)
bereik: [0,-]

`parentteachernightCapacity` integer

Capaciteit (ouderavond)
bereik: [0,-]

`secondaryBranches` integer[]

Nevenvestigingen
verwijst naar: branchesofschools.id (Vestigingen in project)

`supportsConcurrentAppointments` boolean

Lokaal geschikt voor meerdere gelijktijdige afspraken

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branch	beperk tot lokalen die verbonden zijn aan een vestiging	long

Details

`branch` long

beperk tot lokalen die verbonden zijn aan een vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)
extra details:
Beperk tot lokalen die (één van) de opgegeven vestiging(en) als hoofd- dan wel nevenvestiging hebben

/parentteachernights (Ouderavonden)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
allowRequestingUntil	Aanvragen toestaan tot	timestamp	✅	✅
archived	Gearchiveerd?	boolean	✅	✅
description	Nadere toelichting	string	✅	✅
hasParentToSchedulerRemark	Opmerking aan de roostermaker?	boolean	✅	✅
hasParentToTeacherRemark	Opmerking aan de docent?	boolean	✅	✅
maxNumberOfRequests	Maximaal aantal aanvragen per kind	integer	✅	✅
parentCanRequestLongTalk	Lang gesprek aanvraagbaar door ouders?	boolean	✅	✅
published	Gepubliceerd?	boolean	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅
title	Naam	string	✅	✅

Details

`allowRequestingUntil` timestamp

Aanvragen toestaan tot

`archived` boolean

Gearchiveerd?

`description` string

Nadere toelichting

`hasParentToSchedulerRemark` boolean

Opmerking aan de roostermaker?

`hasParentToTeacherRemark` boolean

Opmerking aan de docent?

`maxNumberOfRequests` integer

Maximaal aantal aanvragen per kind
bereik: [0,-]

`parentCanRequestLongTalk` boolean

Lang gesprek aanvraagbaar door ouders?

`published` boolean

Gepubliceerd?

`schoolInSchoolYear` long verplicht bij aanmaken immutable

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`title` string verplicht bij aanmaken

Naam

ondersteunde extra filters

Filternaam	Omschrijving	Type
familyMember	beperk tot ouderavonden met gesprekken van de opgegeven ouder	long[]
fields	de velden die u wilt opvragen bij dit verzoek	string

Details

`familyMember` long[]

beperk tot ouderavonden met gesprekken van de opgegeven ouder
verwijst naar: familymembers.id (Ouders/verzorgers)

`fields` string

de velden die u wilt opvragen bij dit verzoek

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
employeeScheduleFill	vinden maximaal … gesprekken plaats	integer	✅	✅
employeeScheduleSpanWidthFactor	Wenselijkheid smal rooster	integer	✅	✅
employeeScheduleWidth	In een reeks van … momenten	integer	✅	✅
id	ID	long	✅	✅
parentScheduleFill	vinden maximaal … gesprekken plaats	integer	✅	✅
parentScheduleSpanWidthFactor	Wenselijkheid smal rooster	integer	✅	✅
parentScheduleWidth	In een reeks van … momenten	integer	✅	✅
referenceWeek	Peilweek	week	✅	✅
schedulePublished	Rooster zichtbaar?	boolean	✅	✅
talkDays	Gespreksdagen	json[]	✅	✅
talkDaysText	Gespreksdata	string[]	✅	✅

Details

`employeeScheduleFill` integer

vinden maximaal … gesprekken plaats

`employeeScheduleSpanWidthFactor` integer

Wenselijkheid smal rooster

`employeeScheduleWidth` integer

In een reeks van … momenten

`id` long

`parentScheduleFill` integer

vinden maximaal … gesprekken plaats

`parentScheduleSpanWidthFactor` integer

Wenselijkheid smal rooster

`parentScheduleWidth` integer

In een reeks van … momenten

`referenceWeek` week verplicht bij aanmaken

Peilweek

`schedulePublished` boolean

Rooster zichtbaar?

`talkDays` json[]

Gespreksdagen

extra details:
Niet gebruiken: doe een aanvraag op het endpoint /talkdays voor deze informatie

`talkDaysText` string[]

Gespreksdata

extra details:
Niet gebruiken: doe een aanvraag op het endpoint /talkdays voor deze informatie

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/parenttoschedulerremarks (Ouderavond opmerkingen van ouders)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
familyMember	Ouder	string	✅	✅	✅
id	ID	long	✅	✅	✅
parentTeacherNight	Ouderavond	long	✅	✅	✅
remark	Opmerking	string	✅	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅	❌

Details

`familyMember` string verplicht bij aanmaken immutable

Ouder
verwijst naar: familymembers.userCode (Ouders/verzorgers)

`id` long

`parentTeacherNight` long verplicht bij aanmaken immutable

Ouderavond
verwijst naar: parentteachernights.id (Ouderavonden)

`remark` string verplicht bij aanmaken

Opmerking

`schoolInSchoolYear` long

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
processed	Verwerkt	boolean	✅	✅	✅

Details

`processed` boolean

Verwerkt

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/schoolsinschoolyears (Roosterprojecten)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
archived	Gearchiveerd	boolean	✅	✅
archivedTime	Archieftijd	timestamp	✅	✅
id	ID	long	✅	✅
name	Roosterproject Portal	string	✅	❌
school	School	long	✅	✅
year	Schooljaar	integer	✅	✅

Details

`archived` boolean

Gearchiveerd

`archivedTime` timestamp

Archieftijd

`id` long

`name` string

Roosterproject Portal

`school` long verplicht bij aanmaken immutable

School

`year` integer verplicht bij aanmaken immutable

Schooljaar

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot het opgegeven roosterproject	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot het opgegeven roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
basedOn	Gebaseerd op	long	❌	❌
branchOfSchools	Vestigingen	long[]	✅	✅
desktopProjectSettings	Instellingen van Zermelo Desktop voor dit roosterproject	string	✅	❌
desktopStorageOnline	Opslag van roosterproject gebeurt online	boolean	✅	✅
project	Roosterproject Zermelo Desktop	string	✅	✅
projectName	Roosterproject Portal	string	✅	❌
schoolHrmsCode	Code van de school in personeelsadministratiesysteem	string	✅	❌
schoolName	Schoolnaam	string	✅	❌

Details

`basedOn` long

Gebaseerd op
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`branchOfSchools` long[]

Vestigingen
verwijst naar: branchesofschools.id (Vestigingen in project)

`desktopProjectSettings` string

Instellingen van Zermelo Desktop voor dit roosterproject

`desktopStorageOnline` boolean

Opslag van roosterproject gebeurt online

`project` string

Roosterproject Zermelo Desktop

`projectName` string

Roosterproject Portal

extra details:
Niet gebruiken, gebruik name

`schoolHrmsCode` string

Code van de school in personeelsadministratiesysteem

`schoolName` string

Schoolnaam

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
archivable	beperk tot archiveerbare roosterprojecten	boolean
atlasNexusEnabled	beperk tot roosterprojecten die het toestaan om atlas nexus te gebruiken	boolean
branches	beperk tot roosterprojecten met daarin de gegeven vestiging	string
removable	beperk tot verwijderbare roosterprojecten	boolean
schoolYear	beperk tot projecten in dit schooljaar	integer
useHrms	beperk tot roosterprojecten die het personeelsadministratiesysteem van het portal	boolean

Details

`archivable` boolean

beperk tot archiveerbare roosterprojecten

`atlasNexusEnabled` boolean

beperk tot roosterprojecten die het toestaan om atlas nexus te gebruiken

`branches` string

beperk tot roosterprojecten met daarin de gegeven vestiging
verwijst naar: branches.id (Vestigingen)

`removable` boolean

beperk tot verwijderbare roosterprojecten

`schoolYear` integer

beperk tot projecten in dit schooljaar

`useHrms` boolean

beperk tot roosterprojecten die het personeelsadministratiesysteem van het portal

/sectionassignments (Sectietoekenningen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
contract	Contract	long	✅	✅
id	ID	long	✅	✅
lessonHoursFirstDegree	Te plannen lessen 1e graads	float	✅	✅
lessonHoursSecondDegree	Te plannen lessen 2e graads	float	✅	✅
sectionOfBranch	Sectie	long	✅	✅

Details

`contract` long verplicht bij aanmaken immutable

Contract
verwijst naar: contracts.id (Contracten)

`id` long

`lessonHoursFirstDegree` float

Te plannen lessen 1e graads
bereik: [0.0,-]

`lessonHoursSecondDegree` float

Te plannen lessen 2e graads
bereik: [0.0,-]

`sectionOfBranch` long verplicht bij aanmaken immutable

Sectie
verwijst naar: sectionofbranches.id (Sectie-activaties)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	de velden die u wilt opvragen bij dit verzoek	string
schoolInSchoolYear	beperk tot sectietoekenningen binnen een roosterproject	long

Details

`fields` string

de velden die u wilt opvragen bij dit verzoek

`schoolInSchoolYear` long

beperk tot sectietoekenningen binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branchOfSchool	Vestiging-in-project	long	✅	✅
employee	Werknemer	string	✅	❌
lessonHours	Te plannen lessen totaal	float	✅	❌
privateComment	Opmerking voor beheerder	string	✅	✅
publicComment	Opmerking voor docent	string	✅	✅
teachingQualificationStatus	Bevoegdheid op peildatum	string	✅	❌

Details

`branchOfSchool` long

Vestiging-in-project
verwijst naar: branchesofschools.id (Vestigingen in project)

`employee` string

Werknemer
verwijst naar: employees.userCode (Werknemers)

`lessonHours` float

Te plannen lessen totaal
bereik: [0.0,-]

`privateComment` string

Opmerking voor beheerder

`publicComment` string

Opmerking voor docent

`teachingQualificationStatus` string

Bevoegdheid op peildatum

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
section	beperk tot sectietoekenningen voor een sectie	long
teacherTeam	beperk tot sectietoekenningen binnen een team	long

Details

`section` long

beperk tot sectietoekenningen voor een sectie
verwijst naar: sections.id (Secties)

`teacherTeam` long

beperk tot sectietoekenningen binnen een team

/sectionofbranches (Sectie-activaties)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branchOfSchool	Vestiging-in-project	long	✅	✅
id	ID	long	✅	✅
section	Sectie	long	✅	✅

Details

`branchOfSchool` long verplicht bij aanmaken immutable

Vestiging-in-project
verwijst naar: branchesofschools.id (Vestigingen in project)

`id` long

`section` long verplicht bij aanmaken immutable

Sectie
verwijst naar: sections.id (Secties)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	de velden die u wilt opvragen bij dit verzoek	string
schoolInSchoolYear	beperk tot sectie-activaties binnen een roosterproject	long

Details

`fields` string

de velden die u wilt opvragen bij dit verzoek

`schoolInSchoolYear` long

beperk tot sectie-activaties binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
branchOfSchoolName	Vestigingsnaam	string	✅	❌
deploymentBalanceComment	Opmerking inzetbalans	string	✅	✅
sectionAbbreviation	Afkorting Sectie	string	✅	❌
sectionMembers	Sectieleden	long[]	✅	❌
sectionName	Sectienaam	string	✅	❌

Details

`branchOfSchoolName` string

Vestigingsnaam

`deploymentBalanceComment` string

Opmerking inzetbalans

`sectionAbbreviation` string

Afkorting Sectie

`sectionMembers` long[]

Sectieleden
verwijst naar: contracts.id (Contracten)

`sectionName` string

Sectienaam

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
schoolYear	beperk tot sectie-activaties binnen een schooljaar	integer

Details

`schoolYear` integer

beperk tot sectie-activaties binnen een schooljaar

/sections (Secties)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
abbreviation	Afkorting	string	✅	✅
id	ID	long	✅	✅
name	Naam sectie	string	✅	✅

Details

`abbreviation` string verplicht bij aanmaken

Afkorting

`id` long

`name` string

Naam sectie

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	de velden die u wilt opvragen bij dit verzoek	string
schoolInSchoolYear	beperk tot secties geactiveerd binnen een roosterproject	long

Details

`fields` string

de velden die u wilt opvragen bij dit verzoek

`schoolInSchoolYear` long

beperk tot secties geactiveerd binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
sectionOfBranches	Sectie-op-vestigingen	long[]	✅	✅

Details

`sectionOfBranches` long[]

Sectie-op-vestigingen
verwijst naar: sectionofbranches.id (Sectie-activaties)

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot secties geactiveerd binnen een vestiging in een roosterproject	long

Details

`branchOfSchool` long

beperk tot secties geactiveerd binnen een vestiging in een roosterproject
verwijst naar: branchesofschools.id (Vestigingen in project)

/standardprognosis (Standaardprognoses)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
id	ID	long	✅	✅
percentage	Percentage	integer	✅	✅
sourceDepartment	Bronafdeling	long	✅	✅
targetDepartment	Doelafdeling	long	✅	✅

Details

`id` long

`percentage` integer

Percentage
bereik: [0,100]

`sourceDepartment` long verplicht bij aanmaken immutable

Bronafdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`targetDepartment` long verplicht bij aanmaken immutable

Doelafdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot standaardprognoses met het opgegeven project als bron of doel	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot standaardprognoses met het opgegeven project als bron of doel
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
sourceDepartmentCode	Bronafdeling	string	✅	❌
sourceProject	Bronproject	long	✅	✅
targetDepartmentCode	Doelafdeling	string	✅	❌
targetProject	Doelproject	long	✅	✅

Details

`sourceDepartmentCode` string

Bronafdeling

`sourceProject` long

Bronproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`targetDepartmentCode` string

Doelafdeling

`targetProject` long

Doelproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
sourceBranch	beperk tot standaardprognoses met als bronvestiging de opgegeven vestiging	long
sourceSchool	beperk tot standaardprognoses met een bronafdeling binnen de opgegeven school	long
targetBranch	beperk tot standaardprognoses met als doelvestiging de opgegeven vestiging	long

Details

`sourceBranch` long

beperk tot standaardprognoses met als bronvestiging de opgegeven vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`sourceSchool` long

beperk tot standaardprognoses met een bronafdeling binnen de opgegeven school

`targetBranch` long

beperk tot standaardprognoses met als doelvestiging de opgegeven vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

/studentsindepartments (Afdelingsdeelnames)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
id	Id	long	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅
student	Leerlingcode	string	✅	✅

Details

`id` long

`schoolInSchoolYear` long

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`student` string verplicht bij aanmaken immutable

Leerlingcode
verwijst naar: students.userCode (Leerlingen)

ondersteunde extra filters

Filternaam	Omschrijving	Type
archived	beperk tot afdelingsdeelnames van actieve of gearchiveerde leerlingen	boolean
branchOfSchool	beperk tot afdelingsdeelnames binnen een vestiging	long
fields	de velden die u wilt opvragen bij dit verzoek	long

Details

`archived` boolean

beperk tot afdelingsdeelnames van actieve of gearchiveerde leerlingen

`branchOfSchool` long

beperk tot afdelingsdeelnames binnen een vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`fields` long

de velden die u wilt opvragen bij dit verzoek

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
deanApprovesSelection	Akkoord door decaan	boolean	✅	❌
departmentOfBranch	Afdeling	long	✅	✅
departmentOfBranchCode	Afdelingnaam	string	✅	❌
educationalTrack	Leerpad	long	✅	✅
educations	Opleiding	long[]	✅	❌
email	Email	string	✅	❌
firstName	Voornaam	string	✅	❌
fullName	Naam	string	✅	❌
gender	Geslacht	string	✅	❌
groupInDepartments	Groepen-op-afdeling	long[]	✅	✅
lastModified	Laatste aanpassing aan keuzepakket	timestamp	✅	❌
lastName	Achternaam	string	✅	❌
lwoo	LWOO	boolean	✅	❌
mainGroup	Stamklas	long	✅	✅
mainGroupName	Stamklas	string	✅	❌
mainGroupPreviousYear	Stamklas oud	long	✅	❌
mainGroupPreviousYearName	Stamklas oud	string	✅	❌
mentorGroup	Mentorgroep	long	✅	✅
mentorGroupPreviousYear	Mentorgroep oud	long	✅	❌
outflowComment	Uitstroom-opmerking	string	✅	✅
outflowPercentage	Uitstroompercentage	integer	✅	❌
parentApprovalTime	Akkoord o/v tijdstip	timestamp	✅	❌
parentApprovesSelection	Akkoord ouder/verzorger	boolean	✅	❌
participationWeight	Prognose(%)	percentage	✅	✅
prefix	Tussenvoegsel	string	✅	❌
previousMainGroup	Stamklas oud	string	✅	❌
profiles	Profiel	long[]	✅	❌
prognosisComment	Prognose-opmerking	string	✅	✅
schoolPreviousYear	School oud	string	✅	❌
studentApprovesSelection	Ingeleverd door leerling	boolean	✅	❌
studentHasEditedSelection	Bewerkt door leerling	boolean	✅	❌
studentInDepartmentPreviousYear	Leerling oud	long	✅	✅

Details

`deanApprovesSelection` boolean

Akkoord door decaan

`departmentOfBranch` long verplicht bij aanmaken immutable

Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`departmentOfBranchCode` string

Afdelingnaam

`educationalTrack` long

Leerpad

`educations` long[]

Opleiding

`email` string

`firstName` string

Voornaam

`fullName` string

Naam

`gender` string

Geslacht
mogelijke waardes: f, m

`groupInDepartments` long[]

Groepen-op-afdeling
verwijst naar: groupindepartments.id (Roostergroepen)

`lastModified` timestamp

Laatste aanpassing aan keuzepakket

`lastName` string

Achternaam

`lwoo` boolean

LWOO

`mainGroup` long

Stamklas
verwijst naar: groupindepartments.id (Roostergroepen)

`mainGroupName` string

Stamklas

`mainGroupPreviousYear` long

Stamklas oud
verwijst naar: groupindepartments.id (Roostergroepen)

`mainGroupPreviousYearName` string

Stamklas oud

`mentorGroup` long

Mentorgroep
verwijst naar: groupindepartments.id (Roostergroepen)

`mentorGroupPreviousYear` long

Mentorgroep oud
verwijst naar: groupindepartments.id (Roostergroepen)

`outflowComment` string

Uitstroom-opmerking

`outflowPercentage` integer

Uitstroompercentage

`parentApprovalTime` timestamp

Akkoord o/v tijdstip

`parentApprovesSelection` boolean

Akkoord ouder/verzorger

`participationWeight` percentage

Prognose(%)

`prefix` string

Tussenvoegsel

`previousMainGroup` string

Stamklas oud

extra details:
Niet gebruiken: gebruik mainGroupPreviousYearName

`profiles` long[]

Profiel

`prognosisComment` string

Prognose-opmerking

`schoolPreviousYear` string

School oud

`studentApprovesSelection` boolean

Ingeleverd door leerling

`studentHasEditedSelection` boolean

Bewerkt door leerling

`studentInDepartmentPreviousYear` long

Leerling oud
verwijst naar: studentsindepartments.id (Afdelingsdeelnames)

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
departmentOfBranchPreviousYear	beperk tot afdelingsdeelnames van leerlingen die vorig jaar deelnamen op de opgegeven afdeling	long
familyMember	beperk tot afdelingsdeelnames van leerlingen van de opgegeven ouder	string
groupInDepartmentPreviousYear	beperk tot afdelingsdeelnames van leerlingen die in de opgegeven mentorgroep van vorig jaar zaten	long
inflow	beperk tot afdelingsdeelnames van instroomleerlingen	boolean
outflow	beperk tot afdelingsdeelnames van leerlingen met een niet-nul percentage uitstroom	boolean
relatedToDepartment	beperk tot leerlingen met afdelingsdeelnames of met deelnames aan geplande groepen van deze afdeling	long
schoolYear	beperk tot afdelingsdeelnames in het opgegeven schooljaar	long
teacher	beperk tot afdelingsdeelnames van leerlingen met lessen van de opgegeven docent	string
teacherTeam	beperk tot afdelingsdeelnames van leerlingen op een afdeling van het opgeven team	long
visibleToStudent	beperk tot afdelingsdeelnames die de leerling zelf mag zien	boolean

Details

`departmentOfBranchPreviousYear` long

beperk tot afdelingsdeelnames van leerlingen die vorig jaar deelnamen op de opgegeven afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`familyMember` string

beperk tot afdelingsdeelnames van leerlingen van de opgegeven ouder
verwijst naar: familymembers.userCode (Ouders/verzorgers)

`groupInDepartmentPreviousYear` long

beperk tot afdelingsdeelnames van leerlingen die in de opgegeven mentorgroep van vorig jaar zaten
verwijst naar: groupindepartments.id (Roostergroepen)

`inflow` boolean

beperk tot afdelingsdeelnames van instroomleerlingen

`outflow` boolean

beperk tot afdelingsdeelnames van leerlingen met een niet-nul percentage uitstroom

`relatedToDepartment` long

beperk tot leerlingen met afdelingsdeelnames of met deelnames aan geplande groepen van deze afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`schoolYear` long

beperk tot afdelingsdeelnames in het opgegeven schooljaar

`teacher` string

beperk tot afdelingsdeelnames van leerlingen met lessen van de opgegeven docent
verwijst naar: employees.userCode (Werknemers)

`teacherTeam` long

beperk tot afdelingsdeelnames van leerlingen op een afdeling van het opgeven team

`visibleToStudent` boolean

beperk tot afdelingsdeelnames die de leerling zelf mag zien

/students (Leerlingen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
email	Email	string	✅	❌
familyMembers	Ouders	string[]	✅	✅
firstName	Voornaam	string	✅	❌
lastName	Achternaam	string	✅	❌
prefix	Tussenvoegsel	string	✅	❌
userCode	Leerlingcode	string	✅	✅

Details

`email` string

`familyMembers` string[]

Ouders
verwijst naar: familymembers.userCode (Ouders/verzorgers)

`firstName` string

Voornaam

`lastName` string

Achternaam

`prefix` string

Tussenvoegsel

`userCode` string

Leerlingcode
verwijst naar: users.code (Gebruikers)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot leerlingen binnen een roosterproject	long[]

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long[]

beperk tot leerlingen binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
city	Plaats	string	✅	❌
dateOfBirth	Geboortedatum	datum	✅	❌
gender	Geslacht	string	✅	❌
houseNumber	Huisnummer	string	✅	❌
individualRequestsParents	Aparte gesprekken ouders	boolean	✅	✅
intakeProjects	Instroomprojecten	long[]	✅	✅
lwoo	LWOO	boolean	✅	✅
nonarchivedFamilyMembers	Niet-gearchiveerde ouders	string[]	✅	❌
postalCode	Postcode	string	✅	❌
street	Straat	string	✅	❌
studentInDepartments	Afdelingsdeelnames	json[]	✅	✅

Details

`city` string

Plaats

`dateOfBirth` datum

Geboortedatum

`gender` string

Geslacht
mogelijke waardes: f, m

`houseNumber` string

Huisnummer

`individualRequestsParents` boolean

Aparte gesprekken ouders

`intakeProjects` long[]

Instroomprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`lwoo` boolean

LWOO

`nonarchivedFamilyMembers` string[]

Niet-gearchiveerde ouders
verwijst naar: familymembers.userCode (Ouders/verzorgers)

`postalCode` string

Postcode

`street` string

Straat

`studentInDepartments` json[]

Afdelingsdeelnames

extra details:
Niet gebruiken: doe een aanvraag op /studentsindepartments voor deze informatie

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
archived	beperk tot leerlingen die niet gearchiveerd zijn	boolean
departmentOfBranch	beperk tot leerlingen binnen een afdeling	long[]
groupInDepartments	beperk tot leerlingen binnen een roostergroep	long[]
placedIntakeForProject	beperk tot geplaatste instroomleerlingen voor het project	long
possibleIntakeForProject	beperk tot instroomleerlingen voor het project	long
unplacedIntakeForSchoolYear	beperk tot nog ongeplaatste instroomleerlingen voor het schooljaar	integer

Details

`archived` boolean

beperk tot leerlingen die niet gearchiveerd zijn

`departmentOfBranch` long[]

beperk tot leerlingen binnen een afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`groupInDepartments` long[]

beperk tot leerlingen binnen een roostergroep
verwijst naar: groupindepartments.id (Roostergroepen)

`placedIntakeForProject` long

beperk tot geplaatste instroomleerlingen voor het project
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`possibleIntakeForProject` long

beperk tot instroomleerlingen voor het project
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`unplacedIntakeForSchoolYear` integer

beperk tot nog ongeplaatste instroomleerlingen voor het schooljaar

/subjectselectionsubjects (Keuzes)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
code	Keuzecode	string	✅	✅
id	ID	long	✅	✅
iltCode	Elementcode	string	✅	✅
name	Naam	string	✅	✅

Details

`code` string verplicht bij aanmaken

Keuzecode

`id` long

`iltCode` string

Elementcode

extra details:
Elementcode Integrale Leerlingtelling (ILT-code)

`name` string verplicht bij aanmaken

Naam

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een roosterproject	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
choosableInDepartments	Keuze-op-afdelingen	json[]	✅	✅
scheduleCode	Roostercode	string	✅	✅
scheduleCodeManually	Roostercode handmatig?	boolean	✅	✅
type	Type	string	✅	✅

Details

`choosableInDepartments` json[]

Keuze-op-afdelingen

`scheduleCode` string

Roostercode

`scheduleCodeManually` boolean

Roostercode handmatig?

`type` string

Type
mogelijke waardes: education, subject, profile

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
branchOfSchool	beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een vestiging	long
departmentOfBranch	beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een afdeling	long
section	beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een sectie	long
sectionOfBranch	beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een sectie-activatie op een vestiging	long

Details

`branchOfSchool` long

beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)

`departmentOfBranch` long

beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)

`section` long

beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een sectie
verwijst naar: sections.id (Secties)

`sectionOfBranch` long

beperk tot keuze-objecten (vakken/profielen/opleidingen) binnen een sectie-activatie op een vestiging
verwijst naar: sectionofbranches.id (Sectie-activaties)

/talkdays (Ouderavonddagen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
date	Datum	datum	✅	✅
id	ID	long	✅	✅
parentTeacherNight	Ouderavond	long	✅	✅
title	Naam	string	✅	✅

Details

`date` datum verplicht bij aanmaken

Datum

`id` long

`parentTeacherNight` long verplicht bij aanmaken immutable

Ouderavond
verwijst naar: parentteachernights.id (Ouderavonden)

`title` string

Naam

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	Ouderavonddagen binnen de opgegeven roosterprojecten	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

Ouderavonddagen binnen de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
stringDate	Datum	string	✅	❌

Details

`stringDate` string

Datum

extra details:
Niet gebruiken: gebruik het ‘date’ veld

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/talkrequests (Ouderavondgespreksaanvragen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
appointment	Afspraak	long	✅	✅	✅
employees	Docentcodes	string[]	✅	✅	✅
extended	Gewenst aantal tijdslots	long	✅	✅	✅
familyMembers	Ouders	string[]	✅	✅	✅
id	ID	long	✅	✅	✅
parentTeacherNight	Ouderavond	long	✅	✅	✅
parentToTeacherRemark	Opmerking van ouders voor docent	string	✅	✅	✅
requested	Aangevraagd	boolean	✅	✅	✅
schedulerToParentRemark	Opmerking van roostermaker voor ouders	string	✅	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅	❌
student	Leerlingnummer	string	✅	✅	✅
table	Tafel	string	✅	✅	✅
talkTimeSlot	Tijdslot	long	✅	✅	✅
title	Onderwerp	string	✅	✅	✅

Details

`appointment` long

Afspraak
verwijst naar: appointments.id (Afspraakversies)

`employees` string[] verplicht bij aanmaken immutable

Docentcodes
verwijst naar: employees.userCode (Werknemers)

`extended` long

Gewenst aantal tijdslots

extra details:
Het gewenste aantal tijdsloten voor het gesprek, met als standaardwaarde 1.bereik: [1,10]

`familyMembers` string[] verplicht bij aanmaken immutable

Ouders
verwijst naar: familymembers.userCode (Ouders/verzorgers)

`id` long

`parentTeacherNight` long verplicht bij aanmaken immutable

Ouderavond
verwijst naar: parentteachernights.id (Ouderavonden)

`parentToTeacherRemark` string

Opmerking van ouders voor docent

`requested` boolean

Aangevraagd

`schedulerToParentRemark` string

Opmerking van roostermaker voor ouders

`schoolInSchoolYear` long

Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`student` string verplicht bij aanmaken immutable

Leerlingnummer
verwijst naar: students.userCode (Leerlingen)

`table` string

Tafel

`talkTimeSlot` long

Tijdslot

`title` string

Onderwerp

ondersteunde extra filters

Filternaam	Omschrijving	Type
familyMemberSomUUID	beperk tot gespreksaanvragen voor de (met Somtoday UUID) opgegeven ouder	uuid
fields	opgevraagde velden	string

Details

`familyMemberSomUUID` uuid

beperk tot gespreksaanvragen voor de (met Somtoday UUID) opgegeven ouder

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
appointmentEnd	Eindtijd	timestamp	✅	❌	❌
appointmentStart	Starttijd	timestamp	✅	❌	❌
employeeNames	Docentnamen	string[]	✅	❌	❌
families	Niet gebruiken	long[]	✅	❌	❌
familyMemberNames	Oudernamen	string[]	✅	❌	❌
locationOfBranch	Lokaal	long	✅	✅	✅
locked	Vastgezet	boolean	✅	✅	✅
prohibitedDays	Ongewenste dagen	long[]	✅	✅	✅
room	Lokaal	string	✅	✅	✅
studentName	Leerlingnaam	string	✅	❌	❌
subject	Vak	long	✅	✅	✅
talkDay	Dag	long	✅	✅	✅

Details

`appointmentEnd` timestamp

Eindtijd

`appointmentStart` timestamp

Starttijd

`employeeNames` string[]

Docentnamen

`families` long[]

Niet gebruiken

`familyMemberNames` string[]

Oudernamen

`locationOfBranch` long

Lokaal
verwijst naar: locationofbranches.id (Lokalen)

`locked` boolean

Vastgezet

`prohibitedDays` long[]

Ongewenste dagen
verwijst naar: talkdays.id (Ouderavonddagen)

`room` string

Lokaal

`studentName` string

Leerlingnaam

`subject` long

Vak

extra details:
Niet gebruiken: gebruik title

`talkDay` long

Dag
verwijst naar: talkdays.id (Ouderavonddagen)

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/talktimeblockabsenceparent (Ouderavond ouder-moment verhinderingen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
id	ID	long	✅	✅	✅
schoolInSchoolYear	Roosterproject	long	✅	✅	❌
talkDay	Gespreksdag	long	✅	✅	✅
talkTimeBlock	Gesprekstijdverzameling	long	✅	✅	✅
user	Gebruiker	string	✅	✅	✅

Details

`id` long

`user` string verplicht bij aanmaken immutable

Gebruiker
verwijst naar: users.code (Gebruikers)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
parentTeacherNight	verhinderingen binnen de opgegeven ouderavonden	long

Details

`fields` string

opgevraagde velden

`parentTeacherNight` long

verhinderingen binnen de opgegeven ouderavonden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren	Schrijven
overruled	Verworpen	boolean	✅	✅	✅
talkTimeBlockDefinition	Gesprekstijdverzameling	long	✅	❌	✅

Details

`overruled` boolean

Verworpen

`talkTimeBlockDefinition` long immutable

Gesprekstijdverzameling
verwijst naar: talktimeblocks.id (Ouderavond gesprekstijdverzamelingen)
extra details:
Niet gebruiken: gebruik het veld talkTimeBlock

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/talktimeblocks (Ouderavond gesprekstijdverzamelingen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
id	ID	long	✅	✅
parentTeacherNight	Ouderavond	long	✅	✅
span	Totale tijdsbereik gesprekverzamelingen	string	✅	❌
talkTimeSlots	Gesprekstijden	long[]	✅	✅
title	Naam	string	✅	✅

Details

`id` long

`parentTeacherNight` long verplicht bij aanmaken immutable

Ouderavond
verwijst naar: parentteachernights.id (Ouderavonden)

`span` string

Totale tijdsbereik gesprekverzamelingen

`talkTimeSlots` long[]

Gesprekstijden

`title` string

Naam

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	gesprekstijdverzamelingen binnen de opgegeven roosterprojecten	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

gesprekstijdverzamelingen binnen de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren

Details

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/timeslotnames (Lesuurnamen)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
code	Code	string	✅	✅
id	ID	long	✅	✅
schoolInSchoolYear	Project	long	✅	✅

Details

`code` string

Code

`id` long

`schoolInSchoolYear` long verplicht bij aanmaken immutable

Project
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string

Details

`fields` string

opgevraagde velden

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
name	Naam	string	✅	❌
rank	Volgnummer	integer	✅	✅
timeSlots	Lesuren	long	✅	✅

Details

`name` string

Naam

`rank` integer

Volgnummer
bereik: [1,-]

`timeSlots` long

Lesuren

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type

Details

/users (Gebruikers)

ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
code	Gebruikerscode	string	✅	✅
email	Email	string	✅	✅
firstName	Voornaam	string	✅	✅
lastName	Achternaam	string	✅	✅
magisterUUID	Magister UUID	uuid	✅	✅
prefix	Tussenvoegsel	string	✅	✅
somUUID	Somtoday UUID	uuid	✅	✅

Details

`code` string verplicht bij aanmaken

Gebruikerscode

`email` string

`firstName` string

Voornaam

`lastName` string

Achternaam

`magisterUUID` uuid

Magister UUID

`prefix` string

Tussenvoegsel

`somUUID` uuid

Somtoday UUID

ondersteunde extra filters

Filternaam	Omschrijving	Type
fields	opgevraagde velden	string
schoolInSchoolYear	gebruikers verbonden aan de opgegeven roosterprojecten	long

Details

`fields` string

opgevraagde velden

`schoolInSchoolYear` long

gebruikers verbonden aan de opgegeven roosterprojecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

niet-ondersteunde velden

Veldnaam	Titel	Type	Lezen	Filteren
admin	Admin	boolean	✅	✅
archived	Gearchiveerd	boolean	✅	✅
archivedSchoolInSchoolYears	Gearchiveerde projecten	long[]	✅	❌
archivedTime	Archiveermoment	timestamp	✅	✅
city	Plaats	string	✅	✅
dateOfBirth	Geboortedatum	datum	✅	✅
displayName	Niet gebruiken	string	✅	✅
employeeSchoolInSchoolYears	Roosterprojecten waaraan de gebruiker als werknemer verbonden is	long[]	✅	❌
familyMemberSchoolInSchoolYears	Roosterprojecten waaraan de gebruiker als ouder verbonden is	long[]	✅	❌
gender	Geslacht	string	✅	✅
hasPassword	WW	boolean	✅	✅
houseNumber	Huisnummer	string	✅	✅
isApplicationManager	Admin	boolean	✅	✅
isDean	Niet gebruiken	boolean	✅	✅
isEmployee	Wn	boolean	✅	✅
isFamilyMember	O/V	boolean	✅	✅
isMentor	Niet gebruiken	boolean	✅	✅
isParentTeacherNightScheduler	Niet gebruiken	boolean	✅	✅
isSchoolLeader	Niet gebruiken	boolean	✅	✅
isSchoolScheduler	Niet gebruiken	boolean	✅	✅
isSectionLeader	Niet gebruiken	boolean	✅	✅
isStudent	Lln	boolean	✅	✅
isStudentAdministrator	Niet gebruiken	boolean	✅	✅
isTeamLeader	Niet gebruiken	boolean	✅	✅
ldap	Ext. auth.	boolean	✅	✅
mayLogin	Mag de gebruiker inloggen?	boolean	✅	✅
parentTeacherNightOfFamilyIds	Ouderavonden waaraan de gebruiker als ouder verbonden is	long[]	✅	❌
parentTeacherNightOfTeacherIds	Ouderavonden waaraan de gebruiker als werknemer verbonden is	long[]	✅	❌
password	Wachtwoord	string	❌	❌
postalCode	Postcode	string	✅	✅
roles	Rollen	string[]	✅	❌
schoolInSchoolYears	Actieve projecten	long[]	✅	❌
street	Straat	string	✅	✅
studentSchoolInSchoolYears	Roosterprojecten waaraan de gebruiker als leerling verbonden is	long[]	✅	❌
subjectSelectionSchoolInSchoolYears	Roosterprojecten waarin de gebruiker als leerling een zichtbaar keuzepakket heeft	long[]	✅	❌
tfaMandatory	2FA verpl.	boolean	✅	✅
totpEnabled	2FA	boolean	✅	✅
userKind	Soort gebruiker	string	✅	✅
userPrincipalName	LDAP userPrincipalName	string	✅	✅
username	Extra gebruikersnaam	string	✅	✅

Details

`admin` boolean

Admin

extra details:
Niet gebruiken, gebruik isApplicationManager

`archived` boolean

Gearchiveerd

`archivedSchoolInSchoolYears` long[]

Gearchiveerde projecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`archivedTime` timestamp

Archiveermoment

`city` string

Plaats

`dateOfBirth` datum

Geboortedatum

`displayName` string

Niet gebruiken

`employeeSchoolInSchoolYears` long[]

Roosterprojecten waaraan de gebruiker als werknemer verbonden is
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`familyMemberSchoolInSchoolYears` long[]

Roosterprojecten waaraan de gebruiker als ouder verbonden is
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`gender` string

Geslacht
mogelijke waardes: f, m

`hasPassword` boolean

`houseNumber` string

Huisnummer

`isApplicationManager` boolean

Admin

`isDean` boolean

Niet gebruiken

`isEmployee` boolean

`isFamilyMember` boolean

O/V

`isMentor` boolean

Niet gebruiken

`isParentTeacherNightScheduler` boolean

Niet gebruiken

`isSchoolLeader` boolean

Niet gebruiken

`isSchoolScheduler` boolean

Niet gebruiken

`isSectionLeader` boolean

Niet gebruiken

`isStudent` boolean

Lln

`isStudentAdministrator` boolean

Niet gebruiken

`isTeamLeader` boolean

Niet gebruiken

`ldap` boolean

Ext. auth.

`mayLogin` boolean

Mag de gebruiker inloggen?

`parentTeacherNightOfFamilyIds` long[]

Ouderavonden waaraan de gebruiker als ouder verbonden is
verwijst naar: parentteachernights.id (Ouderavonden)

`parentTeacherNightOfTeacherIds` long[]

Ouderavonden waaraan de gebruiker als werknemer verbonden is
verwijst naar: parentteachernights.id (Ouderavonden)

`password` string

Wachtwoord

`postalCode` string

Postcode

`roles` string[]

Rollen

`schoolInSchoolYears` long[]

Actieve projecten
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`street` string

Straat

`studentSchoolInSchoolYears` long[]

Roosterprojecten waaraan de gebruiker als leerling verbonden is
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`subjectSelectionSchoolInSchoolYears` long[]

Roosterprojecten waarin de gebruiker als leerling een zichtbaar keuzepakket heeft
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)

`tfaMandatory` boolean

2FA verpl.

`totpEnabled` boolean

2FA

`userKind` string

Soort gebruiker
mogelijke waardes: PERSON, SOMTODAY, MAGISTER, WORKSPACE365, ITSLEARNING, SPEYK

`userPrincipalName` string

LDAP userPrincipalName

`username` string

Extra gebruikersnaam

niet-ondersteunde extra filters

Filternaam	Omschrijving	Type
archivable	archiveerbare gebruikers	boolean
familyMember	leerlingen van een specifieke ouder/verzorger	boolean
noSchoolInSchoolYear	gebruikers niet verbonden aan een roosterproject	boolean
removable	verwijderbare gebruikers	boolean
schoolYear	gebruikers verbonden aan een roosterproject in de opgegeven schooljaren	integer
type	gebruikers van het opgegeven type	string

Details

`archivable` boolean

archiveerbare gebruikers

`familyMember` boolean

leerlingen van een specifieke ouder/verzorger

`noSchoolInSchoolYear` boolean

gebruikers niet verbonden aan een roosterproject

`removable` boolean

verwijderbare gebruikers

`schoolYear` integer

gebruikers verbonden aan een roosterproject in de opgegeven schooljaren

`type` string

gebruikers van het opgegeven type

Datatypes

De meeste velden in de Zermelo API zijn basale types zoals string, long, of integer. Een aantal types heeft daarnaast nog een beperking op wat geldige waardes zijn. Bij sommige velden is de lege waarde null toegestaan, onafhankelijk van het onderliggende type.

Keyboard shortcuts

De Zermelo API

appointmentInstance long immutable

branchOfSchool long immutable

choosableInDepartmentCodes string[]

end timestamp verplicht bij aanmaken

groups string[]

locations string[]

start timestamp verplicht bij aanmaken

students string[]

subjects string[]

teachers string[]

type string verplicht bij aanmaken immutable

choosableInDepartments long[]

courses long[]

departmentsOfBranches long[]

groupsInDepartments long[]

locationsOfBranch long[]

onlineStudents string[]

onlineTeachers string[]

branch string verplicht bij aanmaken

schoolInSchoolYear long verplicht bij aanmaken immutable

code string verplicht bij aanmaken immutable

departmentOfBranch long verplicht bij aanmaken immutable

subject long verplicht bij aanmaken immutable

excludedSegments long[]

lessonHoursInClassPeriods json[]

`appointmentInstance` long immutable

`branchOfSchool` long immutable

`choosableInDepartmentCodes` string[]

`end` timestamp verplicht bij aanmaken

`groups` string[]

`locations` string[]

`start` timestamp verplicht bij aanmaken

`students` string[]

`subjects` string[]

`teachers` string[]

`type` string verplicht bij aanmaken immutable

`choosableInDepartments` long[]

`courses` long[]

`departmentsOfBranches` long[]

`groupsInDepartments` long[]

`locationsOfBranch` long[]

`onlineStudents` string[]

`onlineTeachers` string[]

`branch` string verplicht bij aanmaken

`schoolInSchoolYear` long verplicht bij aanmaken immutable

`code` string verplicht bij aanmaken immutable

`departmentOfBranch` long verplicht bij aanmaken immutable

`subject` long verplicht bij aanmaken immutable

`excludedSegments` long[]

`lessonHoursInClassPeriods` json[]