Benutzer über die Learn365-API in einem Kurs registrieren

Benutzer können über die Funktion Learn365 Admin Center und die Learn365-API in einem Kurs registriert werden. Dieser Artikel beschreibt, welche Learn365-API-Endpunkte Sie verwenden, um Benutzer in Kursen zu registrieren.

So registrieren Sie einen Benutzer über API-Endpunkte in einem Learn365-Kurs:

1. Navigieren Sie zu https://api.365.systems/ und autorisieren Sie sich mit dem entsprechenden API-Schlüssel. Weitere Informationen zum Autorisierungsvorgang finden Sie hier.

2. Wählen Sie im Abschnitt Courses den POST-Endpunkt /odata/v2/Courses({Id})/Enroll ausund wählen Sie Try it out aus.

3. Nachdem Sie Try it out ausgewählt haben, füllen Sie die Felder aus und achten Sie besonders auf die erforderlichen Parameter:

• key:Id, ein erforderlicher Parameter. Geben Sie die ID des Kurses ein, in dem Sie einen Benutzer oder eine Gruppe registrieren möchten.
   
• userLoginName, ein erforderlicher Parameter. Ersetzen Sie string durch den Anmeldenamen des Benutzers oder die ID der benutzerdefinierten Benutzergruppe, die Sie in dem Kurs registrieren möchten.
   
• Der Parameter courseSessionIdist veraltet und sollte nicht verwendet werden. Löschen Sie den Parameter courseSessionId aus dem Anfragetext. 
   

• courseSessionIds, ein erforderlicher Parameter nur dann, wenn Sie einen Benutzer in einem Kurs mit dem Registrierungstyp singleodermultipleregistrieren und register ihn für Sitzungsgruppen oder eigenständige Sitzungen des Kurses anmelden möchten. Weitere Details dazu, wie Sie die ID einer eigenständigen Sitzung oder einer Sitzungsgruppe erhalten, finden Sie hier. 

  Ersetzen Sie bei einem Kurs mit dem Registrierungstyp single guid durch die ID der einzelnen Sitzungsgruppe oder eigenständigen Sitzung, für die Sie einen Benutzer registrieren möchten.
  Ersetzen Sie bei einem Kurs mit dem Registrierungstyp multiple guid durch die ID jeder Sitzungsgruppe oder eigenständigen Sitzung, für die Sie einen Benutzer registrieren möchten. IDs von Sitzungsgruppen und eigenständigen Sitzungen sollten durch ein Komma getrennt werden. 

  Wenn der Parameter courseSessionIds bei einem Kurs mit dem Registrierungstyp single oder multiple nicht angegeben ist, wird der Benutzer im Kurs selbst registriert, ohne für eine seiner Sitzungsgruppen oder eigenständigen Sitzungen angemeldet zu werden, und er erhält eine E-Mail-Benachrichtigung mit der Aufforderung, Sitzungsgruppen oder eigenständige Sitzungen auszuwählen und sich dafür zu registrieren, um die Registrierung abzuschließen.
  
  Der Parameter courseSessionIds sollte bei der Registrierung eines Benutzers ineinem Kurs mit dem Registrierungstyp all weggelassen werden, andernfalls schlägt die Anfrage fehl. Sie können diesen Parameter jedoch verwenden, um einen Benutzer für bestimmte Sitzungsgruppen und eigenständige Sitzungen eines Kurses mit dem Registrierungstyp all anzumelden, indem Sie die ID bestimmter Sitzungsgruppen und eigenständiger Sitzungen dieses Kurses angeben. 
   

• ignoreMaxAttendees, ein optionaler Parameter für einen Kurs vom Registrierungstyp all, nur wenn für den Kurs keine maximale Teilnehmerzahl festgelegt wurde. Ersetzen Sie boolean durch true, um einen Benutzer für einen Kurs zu registrieren – unabhängig von der maximalen Teilnehmerzahl des Kurses. Wenn Sie false eingeben, schlägt die Anfrage fehl, wenn die maximale Teilnehmerzahl des Kurses erreicht ist. Bei Kursen vom Registrierungstyp single und multiple wird die maximale Teilnehmerzahl individuell für jede Sitzungsgruppe und jede eigenständige Sitzung festgelegt. Dies sollte über den Parameter ignoreSessionRequirements konfiguriert werden.
   
• ignoreEnrollmentFlow, ein optionaler Parameter, nur wenn für den Kurs der Registrierungsflow Automatic Approval festgelegt ist. Ersetzen Sie boolean durch true, um einen Benutzer für einen Kurs zu registrieren, unabhängig vom Registrierungsflow des Kurses. Wenn Sie false eingeben, erhält die Registrierung des Benutzers den Status „Awaiting approval“, wenn für den Kurs der Registrierungsflow Administrator Approval oder Line Manager Approval festgelegt ist. 
   
• ignoreEnrollmentDeadline, ein optionaler Parameter für einen Kurs vom Registrierungstyp all, nur wenn für den Kurs keine Registrierungsfrist festgelegt ist. Ersetzen Sie boolean durch true , um einen Benutzer für einen Kurs zu registrieren, unabhängig davon, ob die Registrierungsfrist des Kurses erreicht wurde. Wenn Sie false eingeben, schlägt die Anfrage fehl, wenn die Registrierungsfrist des Kurses erreicht wurde. Bei Kursen vom Registrierungstyp single oder multiple werden Registrierungsfristen individuell für jede Sitzungsgruppe und jede eigenständige Sitzung festgelegt. Dies sollte über den Parameter ignoreSessionRequirements konfiguriert werden.
   
• ignoreSessionRequirements, ein optionaler Parameter. Ersetzen Sie boolean durch true, um einen Benutzer für einen Kurs vom Registrierungstyp single oder multiple zu registrieren – unabhängig von den Anforderungen, die individuell für eine Sitzungsgruppe und eine eigenständige Sitzung festgelegt sind (maximale Teilnehmerzahl, Registrierungsfrist). Wenn Sie false eingeben, schlägt die Anfrage fehl, wenn der Anfragetext die Anforderungen der betreffenden Sitzungsgruppe und der eigenständigen Sitzung nicht erfüllt.

Hier ist ein Beispiel für eine Anfrage, um einen Benutzer für zwei Sitzungen eines Kurses vom Registrierungstyp multiple zu registrieren:

4. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.

5. Gehen Sie zum Responses Block, um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (zum Beispiel, 201) unter Code zeigt an, dass die Anfrage korrekt ausgeführt wurde.
• Im Response body Feld können Sie die Ergebnisse der Anfrage sehen – die Registrierung des Benutzers und die Sitzungsregistrierungen werden angezeigt. Außerdem finden Sie in der RegistrationDate Zeile das Datum und die Uhrzeit of the user's enrollment. Der Benutzer oder die Gruppe werden für den Kurs registriert und erhalten die entsprechenden Benachrichtigungen. 
  Benutzerregistrierungen können im Learn365 Admin Center > einen Katalog auswählen > Training Management > den relevanten Kurs auswählen > Manage people überprüft werden.