/o8d-api

Primary LanguagePHP

Planningstool Ouderavond

De afdeling ICT is een onderdeel van het MID college. Het MID College is één van de 12 Colleges van ROCMN. Op deze afdeling zitten ongeveer 350 studenten. 3-4 keer per jaar organiseert de afdeling een oudergespreksavond om ouders in de gelegenheid te stellen in gesprek te gaan met de studentcoach over de voortgang van de student.

De hoofzaak van de tool is dat ouders een uitnodiging krijgen met instructies. Vervolgens moeten zij op een webpagina een tijdstip kunnen kiezen voor het gesprek. Dit tijdstip moet achteraf gewijzigd kunnen worden door de ouders en docenten. Vervolgens moeten er diverse overzicht uitgedraaid kunnen worden zodat studentcoaches weten wie er wanneer verwacht wordt en in welk lokaal ze zitten.

Aan de slag

  • Installeer PHP;
  • Clone de repo naar je lokale machine;
  • In de "_config" folder, verander het bestand "config.example.php" naar "config.php";
  • Vul de juiste gegevens in.

Hoe het werkt

  1. Het begint allemaal bij "index.php" in de root folder. Hier wordt het bestand "bootstrap.php" ingeladen.
  2. "Bootstrap.php" laad alle benodigde bestanden in, zoals de database connectie, de routing, en eventuele hulp functies.
  3. De folder "routes" in de root folder van het project bevat het bestand waar je routes kan registreren. Door deze te registreren geef je aan welke pagina wordt ingeladen als de gebruiker naar een bepaalde route navigeerd.
  4. In de folder "pages" kan je pagina's plaatsen die worden geladen als de gebruiker naar de desbetreffende route navigeerd. Deze bestanden kunnen alle logica bevatten om de gewenste data naar de gebruiker te sturen.

Endpoints

Host: http://500309.student4a7.ao-ica.nl/

Routes:

  • /signin
    Beschrijving: Voor het inloggen van gebruikers.
    Request: POST
    Body: email, password

  • /signout
    Beschrijving: Voor het uitloggen van gebruikers.
    Request: POST
    Auth: token

  • /calendar/insert (WILL BE REPLACED)
    Beschrijving: Toevoegen van een calender item.
    Request: POST
    Auth: token
    Body: student_id, date, time, room

  • /calendar/delete (WILL BE REPLACED)
    Beschrijving: Verwijderen van een calender item.
    Request: POST
    Auth: token
    Body: id

  • /calendar/edit (WILL BE REPLACED)
    Beschrijving: Bewerken van een calender item.
    Request: POST
    Auth: token
    Body: student_id, date, time, room

  • /meeting/index
    Beschrijving: Tonen van ouderavonden.
    Request: POST
    Auth: token

  • /meeting/add
    Beschrijving: Registreren van een ouderavond.
    Request: POST
    Auth: token
    Body: date (yyyy-mm-dd), startTime (hh:mm:ss), endTime (hh:mm:ss), coach (userId), room

  • /meeting/addwithusers
    Beschrijving: Registreren van een ouderavond en linken van gebruikers aan ouderavond.
    Request: POST
    Auth: token
    Body: date (yyyy-mm-dd), startTime (hh:mm:ss), endTime (hh:mm:ss), coach (userId), room, users (json array met user id's: "[4,6,8,9]")

  • /meeting/cancel
    Beschrijving: Het annuleren van een ouderavond.
    Request: POST
    Auth: token
    Body: id

  • /block/add
    Beschrijving: Voor het toevoegen van een gebruiker aan een gesprek binnen een ouderavond.
    Request: POST
    Auth: token
    Body: meetingID, startTime (hh:mm:ss), endTime (hh:mm:ss)

  • /block/setUnavailable
    Beschrijving: Onbeschikbaar zetten van een gebruiker van een ouderavond.
    Request: POST
    Auth: token
    Body: id (meetingID)

  • /user/index
    Beschrijving: Ophalen van gebruikers.
    Request: POST
    Auth: token
    Optional GET: role (/?role=1)

  • /auth/tokencheck
    Beschrijving: Valideren van token.
    Request: POST
    Body: token

  • /auth/resetpassword
    Beschrijving: Opnieuw instellen van wachtwoord
    Request: POST
    Body: token, password, newPassword

  • /admin/createnewuser
    Beschrijving: Aanmaken van een nieuwe gebruiker.
    Request: POST
    Auth: token
    Body: email, password, firstname, insertion, lastname, role

  • /admin/createnewstudent
    Beschrijving: Aanmaken van een nieuw student.
    Request: POST
    Auth: token
    Body: firstname, insertion, lastname, studentNr, class, coach, parent

  • /admin/uploadstudents
    Beschrijving: Upload Csv bestand met studentgegevens en maak nieuwe studenten aan
    Request: POST
    Auth: token
    Body: firstname, insertion, lastname, studentNr, class

Laatste update: 18/05/2020 Om 22:36

Auteurs