/appointments (Afspraakversies)
ondersteunde velden
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
ID
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=truemeegeven 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)