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 uitWe introduceren hetchanged 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 uitOndersteuning 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 | ✅ | ❌ |
| cancelled | Uitval | boolean | ✅ | ✅ |
| changeDescription | Wijzigingen | string | ✅ | ✅ |
| content | Onderwerp van de afspraak | string | ✅ | ❌ |
| created | Aangemaakt | timestamp | ✅ | ✅ |
| end | Eindtijd | timestamp | ✅ | ✅ |
| endTimeSlotName | Laatste lesuur | string | ✅ | ✅ |
| groups | Groep | string[] | ✅ | ❌ |
| hidden | Verwijderd | boolean | ✅ | ✅ |
| id | ID | long | ✅ | ✅ |
| lastModified | Laatst gewijzigd | timestamp | ✅ | ❌ |
| locations | Lokalen | string[] | ✅ | ❌ |
| optional | Keuzeles | boolean | ✅ | ✅ |
| schedulerRemark | Opmerking van de roostermaker | string | ✅ | ✅ |
| start | Starttijd | timestamp | ✅ | ✅ |
| startTimeSlotName | Eerste lesuur | string | ✅ | ✅ |
| students | Leerlingen | string[] | ✅ | ❌ |
| subjects | Vak | string[] | ✅ | ✅ |
| teachers | Docent | long[] | ✅ | ✅ |
| type | Type | string | ✅ | ✅ |
| valid | Geldig | boolean | ✅ | ✅ |
Details
appointmentInstance long
Afspraak ID
appointmentLastModified timestamp
Laatst gewijzigd
cancelled boolean
Uitval
changeDescription string
Wijzigingen
content string
Onderwerp van de afspraak
created timestamp
Aangemaakt
end timestamp
Eindtijd
endTimeSlotName string
Laatste lesuur
groups string[]
Groep
hidden boolean
Verwijderd
id long
ID
lastModified timestamp
Laatst 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
Starttijd
startTimeSlotName string
Eerste lesuur
students string[]
Leerlingen
subjects string[]
Vak
teachers long[]
Docent
type string
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 |
| schoolInSchoolYear | afspraken in de opgegeven roosterprojecten | long |
Details
changed boolean
beperk tot afspraken met wijzigingen
fields string
opgevraagde velden
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 | ✅ | ✅ |
| branchOfSchool | Vestiging | integer | ✅ | ✅ |
| cancelledReason | Uitvalcategorie | string | ✅ | ❌ |
| capacity | Capaciteit (maximaal aantal deelnemers) | integer | ✅ | ❌ |
| capacityManually | Capaciteit (maximaal aantal deelnemers) handmatig? | boolean | ✅ | ❌ |
| choosableInDepartmentCodes | Vak-op-afdeling | string[] | ✅ | ❌ |
| choosableInDepartments | Vak-op-afdeling | long[] | ✅ | ✅ |
| courses | Course id’s | long[] | ✅ | ❌ |
| creator | Aangemaakt door | string | ✅ | ✅ |
| departmentsOfBranches | Afdeling | long[] | ✅ | ❌ |
| endTimeSlot | Laatste lesuur | integer | ✅ | ✅ |
| expectedStudentCount | Verwacht aantal leerlingen | integer | ✅ | ❌ |
| expectedStudentCountOnline | Verwacht aantal online leerlingen | integer | ✅ | ❌ |
| extraStudentSource | Extra leerlingbron | string | ✅ | ✅ |
| groupChanged | Groep gewijzigd | boolean | ✅ | ✅ |
| groupsInDepartments | Groep | long[] | ✅ | ✅ |
| ignoreSubstitutions | Vervangingen formatief negeren | boolean | ✅ | ✅ |
| locationChanged | Lokaal gewijzigd | 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 | ✅ | ❌ |
| startTimeSlot | Eerste lesuur | integer | ✅ | ✅ |
| teacherChanged | Docent gewijzigd | boolean | ✅ | ✅ |
| teachingTime | Onderwijstijd | integer | ✅ | ❌ |
| teachingTimeManually | Onderwijstijd handmatig? | boolean | ✅ | ❌ |
| timeChanged | Tijd gewijzigd | boolean | ✅ | ✅ |
| udmUUID | UDM UUID | uuid | ✅ | ❌ |
Details
alternativeSubject string
Vak
availableSpace integer
Aantal nog beschikbare plekken
base boolean
Niet gebruiken
branch string
Vestiging
branchOfSchool integer
Vestiging
cancelledReason string
Uitvalcategorie
mogelijke waardes: teachers, students, changedPlanning
capacity integer
Capaciteit (maximaal aantal deelnemers)
capacityManually boolean
Capaciteit (maximaal aantal deelnemers) handmatig?
choosableInDepartmentCodes string[]
Vak-op-afdeling
choosableInDepartments long[]
Vak-op-afdeling
courses long[]
Course id’s
creator string
Aangemaakt door
verwijst naar: users.code (Gebruikers)
departmentsOfBranches long[]
Afdeling
endTimeSlot integer
Laatste lesuur
bereik: [1,-]
expectedStudentCount integer
Verwacht aantal leerlingen
bereik: [0,-]
expectedStudentCountOnline integer
Verwacht aantal online leerlingen
bereik: [0,-]
extraStudentSource string
Extra leerlingbron
mogelijke waardes: departmentOfBranch, branchOfSchool
groupChanged boolean
Groep gewijzigd
groupsInDepartments long[]
Groep
ignoreSubstitutions boolean
Vervangingen formatief negeren
locationChanged boolean
Lokaal gewijzigd
locationsOfBranch long[]
Lokaal
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
startTimeSlot integer
Eerste lesuur
bereik: [1,-]
teacherChanged boolean
Docent gewijzigd
teachingTime integer
Onderwijstijd
bereik: [0,-]
teachingTimeManually boolean
Onderwijstijd handmatig?
timeChanged boolean
Tijd gewijzigd
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 |
| includeHidden | vraag ook verwijderde afspraakversies op | boolean |
| modifiedSince | afspraken met een wijziging (inclusief leerlingdeelname) sinds het opgegeven moment | timestamp |
| 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
containsStudentsFromGroupInDepartment long
afspraken waar een leerling van een van de opgegeven roostergroepen aan deel zou kunnen nemen
containsTeachersFromTeacherTeam long
afspraken met een docent van een van de opgegeven teams
departmentOfBranch long
afspraken met een vak of groep van de opgegeven 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
hasCreator boolean
persoonlijke afspraken aangemaakt door docenten
includeHidden boolean
vraag ook verwijderde afspraakversies op
modifiedSince timestamp
afspraken met een wijziging (inclusief leerlingdeelname) sinds het opgegeven moment
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
ondersteunde extra filters
niet-ondersteunde velden
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
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
niet-ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|
Details
niet-ondersteunde extra filters
| Filternaam | Omschrijving | Type |
|---|
Details
/contracts (Contracten)
ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|---|---|---|---|
| employee | Werknemerscode | string | ✅ | ✅ |
| id | ID | long | ✅ | ✅ |
| schoolInSchoolYear | Roosterproject | long | ✅ | ✅ |
Details
employee string
Werknemerscode
id long
ID
schoolInSchoolYear long
Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)
ondersteunde extra filters
niet-ondersteunde velden
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
Email
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 integer
Werkgeverslasten(%)
end datum
Eind
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
Vast
fteTemporary float
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
start datum
Start
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
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
sectionOfBranch long
beperk tot contracten met uren binnen de opgegeven sectie op een vestiging
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
departmentCode string
Afdeling
educationTypes string[]
Opleidingstypes
groupName string
Groepsnaam
id long
ID
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
Vestiging
verwijst naar: branchesofschools.id (Vestigingen in project)
code string
Code / naam
id long
ID
schoolInSchoolYear long
Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)
ondersteunde extra filters
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
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
Afwezigheidstype
mogelijke waardes: 0, 1, 2, 3, 4, 5, 6, 7
absenceTypeCode string
Afwezigheidstype
absenceTypePriority integer
Afwezigheidstype prioriteit
contract long
Contract ID
created timestamp
Aangemaakt
definitive boolean
Definitive
employee string
Werknemerscode
end timestamp
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
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
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 | ✅ | ✅ |
| 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
Email
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
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
niet-ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|---|---|---|---|
| city | Plaats | string | ✅ | ❌ |
| dateOfBirth | Geboortedatum | datum | ✅ | ❌ |
| gender | Geslacht | string | ✅ | ❌ |
| houseNumber | Huisnummer | string | ✅ | ❌ |
| postalCode | Postcode | string | ✅ | ❌ |
| street | Straat | string | ✅ | ❌ |
Details
city string
Plaats
dateOfBirth datum
Geboortedatum
gender string
Geslacht
mogelijke waardes: f, m
houseNumber string
Huisnummer
postalCode string
Postcode
street string
Straat
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
/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
week week
Week
ondersteunde extra filters
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
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
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
niet-ondersteunde extra filters
| Filternaam | Omschrijving | Type |
|---|
Details
/familymembers (Ouders/verzorgers)
ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|---|---|---|---|
| string | ✅ | ❌ | ||
| firstName | Voornaam | string | ✅ | ❌ |
| lastName | Achternaam | string | ✅ | ❌ |
| prefix | Tussenvoegsel | string | ✅ | ❌ |
| students | Kinderen | string[] | ✅ | ✅ |
| userCode | Gebruiker | string | ✅ | ✅ |
Details
email string
Email
firstName string
Voornaam
lastName string
Achternaam
prefix string
Tussenvoegsel
students string[]
Kinderen
userCode string
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
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
/groupindepartments (Roostergroepen)
ondersteunde velden
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
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
Afdeling
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)
name string
Naam
studentInDepartments long[]
Leerlingen
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
Eind
extra details: Laatste dag van de vakantie
id long
ID
name string
Naam
extra details: Naam van de vakantie
schoolInSchoolYear long
Roosterproject
extra details: Roosterproject waar de vakantie bij hoort
start datum
Start
extra details: Eerste dag van de vakantie
ondersteunde extra filters
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 | ✅ | ❌ |
| fte | WTF jaarequivalent | float | ✅ | ✅ |
| fteReal | WTF | float | ✅ | ✅ |
| functionCategory | Functiecategorie | string | ✅ | ❌ |
| id | id | long | ✅ | ✅ |
| lastModified | Laatst gewijzigd | timestamp | ✅ | ✅ |
| lastModifiedBy | Laatst gewijzigd door | string | ✅ | ✅ |
Details
contract long
Werknemerscode
verwijst naar: contracts.id (Contracten)
created timestamp
Aangemaakt
durationManually boolean
Duur handmatig?
employmentType string
Dienstverband
mogelijke waardes: vast, tijdelijk
fte float
WTF jaarequivalent
bereik: [0,-]
fteReal float
WTF
bereik: [0,-]
functionCategory string
Functiecategorie
mogelijke waardes: OP, OOP, DIR
id long
id
lastModified timestamp
Laatst gewijzigd
lastModifiedBy string
Laatst gewijzigd door
verwijst naar: users.code (Gebruikers)
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 | ✅ | ❌ |
| end | Eind | datum | ✅ | ✅ |
| 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 | ✅ | ✅ |
| start | Start | datum | ✅ | ✅ |
| 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
employerCost long
Indicatie werkgeverskosten
end datum
Eind
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
start datum
Start
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 |
|---|---|---|---|---|
| branchOfSchool | Hoofdvestiging | integer | ✅ | ✅ |
| id | ID | long | ✅ | ✅ |
| name | Naam | string | ✅ | ✅ |
| schoolInSchoolYear | Roosterproject | integer | ✅ | ✅ |
Details
branchOfSchool integer
Hoofdvestiging
verwijst naar: branchesofschools.id (Vestigingen in project)
id long
ID
name string
Naam
schoolInSchoolYear integer
Roosterproject
ondersteunde extra filters
niet-ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|---|---|---|---|
| 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
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
/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
ID
name string
Roosterproject Portal
school long
School
year integer
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 | long |
| 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 long
beperk tot roosterprojecten met daarin de gegeven vestiging
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
/studentsindepartments (Afdelingsdeelnames)
ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|---|---|---|---|
| id | Id | long | ✅ | ✅ |
| schoolInSchoolYear | Roosterproject | long | ✅ | ✅ |
| student | Leerlingcode | string | ✅ | ✅ |
Details
id long
Id
schoolInSchoolYear long
Roosterproject
verwijst naar: schoolsinschoolyears.id (Roosterprojecten)
student string
Leerlingcode
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
Details
deanApprovesSelection boolean
Akkoord door decaan
departmentOfBranch long
Afdeling
verwijst naar: departmentsofbranches.id (Afdelingen)
departmentOfBranchCode string
Afdelingnaam
educationalTrack long
Leerpad
educations long[]
Opleiding
email string
Email
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
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 roostergroep 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 |
| studentMayView | beperk tot afdelingsdeelnames die de leerling zelf mag zien | boolean |
| teacherTeam | beperk tot afdelingsdeelnames van leerlingen op een afdeling van het opgeven team | long |
Details
departmentOfBranchPreviousYear long
beperk tot afdelingsdeelnames van leerlingen die vorig jaar deelnamen op de opgegeven afdeling
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 roostergroep van vorig jaar zaten
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
schoolYear long
beperk tot afdelingsdeelnames in het opgegeven schooljaar
studentMayView boolean
beperk tot afdelingsdeelnames die de leerling zelf mag zien
teacherTeam long
beperk tot afdelingsdeelnames van leerlingen op een afdeling van het opgeven team
/users (Gebruikers)
ondersteunde velden
| Veldnaam | Titel | Type | Lezen | Filteren |
|---|---|---|---|---|
| code | Gebruikerscode | string | ✅ | ✅ |
| string | ✅ | ✅ | ||
| firstName | Voornaam | string | ✅ | ✅ |
| lastName | Achternaam | string | ✅ | ✅ |
| prefix | Tussenvoegsel | string | ✅ | ✅ |
Details
code string
Gebruikerscode
email string
Email
firstName string
Voornaam
lastName string
Achternaam
prefix string
Tussenvoegsel
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 | ✅ | ✅ |
| isBranchLeader | Niet gebruiken | 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 | ✅ | ✅ |
| magisterUUID | Magister UUID | uuid | ✅ | ✅ |
| 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[] | ✅ | ❌ |
| somUUID | Somtoday UUID | uuid | ✅ | ✅ |
| 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
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
WW
houseNumber string
Huisnummer
isApplicationManager boolean
Admin
isBranchLeader boolean
Niet gebruiken
isDean boolean
Niet gebruiken
isEmployee boolean
Wn
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.
magisterUUID uuid
Magister UUID
mayLogin boolean
Mag de gebruiker inloggen?
parentTeacherNightOfFamilyIds long[]
Ouderavonden waaraan de gebruiker als ouder verbonden is
parentTeacherNightOfTeacherIds long[]
Ouderavonden waaraan de gebruiker als werknemer verbonden is
password string
Wachtwoord
postalCode string
Postcode
roles string[]
Rollen
schoolInSchoolYears long[]
Actieve projecten
somUUID uuid
Somtoday UUID
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.
boolean
true of false.
datum
Een datum van de vorm jjjjmmdd.
float
Een decimaal getal.
html
Een string die geldige HTML bevat.
integer
Een 32-bit geheel getal.
week
Een ISO-week van de vorm jjjjww. Let op dat ISO-week jaren niet altijd gelijk zijn aan het kalenderjaar. Zo valt de datum 20251231 in ISO-week 202601.
json
Een string die geldige JSON bevat.
long
Een 64-bit geheel getal.
string
Een string.
timestamp
Een UNIX timestamp.
uuid
Een UUID.