Méthode « POST /openapi/v1/report »

Générer des données de rapport sur les utilisateurs qui sont enregistrés sur le portail et qui suivent une formation sur les programmes ASAP.

La taille des données transmises est décrite dans le corps de la demande.

Demande

En-tête :

• Autorisation : le jeton API de l'entreprise.

Corps :

• lng : une chaîne – le code de la langue utilisée pour le rapport. Une des langues de localisation disponibles au format ISO 639-1. Obligatoire. La langue est indiquée en lettres minuscules.

Correspondance entre la langue du rapport et la valeur de lng :

• email : un tableau – l'adresse email de l'utilisateur. Indiquée pour obtenir des données sur un utilisateur particulier. Facultative.

  Exigences relatives aux adresses indiquées : 1) elles doivent être indiquées en lettres minuscules, 2) elles doivent contenir les symboles « @ » et « . ».

Réponse

JSON contenant un tableau de données sur chaque utilisateur :

• id : une chaîne – l'identifiant attribué à l'employé sur la plateforme ASAP.
• email : une chaîne – l'adresse email utilisée pour enregistrer l'utilisateur.
• shortName : une chaîne – le nom court enregistré de l'utilisateur.
• fullName : une chaîne – le nom complet enregistré de l'utilisateur.
• group : une chaîne – le groupe de formation actuel de l'utilisateur.
• educationTime : une chaîne – durée de la formation en secondes.
• mainEducationProgress : une chaîne – catégorie de performance dans la formation principale.
• expressEducationProgress : une chaîne – catégorie de performance dans la formation express.
• educationStatus : une chaîne – état actuel de la formation.
• mainEducationProgressPercent : un flottant – progression de la formation dans la formation principale, exprimée en pourcentage dans le format xx.xx.
• expressEducationProgressPercent : un flottant – progression de la formation dans la formation express, exprimée en pourcentage dans le format xx.xx.
• mainEducationEndPlan : une date – date prévue pour l'achèvement de la formation principale.
• expressEducationEndPlan : une date – date prévue pour l'achèvement de la formation express.
• realMainEducationEnd : une date – date d'achèvement de la formation principale.
• realExpressEducationEnd : une date – date d'achèvement de la formation express.
• educationMainCourses : un tableau – formations et état des formations dans la formation principale.

  Format de la réponse :

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  where:

  • code est le nom de la formation, qui dépend de la langue de localisation.
  • level est le niveau de la formation. Les valeurs suivantes sont possibles :
    • 1 : « Débutant »
    • 2 : « Élémentaire »
    • 3 : « Intermédiaire »
    • 4 : « Avancé ».
  • status est l'état de la formation. Les valeurs suivantes sont possibles :
    • 0 – « Attribuée ». La formation peut être suivie par l'employé dans le cadre de son accès individuel actuel à la formation. La formation sera disponible une fois le module actuel terminé ou la formation commencée.
    • 1 – « Terminée ». L'employé a reçu un certificat d'achèvement.
    • 2 – « En cours ». L'employé suit la formation dans le cadre de son accès individuel à la formation.
  • startedAt : la date et l'heure auxquelles l'employé a commencé le module de formation, exprimées au format ISO 8601 : AAAA-MM-DDThh:mm:ss. Le format de la date (AAAA-MM-JJ) dépend de la langue de saisie.
  • finishedAt : la date et l'heure d'achèvement du module (pour lequel un certificat a été reçu), au format ISO 8601 : AAAA-MM-DDThh:mm:ss. Le format de la date (AAAA-MM-JJ) dépend de la langue de saisie. Si les données sont manquantes, une valeur vide est renvoyée.

  S'il n'y a pas de données, un tableau vide est formé.

• educationExpressCourses : un tableau – formations et état des formations dans la formation express.

  Format de la réponse :

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  where:

  • code est le nom de la formation, qui dépend de la langue de localisation.
  • level est le niveau de la formation.
  • status est l'état de la formation. Les valeurs suivantes sont possibles :
    • 0 – « Attribuée ». La formation peut être suivie par l'employé dans le cadre de son accès individuel actuel à la formation.
    • 1 – « Terminée ».

    Une vérification est en cours pour déterminer si les tests sont activés pour la formation actuelle. Si le test est activé et que le test du module a été réussi, ou si le test est activé et qu'il y a une note concernant l'acquisition d'une compétence, alors « status » est égal à 1. Dans le cas contraire, « status » est égal à 0.

  • startedAt : la date et l'heure auxquelles l'employé a commencé le module de formation, exprimées au format ISO 8601 : AAAA-MM-DDThh:mm:ss. Le format de la date (AAAA-MM-JJ) dépend de la langue de saisie.
  • finishedAt : la date et l'heure d'achèvement du module (pour lequel un certificat a été reçu), au format ISO 8601 : AAAA-MM-DDThh:mm:ss. Le format de la date (AAAA-MM-JJ) dépend de la langue de saisie. Si les données sont manquantes, une valeur vide est renvoyée.

  S'il n'y a pas de données, un tableau vide est formé.

• dateLastActive : une date – la date de l'activité la plus récente, dans un format qui dépend de la langue de localisation de saisie.
• certificatesReceived : un int – le nombre total de certificats reçus par l'utilisateur pendant la formation.

  Si l'utilisateur n'a pas commencé la formation ou n'a pas reçu de certificats, la valeur « 0 » est renvoyée.

• phishingAttacks : un tableau – informations sur une attaque de phishing lors d'une formation sur la plateforme ASAP.

  Format de la réponse :

  [

  {

  code: '''',

  level: '''', 

  startedAt: '''', 

  phishingAttackLetter: '''', 

  phishingAttackResult: '''',

  followPhishingLinkAt: ''" || null

  }

  ]

  where:

  • code est le nom, dépendant de la langue, du module de formation qui implique l'envoi d'un email de phishing.
  • level est le niveau de la formation. Les valeurs suivantes sont possibles :
    • 1 : « Débutant »
    • 2 : « Élémentaire »
    • 3 : « Intermédiaire »
    • 4 : « Avancé ».

    Une valeur vide est renvoyée pour les emails de phishing envoyés dans le cadre d'une campagne de phishing.

  • startedAt : la date et l'heure auxquelles l'employé a commencé le module de formation, exprimées au format ISO 8601 : AAAA-MM-DDThh:mm:ss. Le format de la date (AAAA-MM-JJ) dépend de la langue de saisie.
  • phishingAttackLetter est le titre de l'email de phishing. Lorsque des emails de phishing sont envoyés à l'aide d'un modèle, le titre saisi par l'administrateur est utilisé. Le titre dépend de la langue de localisation de saisie.
  • phishingAttackLetter est le résultat de l'attaque de phishing. Les valeurs suivantes sont possibles :
    • 0 : un email de phishing a été envoyé. Une réponse de l'utilisateur est actuellement attendue.
    • 1 : l'utilisateur a évité l'attaque de phishing.
    • 2 : l'utilisateur est tombé dans le piège de l'attaque de phishing.
  • followPhishingLinkAt est la date et l'heure auxquelles le lien de phishing a été suivi. Elles sont générées uniquement pour "phishingAttackResult": 2. Dans d'autres cas, une valeur vide est renvoyée.  

  S'il n'y a pas de données, un tableau vide est formé.

Erreurs possibles :

• 200 : successful – l'opération a réussi.
• 401 : common-unauthorized – il y a eu une erreur d'authentification. 
• 404 : user not found – l'email a été envoyé à une adresse email incorrecte. 
• 400 : Bad Request – une erreur s'est produite dans la demande.
• 500 : internal-server-error – une erreur de serveur interne s'est produite.