Exemples d'utilisation d'Open API

Exemple 1

La méthode renvoie une erreur ou un lien permettant à l'utilisateur d'accéder au portail utilisateur si l'utilisateur a déjà commencé une formation.

Si un lien est renvoyé, il doit être affiché à l'utilisateur, et aucune autre méthode n'est appelée.

Dans tous les autres cas, une erreur est renvoyée avec différents codes. La liste des codes disponibles est décrite dans Swagger comme dans la documentation en ligne.

Si l'erreur « 404 user-not-found » s'affiche, la méthode n° 2 est appelée.

Toute erreur présentant le code 422 indique que le plan de formation est en cours de calcul et que le lien arrivera bientôt. Si cela ne se produit pas, vous devez contacter l'administrateur du compte pour lequel ASAP a émis le jeton API.

Exemple 2

À ce stade, nous obtenons la liste des groupes auxquels l'utilisateur peut s'ajouter. Une fois que la méthode a reçu la liste, elle doit être filtrée pour n'afficher que les groupes pour lesquels le paramètre isStarted présente la valeur « true ».

La formation commence uniquement dans ces groupes, et l'utilisateur ne peut se joindre qu'à ces groupes.

Si ces groupes n'existent pas, l'erreur « 404 groups-not-found » s'affiche. Dans ce cas, vous devez contacter l'administrateur du compte pour lequel ASAP a émis le jeton API.

Exemple 3

Une fois qu'un groupe a été sélectionné, les données personnelles et un identifiant de groupe sont transmis à la méthode n° 3. Le résultat est soit une erreur, soit une réponse 201 avec l'identifiant de l'utilisateur ajouté. Dans le cas d'une erreur, vous devez contacter l'administrateur du compte pour lequel ASAP a émis le jeton API.

Exemple 4

Pour recevoir les données des rapports sur la formation des employés :

1. Adresse email utilisée pour enregistrer l'utilisateur.
2. Nom court enregistré de l'utilisateur.
3. Nom complet enregistré de l'utilisateur.
4. Groupe de formation actuel de l'utilisateur.
5. Durée de la formation en secondes.
6. Catégorie de performance pour la formation principale.
7. Catégorie de performance pour la formation express.
8. État actuel de la formation.
9. Progression en pourcentage dans la formation principale dans le format xx.xx.
10. Progression en pourcentage dans la formation express dans le format xx.xx.
11. Date prévue d'achèvement de la formation principale.
12. Date prévue d'achèvement de la formation express.
13. Date d'achèvement de la formation principale.
14. Date d'achèvement de la formation principale.
15. Formations et état des formations pour la formation principale.
16. Formations et état des formations pour la formation express.
17. Date de la dernière activité, dans un format qui dépend de la langue de localisation de saisie.
18. Le nombre total de certificats reçus par l'utilisateur pendant la formation.

Exemple 5

Pour déplacer les utilisateurs entre les groupes et créer des données de groupe de formation pour chaque employé de l'entreprise :

1. groupe de formation actuel
2. groupe de formation précédent.

Exemple 6

Suppression d'un employé du système ASAP.