Beispiele zur Verwendung von Open API

Beispiel 1

Die Methode gibt entweder einen Fehler oder einen Link für den Benutzer zurück, mit dem er auf das Benutzerportal zugreifen kann, falls der Benutzer bereits mit dem Training begonnen hat.

Wenn ein Link zurückgegeben wird, muss er dem Benutzer angezeigt werden und es werden keine weiteren Methodenaufrufe ausgeführt.

In allen anderen Fällen wird ein Fehler mit verschiedenen Codes zurückgegeben. Die Liste der verfügbaren Codes wird wie in der Online-Dokumentation in Swagger beschrieben.

Wenn ein „404 Benutzer nicht gefunden“-Fehler erhalten wird, wird Methode Nr. 2 aufgerufen.

Jeder Fehler mit Code 422 bedeutet, dass der Trainingsplan derzeit berechnet wird und der Link demnächst zur Verfügung stehen wird. Wenn dies nicht der Fall ist, sollten Sie den Administrator des Kontos kontaktieren, für das ASAP den API-Token ausgestellt hat.

Beispiel 2

In dieser Phase erhalten wir die Liste von Gruppen, zu denen sich der Benutzer selbst hinzufügen kann. Nachdem die Methode die Liste erhalten hat, muss sie gefiltert werden, damit nur jene Gruppen angezeigt werden, für die der Parameter isStarted den Wert „Wahr“ aufweist.

Nur in diesen Gruppen hat die Schulung begonnen, und der Benutzer kann nur diesen Gruppen beitreten.

Wenn es keine solchen Gruppen gibt, wird der Fehler „404 Gruppen nicht gefunden“ zurückgegeben. In diesem Fall sollten Sie den Administrator des Kontos kontaktieren, für das ASAP den API-Token ausgestellt hat.

Beispiel 3

Nachdem eine Gruppe ausgewählt wurde, werden persönliche Daten und eine Gruppenkennung an die Methode Nr. 3 weitergegeben. Das Ergebnis ist entweder ein Fehler oder eine 201-Antwort mit der ID des hinzugefügten Benutzers. Im Fall eines Fehlers sollten Sie den Administrator des Kontos kontaktieren, für das ASAP den API-Token ausgestellt hat.

Beispiel 4

So erhalten Sie Berichtsdaten über Mitarbeiterschulungen:

1. E-Mail-Adresse, die zur Registrierung des Benutzers verwendet wurde.
2. Registrierter Kurzname des Benutzers.
3. Registrierter vollständiger Name des Benutzers.
4. Aktuelle Trainingsgruppe des Benutzers.
5. Dauer der Schulung in Sekunden.
6. Leistungskategorie für den Hauptkurs.
7. Leistungskategorie für den Intensivkurs.
8. Aktueller Trainingsstatus.
9. Trainingsfortschritt im Hauptkurs als Prozentsatz im Format xx,xx.
10. Trainingsfortschritt im Intensivkurs als Prozentsatz im Format xx,xx.
11. Erwartetes Abschlussdatum für den Hauptkurs.
12. Erwartetes Abschlussdatum für den Intensivkurs.
13. Abschlussdatum für Hauptkurs.
14. Abschlussdatum für Hauptkurs.
15. Trainingskurse und Trainingsstatus für den Hauptkurs.
16. Trainingskurse und Trainingsstatus für den Intensivkurs.
17. Datum der letzten Aktivität, in einem Format, das von der eingegebenen Lokalisierungssprache abhängt.
18. Die Gesamtzahl der Zertifikate, die der Benutzer während der Schulung erhalten hat.

Beispiel 5

So bewegen Sie Benutzer zwischen Gruppen und erstellen Trainingsgruppendaten für jeden Mitarbeiter des Unternehmens:

1. Aktuelle Trainingsgruppe
2. Vorherige Trainingsgruppe

Beispiel 6

Mitarbeiter aus dem ASAP-System löschen.