Servertjenester - ScrumTeam2/MinVakt GitHub Wiki
I dette dokumentet er alle REST-ressursene beskrevet. REST-endpointene kunne ha vært mer RESTful ved å gjøre om en del POST-kall til PUT- og DELETE-kall. Parametre og return er med i javadoc.
| Service | URI | Metode | Beskrivelse | Rettighet |
|---|---|---|---|---|
| Availability | /availability/user | GET | Returnerer alle tilgjengelige vakter for egen bruker | Bruker |
| Availability | /availability/setAvailable | POST | Setter tilgjengelige datoer(shifts) for en bruker | Bruker |
| Availability | /availability/date | GET | Returnerer vakter for en bruker gitt dato | Bruker |
| Availability | /availability/deleteAvailable | POST | Setter valgte datoer for tilgjengelighet som ikke tilgjengelig | Bruker |
| Availability | /availability/shift/{shiftid} | GET | Returnerer tilgjengelige brukere for en shift | Admin |
| Department | /department | GET | Returnerer liste med avdelinger | Bruker |
| Department | /department/{deptId} | GET | Returnerer avdelingsnavn gitt avdelings ID | Bruker |
| Department | /department/withData | GET | Returnerer liste med avdelinger og generell informasjon om avdelingens relasjon til brukeren | Bruker |
| NewsFeed | /newsfeed | GET | Returnerer liste med notifikasjoner fra nyhetsfeeden med relevant informasjon for admin eller ansatt | Bruker og Admin |
| NewsFeed | /newsfeed/{feedid} | POST | Oppdaterer nyhetsfeeden med notifikasjoner for gitt brukerID, og hvilken kategori feed-elementet tilhører | Bruker og Admin |
| Overtime | /overtime/ | POST | Registrer overtid for bruker. Dersom bruker ikke er admin, brukes session userID for å hente bruker ID. | Bruker og Admin |
| Overtime | /overtime/ | GET | Returnerer overtid for en bruker | Bruker |
| Overtime | /overtime/shiftId/{shitId} | GET | Returnerer liste med registrerte overtider relatert til en vakt | Bruker |
| Overtime | /overtime | DELETE | Sletter overtid for en bruker. Metoden brukes kun i testklasse. | Bruker |
| SecureService | Har ansvar for å verifisere en session | Bruker og Admin | ||
| SessionService | /session/login | POST | Sjekker om session eksisterer. Dersom ikke, forsøk å opprett ny session om brukernavn og passord er riktig. | Bruker |
| SessionService | /session/check | GET | Sjekker om brukeren fortsatt er pålogget | Bruker |
| SessionService | /session/log_out | GET | Logger ut brukeren | Bruker |
| ShiftPlan | /shiftplan | POST | Genererer turnus for gitt startdato | Admin |
| ShiftPlan | /shiftplan/approve | POST | Setter gitte vaktID som godkjent | Admin |
| Shift | /shift | POST | Oppretter ny vakt gitt vaktobjekt | Admin |
| Shift | /shift | GET | Returnerer liste med vakter og informasjon om vakten for en bruker, gitt dato og antall dager fram i tid fra spesifisert dato | Bruker |
| Shift | /shift/shiftsAvailablity | GET | Returnerer liste med vakter og informasjon om vakten - med unntak av avdeling - for en bruker, gitt dato og antall dager fram i tid fra spesifisert dato | Bruker |
| Shift | /shift/{shiftId} | DELETE | Eliminerer en vakt gitt vaktID | Admin |
| Shift | /shift/{shiftId} | GET | Returnerer vaktobjekt for en gitt vaktID | Bruker |
| Shift | /shift/{shiftId}/user/{userId} | POST | Legger til ansatt på en vakt gitt vaktID | Admin |
| Shift | /shift/{shiftId}/user/{userId} | DELETE | Fjerner en ansatt fra en vakt gitt vaktID | Admin |
| Shift | /shift/{shiftId}/replaceuser | POST | Bytter mellom to ansatte for en gitt vakt | Admin |
| Shift | /shift/{shiftId}/set_staff | POST | Setter antall ansatte en shift skal ha | Admin |
| Shift | /shift/user | GET | Returnerer vakter på en spesifikk dag for en bruker | Bruker |
| Shift | /shift/user/{userid} | GET | Returnerer liste med vakter for en bruker | Admin |
| Shift | /shift/availableShifts | GET | Returnerer liste med alle vakter som ikke nok ansatte | Admin |
| Shift | /shift/user/valid_absence/{shiftId} | GET | Registrerer fravær for en vakt. Sender notifikasjoner til relevante brukere. | Bruker |
| Shift | /shift/user/shift_change/{shiftId} | GET | Registrerer vaktbytte for en vakt. Sender notifikasjoner til relevante brukere/administrator. | Bruker |
| UserAdmin | /admin/createuser | POST | Oppretter en ny bruker | Admin |
| UserAdmin | /admin/edituser | POST | Endrer brukerinformasjon for en gitt bruker | Admin |
| UserAdmin | /admin/deleteuser/{userId} | DELETE | Sletter en gitt bruker | Admin |
| UserService | /user | GET | Returnerer liste med brukere | Bruker |
| UserService | /user/category | GET | Returnerer brukere for en gitt kategori | Bruker |
| UserService | /user/{userId} | GET | Returnerer brukerobjekt gitt brukerID | Bruker |
| UserService | /user/changepass | POST | Endre passord for en bruker | Bruker |
| UserService | /user/forgottenpass | POST | Tilbakestille glemt passord Gitt e-post for en bruker. Sender nytt passord på e-post | Bruker |
| UserService | /user/edituser | POST | Endre brukerinformasjon for bruker som kaller på denne metoden. | Bruker |
| UserService | /user/profile | GET | Returnerer brukerinformasjon fra session | Bruker |