Versie 2025.03

SDFLEX - A A R

Introductie

AAR staat voor Aan- en Af-wezigheidsregistratie. De AAR gegevens laten zien of je vaak op school aanwezig was. Bij SD-Flex maken de docenten een AAR-overzicht per week. Deze api stelt je in staat je eigen aanwezigheidspercentage op te vragen.

Het percentage laat zien hoeveel procent van je rooster je daadwerkelijk in het lokaal aanwezig bent geregistreerd. Bij het bepalen van het percentage gaan we uit van de kale tijd dat je daadwerkelijk in het lokaal zat zonder rekening te houden met geoorloofd verzuim zoals ziekte of afspraken buiten school. Het kan dus voorkomen dat een lage percentage verklaard kan worden door geoorloofde absentie.

Lesuitval veroorzaakt door Deltion is meegenomen in het rooster en daarmee in het getoonde percentage.

De gegevens in deze api gebruiken de docenten van de SD-Flex opleiding tijdens je voortgangsgesprekken.

Benodigdheden

Om je AAR-gegevens op te vragen heb je drie ids nodig:

• student-id: Een unieke student-id (niet je studentnummer) die je bij je docenten kunt opvragen.
• api-id: Een unieke api-id. Je kunt deze opvragen met het getapiid-commando.
• personal-id: Deze moet je zelf instellen via de api.

Hou je student-id en pesonal-id privé als je niet wilt dat derden je aar-gegevens kunnen opvragen. Je personal-id stel je zelf in. De overige id's worden voor je bepaald.

Procedure

Om de AAR-api te gebruiken volg je de volgende procedure:

1. Vraag aan je docent je persoonlijke student-id. Dit student-id wordt door de docenten bepaald en verandert gedurende je tijd op de opleiding niet.

   Je hoeft je student-id maar eenmalig op te vragen.

2. Vraag het api-id op via de api.

   Het api-id kan door de docenten zonder melding vooraf gewijzigd worden. Mocht de api geen gegevens meer leveren, controleer dan eerst of het api-id gewijzigd is. Als deze gewijzigd is, vraag dan je gegevens op met het nieuw api-id.

   Zie de handleiding voor uitleg hoe je het api-id opvraagt.

3. Stel je eigen personal-id samen uit letters, cijfers en het min-teken. Het personal-id is maximaal 37 tekens lang, maar mag korter zijn. De minimum lengte is 5 tekens.

4. Sla je personal-id op in de api. Je hoeft een personal-id maar één keer op te slaan. Je personal-id kun je daarna gebruiken voor alle api-calls.

   Je kunt op ieder gewenst moment je personal-id opnieuw instellen. Het is niet mogelijk om je huidige actieve personal-id op te vragen.

   Zie de handleiding voor uitleg hoe jij je personal-id in de api opslaat.

5. Vraag je AAR-gegevens op via de api.

   Zie de handleiding voor uitleg hoe jij je aar-gegevens via de api opvraagt.

Handleiding

Voor het gebruik van de api heb je drie id's nodig:

• student-id
• api-id
• personal-id

In onderstaande syntaxvoorbeelden vul je voor url de daadwerkelijke url van deze website in. In de voorbeelden vervang je de strings student-id, api-id en personal-id voor de daadwerkelijke id's.

* Vraag AAR gegevens op

Syntax : https://url/aar.php?getaar&student=student-id&api=api-id&personal=personal-id

Gebruik het getaar-commando om je persoonlijke aar-gegevens op te halen. De api heeft de volgende gegevens nodig om je aar-gegevens te tonen.

• student-id: Een unieke student-id (niet je studentnummer) die je bij je docenten kunt opvragen.
• api-id: Een unieke api-id. Je kunt deze opvragen met het getapiid commando.
• personal-id: Deze stel je zelf in via de api.
  Lees verder in de handleiding hoe je dit doet.

* Laat help-pagina zien

Syntax : https://url/aar.php?help

Laat deze help pagina zien.

* Vraag student-id op

Ga naar een docent en vraag om je student-id.

* Vraag api-id op

Syntax: https://url/aar.php?getapiid

Het getapiid-commando laat de api-id zien. Je hebt dit id nodig voor het ophalen van je aar-gegevens.

De api-id wordt door de docenten bepaald en kan zonder aankondiging gewijzigd worden. Mocht de API onverwachts geen gevens meer tonen, controleer dan eens of de api-id gewijzigd is.

* Stel je personal-id in

Syntax: https://url/aar.php?setpersonal=personal-id&student=student-id&api=api-id

Om je personal-id in te stellen heb je de volgende gegevens nodig:

• student-id: Een unieke student-id (niet je studentnummer) die je bij je docenten kunt opvragen.
• api-id: Een unieke api-id. Je kunt deze opvragen met het getapiid commando.
• personal-id: Deze moet je zelf instellen via de api.
  personal-id is een string die je zelf bepaalt. Deze mag alleen uit letter, cijfers en het min-teken(-) bestaan.

Je personal-id is een string die je zelf bepaalt. Deze personal-id mag alleen uit letters (hoofdletter-gevoelig), cijfers en het min-teken bestaan. Verder is het personal-id niet langer dan 37 tekens.

MIT License

Copyright (c) 2025 SD Flex

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.