Metodo "POST /openapi/v1/report"

Genera i dati dei rapporti sugli utenti che sono registrati sul portale e stanno completando la formazione sui programmi ASAP.

La dimensione dei dati trasmessi è descritta nel corpo della richiesta.

Richiesta

Intestazione:

• Autorizzazione: token API dell'azienda.

Corpo:

• lng – una sequenza: codice della lingua utilizzata per il rapporto. Una delle lingue di localizzazione disponibili nel formato ISO 639-1. Necessario. È indicato in lettere minuscole.

Mappatura tra la lingua del rapporto e il valore di lng:

• email – un array: indirizzo e-mail dell'utente. Indicato per ottenere dati su un utente specifico. Opzionale.

  Requisiti sugli indirizzi indicati: 1) devono essere indicati in lettere minuscole, 2) devono contenere i simboli "@" e ".".

Risposta

JSON che contiene un array di dati su ciascun utente:

• id – una sequenza: ID assegnato al dipendente sulla piattaforma ASAP.
• email – una sequenza: indirizzo e-mail usato per registrare l'utente.
• shortName – una sequenza: nome registrato dell'utente.
• fullName – una sequenza: nome e cognome registrato dell'utente.
• group – una sequenza: gruppo di formazione corrente dell'utente.
• educationTime – una sequenza: durata della formazione in secondi.
• mainEducationProgress – una sequenza: categoria di rendimento nel corso principale.
• expressEducationProgress – una sequenza: categoria di rendimento nel corso rapido.
• educationStatus – una sequenza: stato attuale della formazione.
• mainEducationProgressPercent – un float: avanzamento della formazione nel corso principale, espresso in percentuale nel formato xx.xx.
• expressEducationProgressPercent – un float: avanzamento della formazione nel corso rapido, espresso in percentuale nel formato xx.xx.
• mainEducationEndPlan – una data: data pianificata per il completamento del corso principale.
• expressEducationEndPlan – una data: data pianificata per il completamento del corso rapido.
• realMainEducationEnd – una data: data di completamento del corso principale.
• realExpressEducationEnd – una data: data di completamento del corso rapido.
• educationMainCourses – un array: corsi di formazione e stato della formazione nel corso principale.

  Formato della risposta:

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  in cui:

  • code è il nome del corso, che varia in base alla lingua di localizzazione.
  • level è il livello di formazione. Sono possibile i seguenti valori:
    • 1: "Principiante".
    • 2: "Elementare".
    • 3: "Intermedio".
    • 4: "Avanzato".
  • status è lo stato di formazione nel corso. Sono possibile i seguenti valori:
    • 0 – "Assegnato". Il corso può essere completato dal o dalla dipendente nell'ambito del suo attuale percorso formativo individuale. Il corso sarà disponibile dopo il completamento del modulo corrente o l'inizio della formazione.
    • 1 – "Completato". Il o la dipendente ha ricevuto un attestato di completamento.
    • 2 – "In corso". Il o la dipendente sta seguendo il corso come parte del suo attuale percorso formativo individuale.
  • startedAt: data e ora in cui il o la dipendente ha iniziato il modulo di formazione, espresse in formato ISO 8601: AAAA-MM-GGThh:mm:ss. Il formato della data (AAAA-MM-GG) varia in base alla lingua di input.
  • finishedAt: data e ora di completamento del modulo (per il quale è stato ricevuto un attestato), in formato ISO 8601: AAAA-MM-GGThh:mm:ss. Il formato della data (AAAA-MM-GG) varia in base alla lingua di input. Se mancano alcuni dati, viene restituito un valore vuoto.

  In assenza di dati, viene formato un array vuoto.

• educationMainCourses – un array: corsi di formazione e stato della formazione nel corso rapido.

  Formato della risposta:

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  in cui:

  • code è il nome del corso, che varia in base alla lingua di localizzazione.
  • level è il livello di formazione.
  • status è lo stato di formazione nel corso. Sono possibile i seguenti valori:
    • 0 – "Assegnato". Il corso può essere completato dal o dalla dipendente nell'ambito del suo attuale percorso formativo individuale.
    • 1 – "Completato".

    È in corso un controllo per determinare se i test sono abilitati per la formazione corrente. Se i test sono abilitati e il test per il modulo è stato superato, o se i test sono abilitati ed è presente una nota sul conseguimento di un'abilità, "status" è uguale a 1. Altrimenti, "status" è uguale a 0.

  • startedAt: data e ora in cui il o la dipendente ha iniziato il modulo di formazione, espresse in formato ISO 8601: AAAA-MM-GGThh:mm:ss. Il formato della data (AAAA-MM-GG) varia in base alla lingua di input.
  • finishedAt: data e ora di completamento del modulo (per il quale è stato ricevuto un attestato), in formato ISO 8601: AAAA-MM-GGThh:mm:ss. Il formato della data (AAAA-MM-GG) varia in base alla lingua di input. Se mancano alcuni dati, viene restituito un valore vuoto.

  In assenza di dati, viene formato un array vuoto.

• dateLastActive – una data: data dell'attività più recente, in un formato che varia in base alla lingua di localizzazione dell'input.
• certificatesReceived – un int: numero totale di attestati ricevuti dall'utente durante la formazione.

  Se l'utente non ha avviato la formazione o non ha ricevuto alcun attestato, viene restituito "0".

• phishingAttacks – un array: informazioni su un attacco di phishing durante la formazione sulla piattaforma ASAP.

  Formato della risposta:

  [

  {

  code: '''',

  level: '''', 

  startedAt: '''', 

  phishingAttackLetter: '''', 

  phishingAttackResult: '''',

  followPhishingLinkAt: ''" || null

  }

  ]

  in cui:

  • code è il nome dipendente dalle impostazioni locali del modulo di formazione che prevede l'invio di un'e-mail di phishing.
  • level è il livello di formazione. Sono possibile i seguenti valori:
    • 1: "Principiante".
    • 2: "Elementare".
    • 3: "Intermedio".
    • 4: "Avanzato".

    Viene restituito un valore vuoto per le e-mail di phishing inviate come parte di una campagna di phishing.

  • startedAt: data e ora in cui il o la dipendente ha iniziato il modulo di formazione, espresse in formato ISO 8601: AAAA-MM-GGThh:mm:ss. Il formato della data (AAAA-MM-GG) varia in base alla lingua di input.
  • phishingAttackLetter è il titolo dell'e-mail di phishing. Quando le email di phishing vengono inviate utilizzando un modello, viene utilizzato il titolo inserito dall'amministratore. Il titolo varia in base alla lingua di localizzazione dell'input.
  • phishingAttackLetter è il risultato dell'attacco di phishing. Sono possibile i seguenti valori:
    • 0 – È stata inviata un'e-mail di phishing. Al momento si attende una risposta da parte dell'utente.
    • 1 – L'utente ha evitato l'attacco di phishing.
    • 2 – L'utente ha abboccato all'attacco di phishing.
  • followPhishingLinkAt è la data e l'ora in cui è stato visitato il link di phishing. Viene generato solo per "phishingAttackResult": 2. Negli altri casi, viene restituito un valore vuoto.  

  In assenza di dati, viene formato un array vuoto.

Possibili errori:

• 200 – success: l'operazione è andata a buon fine.
• 401 – common-unauthorized: si è verificato un errore di autenticazione. 
• 404 – user not found: è stato inviato un indirizzo e-mail non valido. 
• 400 bad request: si è verificato un problema con la richiesta.
• 500 – internal-server-error: si è verificato un errore del server interno.