Functions GroupResources

Die GroupResource dient dazu, Benutzergruppen anzulegen, abzurufen und Benutzern Gruppen zuzuweisen. Ein Benutzer kann dabei auch mehreren Gruppen zugewiesen werden.

Funktion 1: Gruppe anlegen

Vorbedingungen:

• Ein anlegender Benutzer ist eingeloggt und er hat die Rechte zum Anlegen einer Gruppe

1. Der Benutzer sendet eine POST-Anfrage an (/smartuser/group)
   • Body: JSON-Daten der neuen Gruppe
   • Die Gruppe wird in der Datenbank angelegt
   • Antwort mit Status 201 Created

Ausnahmen: ~~1. Der Benutzer hat nicht die erforderlichen Rechte

• Die Schnittstelle antwortet mit Statuscode 403 (Unauthorised)~~

Funktion 2: Gruppen auflisten

Vorbedingungen: * Der Anfragende Benutzer hat das Recht "group/list"

1. Liste abfragen
   • Bei Aufruf der REST-Schnittstelle (http://localhost:8080/SmartUser/smartuser/group) wird ein JSON mit allen Gruppen zurückgegeben.

Ausnahmen:

1. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
   • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception ~~2. Der Benutzer hat nicht das Recht
   • Der Server antwortet mit Statuscode 403~~ ~~3. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
   • Der Server antwortet mit Statuscode 401~~

Funktion 3: Eine Gruppe abrufen

Vorbedingungen:

• Der Anfragende Benutzer hat das Recht "group/get" oder er fragt seine eigenen Gruppen ab

1. Liste abfragen
   • Bei Aufruf der REST-Schnittstelle (http://localhost:8080/SmartUser/smartuser/group/(ID) wird ein JSON mit den Daten der Gruppe zurückgegeben.

Ausnahmen:

1. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
   • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception ~~2. Der Benutzer hat nicht das Recht
   • Der Server antwortet mit Statuscode 403~~ ~~3. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
   • Der Server antwortet mit Statuscode 401~~

Funktion 4: Eine Gruppe nach ihrem Namen abrufen

Vorbedingungen:

• Der Anfragende Benutzer hat das Recht "group/getByName" oder er fragt seine eigenen Gruppen ab

1. Liste abfragen
   • Bei Aufruf der REST-Schnittstelle (http://localhost:8080/SmartUser/smartuser/group/getByName/(Name) wird ein JSON mit den Daten der Gruppe zurückgegeben.

Ausnahmen:

1. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
   • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception ~~2. Der Benutzer hat nicht das Recht
   • Der Server antwortet mit Statuscode 403~~ ~~3. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
   • Der Server antwortet mit Statuscode 401~~

Funktion 5: Alle Gruppen eines Benutzers auflisten

Vorbedingungen:

• Der anfragende Benutzer hat das Recht "group/getByUser" oder er fragt seine eigenen Gruppen ab

1. Liste abfragen
   • Bei Aufruf der REST-Schnittstelle (http://localhost:8080/SmartUser/smartuser/group/getByUserId/(Id) wird ein JSON mit den Daten der Gruppe zurückgegeben.

Ausnahmen:

1. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
   • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception ~~2. Der Benutzer hat nicht das Recht
   • Der Server antwortet mit Statuscode 403~~ ~~3. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
   • Der Server antwortet mit Statuscode 401~~

Funktion 6: Alle Benutzer einer Gruppe auflisten

Vorbedingungen:

• Der anfragende Benutzer hat das Recht "group/getMembersByGroupId" oder er fragt seine eigenen Gruppen ab

1. Liste abfragen
   • Bei Aufruf der REST-Schnittstelle (http://localhost:8080/SmartUser/smartuser/group/getMembersByGroupId/(Id) wird ein JSON mit den Daten der Gruppe zurückgegeben.

Ausnahmen:

1. Es tritt ein Fehler beim Abfragen der Benutzerliste auf
   • Die Schnittstelle antwortet mit Statuscode 500 und der Meldung der Exception ~~2. Der Benutzer hat nicht das Recht
   • Der Server antwortet mit Statuscode 403~~ ~~3. Die Anfrage wird ohne vorherige Anmeldung ausgeführt
   • Der Server antwortet mit Statuscode 401~~

Funktion 7: Einen Benutzer einer Gruppe zuordnen

Vorbedingungen:

• Ein anlegender Benutzer ist eingeloggt

1. Der Benutzer sendet eine POST-Anfrage an (/smartuser/group)
   • Parameter: userId und code (Code aus der Gruppe)
   • Der Benutzer wird in der Datenbank angelegt
   • Antwort mit Status 201 Created

Ausnahmen:

Funktion 8: Eine Gruppe aktualisieren

Vorbedingungen:

• Der Benutzer ist eingeloggt

1. Der Benutzer sendet eine PUT-Anfrage an (/smartuser/group)
   • Body: Daten der Gruppe
   • Die Gruppe wird in der Datenbank aktualisiert
   • Antwort mit Status 200 OK

Ausnahmen:

Funktion 9: Eine Gruppe löschen

Vorbedingungen:

• Der Benutzer ist eingeloggt

1. Der Benutzer sendet eine DELETE-Anfrage an (/smartuser/group({id})
   • Die Gruppe wird aus der Datenbank gelöscht
   • Antwort mit Status 200 OK

Ausnahmen: