Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/students (Leerlingen)

ondersteunde velden

VeldnaamTitelTypeLezenFilteren
emailEmailstring✅❌
familyMembersOudersstring[]✅✅
firstNameVoornaamstring✅❌
lastNameAchternaamstring✅❌
prefixTussenvoegselstring✅❌
userCodeLeerlingcodestring✅✅
Details

email string

Email


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

FilternaamOmschrijvingType
fieldsopgevraagde veldenstring
schoolInSchoolYearbeperk tot leerlingen binnen een roosterprojectlong[]
Details

fields string

opgevraagde velden


schoolInSchoolYear long[]

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

niet-ondersteunde velden

VeldnaamTitelTypeLezenFilteren
cityPlaatsstring✅❌
dateOfBirthGeboortedatumdatum✅❌
genderGeslachtstring✅❌
houseNumberHuisnummerstring✅❌
individualRequestsParentsAparte gesprekken oudersboolean✅✅
intakeProjectsInstroomprojectenlong[]✅✅
lwooLWOOboolean✅✅
nonarchivedFamilyMembersNiet-gearchiveerde oudersstring[]✅❌
postalCodePostcodestring✅❌
streetStraatstring✅❌
studentInDepartmentsAfdelingsdeelnamesjson[]✅✅
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

FilternaamOmschrijvingType
archivedbeperk tot leerlingen die niet gearchiveerd zijnboolean
departmentOfBranchbeperk tot leerlingen binnen een afdelinglong[]
groupInDepartmentsbeperk tot leerlingen binnen een roostergroeplong[]
placedIntakeForProjectbeperk tot geplaatste instroomleerlingen voor het projectlong
possibleIntakeForProjectbeperk tot instroomleerlingen voor het projectlong
unplacedIntakeForSchoolYearbeperk tot nog ongeplaatste instroomleerlingen voor het schooljaarinteger
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