"POST /openapi/v1/report"-Methode

Berichtsdaten über Benutzer generieren, die im Portal registriert sind und Trainings in ASAP-Programmen abschließen.

Die Größe der übergebenen Daten wird im Körper der Anfrage beschrieben.

Anfrage

Kopfzeile:

• Authorization – API-Token des Unternehmens.

Körper:

• lng – eine Zeichenfolge – Der Sprachcode der für den Bericht verwendeten Sprache. Eine der verfügbaren Lokalisierungssprachen im ISO 639-1-Format. Erforderlich. Sie wird in Kleinbuchstaben angegeben.

Verknüpfung zwischen der Berichtssprache und dem Wert von lng:

• E-Mail – ein Array – Die E-Mail-Adresse des Benutzers. Wird angegeben, um Daten über einen bestimmten Benutzer zu erhalten. Optional.

  Anforderungen an die angegebenen Adressen: 1) Sie müssen in Kleinbuchstaben angegeben werden, 2) sie müssen die Zeichen „@“ und „.“ enthalten.

Antwort

JSON mit einem Array von Daten über den Benutzer:

• id – eine Zeichenfolge – Die ID, die dem Mitarbeiter in der ASAP-Plattform zugewiesen ist.
• email – eine Zeichenfolge – Die E-Mail-Adresse, die zur Registrierung des Benutzers verwendet wurde.
• shortName – eine Zeichenfolge – Der registrierte Kurzname des Benutzers.
• fullName – eine Zeichenfolge – Der registrierte vollständige Name des Benutzers.
• group – eine Zeichenfolge – Die aktuelle Trainingsgruppe des Benutzers.
• educationTime – eine Zeichenfolge – Dauer der Schulung in Sekunden.
• mainEducationProgress – eine Zeichenfolge – Leistungskategorie für den Hauptkurs.
• expressEducationProgress – eine Zeichenfolge – Leistungskategorie für den Intensivkurs.
• educationStatus – eine Zeichenfolge – Aktueller Trainingsstatus.
• mainEducationProgressPercent – eine Gleitkommazahl – Trainingsfortschritt im Hauptkurs, als Prozentsatz im Format xx,xx ausgedrückt.
• expressEducationProgressPercent – eine Gleitkommazahl – Trainingsfortschritt im Intensivkurs, als Prozentsatz im Format xx,xx ausgedrückt.
• mainEducationEndPlan – ein Datum – Erwartetes Abschlussdatum für den Hauptkurs.
• expressEducationEndPlan – ein Datum – Erwartetes Abschlussdatum für den Intensivkurs.
• realMainEducationEnd – ein Datum – Abschlussdatum für den Hauptkurs.
• realExpressEducationEnd – ein Datum – Abschlussdatum für den Intensivkurs.
• educationMainCourses – ein Array – Trainingskurse und Trainingsstatus im Hauptkurs.

  Antwortformat:

  [

  {

  Code,

  Stufe,

  Status,

  startedAt,

  finishedAt

  }

  ]

  wobei:

  • code der Kursname ist, der von der Lokalisierungssprache abhängig ist.
  • level die Trainingsstufe ist, Die folgenden Werte sind möglich:
    • 1 – „Anfänger“.
    • 2 – „Grundlagen“.
    • 3 – „Mittelstufe“.
    • 4 –„Fortgeschritten“.
  • status ist der Schulungsstatus im Kurs. Die folgenden Werte sind möglich:
    • 0 – „Zugewiesen“. Der Kurs kann vom Mitarbeiter als Teil seines oder ihres individuellen Trainingspfads abgeschlossen werden. Der Kurs ist verfügbar, nachdem das aktuelle Modul abgeschlossen wurde oder die Schulung begonnen wird.
    • 1 – „Abgeschlossen“. Der Mitarbeiter hat ein Abschlusszertifikat erhalten.
    • 2 – „Läuft“. Der Mitarbeiter absolviert den Kurs als Teil seines oder ihres individuellen Schulungspfads.
  • startedAt – Datum und Uhrzeit, zu denen der Mitarbeiter das Schulungsmodul gestartet hat, ausgedrückt im ISO 8601-Format: YYYY-MM-DDThh:mm:ss. Das Datumsformat (YYYY-MM-DD) hängt von der Eingabesprache ab.
  • finishedAt – Datum und Uhrzeit des Abschlusses des Moduls (für das ein Zertifikat erhalten wurde) im ISO 8601-Format: YYYY-MM-DDThh:mm:ss. Das Datumsformat (YYYY-MM-DD) hängt von der Eingabesprache ab. Wenn Daten fehlen, wird ein leerer Wert zurückgegeben.

  Wenn es keine Daten gibt, wird ein leerer Array gebildet.

• educationExpressCourses – ein Array – Schulungskurse und Schulungsstatus im Intensivkurs.

  Antwortformat:

  [

  {

  Code,

  Stufe,

  Status,

  startedAt,

  finishedAt

  }

  ]

  wobei:

  • code der Kursname ist, der von der Lokalisierungssprache abhängig ist.
  • level die Trainingsstufe ist,
  • status ist der Schulungsstatus im Kurs. Die folgenden Werte sind möglich:
    • 0 – „Zugewiesen“. Der Kurs kann vom Mitarbeiter als Teil seines oder ihres individuellen Trainingspfads abgeschlossen werden.
    • 1 – „Abgeschlossen“.

    Eine Prüfung wird ausgeführt, um zu bestimmen, ob für die aktuelle Schulung Tests aktiviert sind. Wenn Tests aktiviert sind und der Test für das Modul bestanden wurde, oder wenn Tests aktiviert sind und es eine Anmerkung bezüglich der Aneignung einer Qualifikation wird, dann ist „status“ gleich 1. Anderenfalls ist „status“ gleich 0.

  • startedAt – Datum und Uhrzeit, zu denen der Mitarbeiter das Schulungsmodul gestartet hat, ausgedrückt im ISO 8601-Format: YYYY-MM-DDThh:mm:ss. Das Datumsformat (YYYY-MM-DD) hängt von der Eingabesprache ab.
  • finishedAt – Datum und Uhrzeit des Abschlusses des Moduls (für das ein Zertifikat erhalten wurde) im ISO 8601-Format: YYYY-MM-DDThh:mm:ss. Das Datumsformat (YYYY-MM-DD) hängt von der Eingabesprache ab. Wenn Daten fehlen, wird ein leerer Wert zurückgegeben.

  Wenn es keine Daten gibt, wird ein leerer Array gebildet.

• dateLastActive ein Datum – Das Datum der aktuellsten Aktivität, in einem Format, das von der eingegebenen Lokalisierungssprache abhängt.
• certificatesReceived – eine Ganzzahl – Die Gesamtzahl der Zertifikate, die der Benutzer während der Schulung erhalten hat.

  Wenn der Benutzer nicht mit der Schulung begonnen oder keine Zertifikate bekommen hat, wird „0“ zurückgegeben.

• phishingAttacks – ein Array – Informationen einen Phishing-Angriff während der Schulung zur ASAP-Plattform.

  Antwortformat:

  [

  {

  Code: '''',

  Stufe: "", 

  startedAt: '''', 

  phishingAttackLetter: '''', 

  phishingAttackResult: '''',

  followPhishingLinkAt: ''" || null

  }

  ]

  wobei:

  • code der vom Gebietsschema abhängige Name des Schulungsmoduls ist, das Senden einer Phishing-Phishing-E-Mail beinhaltet.
  • level die Trainingsstufe ist, Die folgenden Werte sind möglich:
    • 1 – „Anfänger“.
    • 2 – „Grundlagen“.
    • 3 – „Mittelstufe“.
    • 4 –„Fortgeschritten“.

    Für die als Teil einer Phishing-Kampagne gesendeten E-Mails wird ein leerer Wert zurückgegeben.

  • startedAt – Datum und Uhrzeit, zu denen der Mitarbeiter das Schulungsmodul gestartet hat, ausgedrückt im ISO 8601-Format: YYYY-MM-DDThh:mm:ss. Das Datumsformat (YYYY-MM-DD) hängt von der Eingabesprache ab.
  • phishingAttackLetter der Titel der Phishing-E-Mail ist. Wenn Phishing-E-Mails mithilfe einer Vorlage gesendet werden, wird der vom Administrator eingegebene Titel verwendet. Der Titel hängt von der eingegebenen Lokalisierungssprache ab.
  • phishingAttackLetter das Ergebnis des Phishing-Angriffs ist. Die folgenden Werte sind möglich:
    • 0 – Eine Phishing-E-Mail wurde gesendet. Auf eine Antwort des Benutzers wird derzeit gewartet.
    • 1 – Der Benutzer hat den Phishing-Angriff abgewehrt.
    • 2 – Der Benutzer ist dem Phishing-Angriff zum Opfer gefallen.
  • followPhishingLinkAt das Datum und die Uhrzeit sind, zu denen dem Phishing-Link gefolgt wurde. Es wird nur für „phishingAttackResult“: 2 generiert. In anderen Instanzen wird ein leerer Wert zurückgegeben.  

  Wenn es keine Daten gibt, wird ein leerer Array gebildet.

Mögliche Fehler:

• 200 – success – Der Vorgang war erfolgreich.
• 401 – common-unauthorized – Es ist ein Authentifizierungsfehler aufgetreten. 
• 404 – user not found – Eine ungültige E-Mail-Adresse wurde versendet. 
• 400 bad request – Mit der Anforderung stimmt etwas nicht.
• 500 – internal-server-error – Es ist ein interner Serverfehler aufgetreten.