Esempi di utilizzo di Open API

Esempio 1

Il metodo restituisce un errore o un link per consentire all'utente di accedere al portale degli utenti se l'utente ha già avviato la formazione.

Se viene restituito un link, dovrebbe essere mostrato all'utente e non vengono effettuate ulteriori chiamate al metodo.

In tutti gli altri casi viene restituito un errore con vari codici. L'elenco dei codici disponibili è descritto in Swagger come nella documentazione online.

Se viene ricevuto un errore "404 utente non trovato", viene richiamato il metodo n. 2

Qualsiasi errore con il codice 422 indica che il piano di studio è attualmente in fase di calcolo e il link sarà disponibile a breve. In caso contrario, devi contattare l'amministratore dell'account per il quale ASAP ha emesso il token API.

Esempio 2

A questo punto, otteniamo l'elenco dei gruppi a cui l'utente può aggiungersi. Dopo che il metodo riceve l'elenco, deve essere filtrato in modo da mostrare solo i gruppi per i quali il parametro isStarted ha il valore "true".

Solo in questi gruppi è iniziata la formazione e l'utente può unirsi solo a tali gruppi.

Se tali gruppi non sono presenti, viene restituito l'errore "404 gruppi non trovati". In questo caso, devi contattare l'amministratore dell'account per il quale ASAP ha emesso il token API.

Esempio 3

Dopo aver selezionato un gruppo, i dati personali e l'identificativo del gruppo vengono trasmessi al metodo n. 3 Il risultato è un errore o una risposta 201 con l'identificativo dell'utente aggiunto. In questo caso di errore, devi contattare l'amministratore dell'account per il quale ASAP ha emesso il token API.

Esempio 4

Per ricevere i dati del rapporto sulla formazione dei dipendenti:

1. Indirizzo e-mail utilizzato per registrare l'utente.
2. Nome registrato dell'utente.
3. Nome e cognome registrati dell'utente.
4. Gruppo di formazione corrente dell'utente.
5. Durata della formazione in secondi.
6. Categoria di rendimento per il corso principale.
7. Categoria di rendimento per il corso rapido.
8. Stato attuale della formazione.
9. Avanzamento della formazione nel corso principale in percentuale nel formato xx.xx.
10. Avanzamento della formazione nel corso rapido in percentuale nel formato xx.xx.
11. Data prevista per il completamento del corso principale.
12. Data prevista di completamento del corso rapido.
13. Data di completamento del corso principale.
14. Data di completamento del corso principale.
15. Corsi di formazione e stato della formazione per il corso principale.
16. Corsi di formazione e stato della formazione per il corso rapido.
17. Data dell'ultima attività, in un formato che varia in base alla lingua di localizzazione dell'input.
18. Il numero totale di attestati ricevuti dall'utente durante la formazione.

Esempio 5

Per spostare gli utenti tra i gruppi e creare i dati del gruppo di formazione per ciascun dipendente dell'azienda:

1. Gruppo di formazione attuale.
2. Gruppo di formazione precedente.

Esempio 6

Eliminazione di un dipendente dal sistema ASAP.