Best Practices für externe Lernmodule

In diesem Artikel werden die Best Practices für die Interaktion Ihrer Middleware mit den Genesys-APIs aufgeführt.

Genesys Cloud kann die Systeme, die außerhalb der Genesys Cloud-Plattform liegen, mit den Genesys-Lernmodulen synchronisieren.

Beschreibung

Zum Erstellen eines Lernmoduls kann der Administrator den folgenden Endpunkt verwenden:

POST /learning/modules

Anleitung

Das externe Modul muss eine einzelne URL sein, die auf die externe Lernressource verweist.

Beispiel

{
"name": "SMART goals",
"description": "This external training takes you through how to create SMART goals.",
"completionTimeInDays": 14,
"informSteps": [
{
"type": "Url",
"name": "SMART goals",
"order": 1,
"value": "https://myLms.com/courses/1234"
}
],
"excludedFromCatalog": true,
"externalId": "1234",
"type": "External"
}

Beschreibung

Zum Veröffentlichen eines Lernmoduls kann der Administrator den folgenden Endpunkt verwenden:

POST /api/v2/learning/modules/{moduleId}/publish 

Anleitung

Wenn Sie ein Lernmodul nach der Veröffentlichung bearbeiten, müssen Sie das Modul erneut veröffentlichen, damit den Benutzern die aktualisierte Version des Moduls zugewiesen wird. Sie können die Module aus dem Katalog ausblenden, um zu verhindern, dass sie in der Modulliste angezeigt werden, wenn der Vorgesetzte die Lernmodule über die Workspace Development-Seiten zuweist.

Beschreibung

Um ein Lernmodul zuzuweisen, kann der Administrator Folgendes verwenden: Endpunkt:

POST /api/v2/learning/assignments 

Anleitung

Sie können einem Benutzer eine bestimmte Version eines Lernmoduls zuweisen. Die Version des Lernmoduls wird erst festgelegt, wenn der Benutzer die Aufgabe startet. Wenn ein Benutzer keine Aufgabe gestartet hat und eine neuere Version des Moduls veröffentlicht wird, wird dem Benutzer automatisch die neueste Version des Lernmoduls zugewiesen.

Beispiel

{
"moduleId": "2169a726-31e1-4d69-b161-1b62ccb1c99e",
"userId": "1e39d64f-68ff-41cc-8a2e-781cbce08409",
"recommendedCompletionDate": "2024-02-01T15:00:00Z",
"lengthInMinutes": "60"

}

Hinweis: „EmpfohlenesCompletionDate“ und „lengthInMinutes“ sind optionale Überschreibungen. Wenn Sie „recommendedCompletionDate“ und „lengthInMinutes“ nicht angeben, basieren deren Werte auf den Werten aus dem Modul.

Beschreibung

Sie können das Lernmodul über Genesys Cloud starten. Während des Aufgabenstarts wird ein Titelbildschirm mit der Modulbeschreibung und dem Titelbild angezeigt. 

Anleitung

Wenn Sie auf klicken, um die Aufgabe zu starten, werden Sie im Modulschritt zu der URL weitergeleitet, die auf die externe Lernressource verweist .

Beschreibung

Um die Aufgabe zu aktualisieren, muss das externe System die Ergebnisse der Lernressource über die folgende Schnittstelle an Genesys Cloud senden: Endpunkt:

PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments 

Anleitung

Die folgende Der Endpunkt ist durch eine Sicherheitsschleuse geschützt. Lernen:ExterneAufgabe:Bearbeiten Berechtigung, die standardmäßig keiner Rolle zugewiesen ist:

PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments 

Der Endpunkt aktualisiert stets die neueste Aufgabe für diesen Benutzer und das Lernmodul.

Beispiel

{
"state": "Completed",
"percentageScore": 85,
"isPassed": true
}

Hinweis: Wenn Sie Fragen zur Erstellung Ihrer Middleware haben, empfiehlt Genesys, dass Sie sich an Ihren Partner oder den Kundendienst wenden.