Kurse per Learn365-API einem Schulungsplan hinzufügen bzw. daraus entfernen

In diesem Artikel beschreiben wir, wie Sie Kurse über die Learn365-API einem Schulungsplan hinzufügen bzw. daraus entfernen.

Liste der aktuellen Kurse anzeigen

Zunächst sollten Sie prüfen, welche Kurse Ihr Schulungsplan derzeit enthält. Dazu benötigen Sie die Schulungsplan-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

So rufen Sie eine Liste der Kurse in Ihrem Schulungsplan ab:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt TrainingPlans den Endpunkt GET /odata/v2/TrainingPlans({id})/Courses aus und wählen Sie oben rechts Try it out aus.

3. Geben Sie im Feld id die Schulungsplan-ID ein.

4. Verwenden Sie Abfrageoptionsparameter, um die Daten in der Antwort zu steuern.

5. Klicken Sie auf Execute, um die Anfrage auszuführen.

6. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Ein 200 code mit einer Liste von Kursen weist auf eine erfolgreiche Antwort hin. Weitere Informationen zu jedem Kurs können Sie per API abrufen, indem Sie die Kurs-ID aus der Antwort verwenden und die Anfrage GET /odata/v2/Courses({Id}) senden.
• Ein 200 code mit einer leeren Liste weist darauf hin, dass sich keine Kurse im Schulungsplan befinden.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Einen Kurs zu einem Schulungsplan hinzufügen

Um einen Kurs zu einem Schulungsplan hinzuzufügen, benötigen Sie:

• Schulungsplan-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.
• Die Kurs-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

So fügen Sie per API einen Kurs zu einem Schulungsplan hinzu:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt TrainingPlans den Endpunkt POST /odata/v2/TrainingPlans({id})/Courses({courseId}) aus und klicken Sie oben rechts auf Try it out.

3. Geben Sie in das Feld id die Schulungsplan-ID ein.

4. Geben Sie in das Feld courseId die Kurs-ID ein.

5. Im Request-Body können Sie die folgenden optionalen Parameter eingeben:

• HasPrerequisite: Wenn dieser Parameter auf True gesetzt ist, kann eine Lernende/ein Lernender diesen Kurs erst starten, nachdem der vorherige Kurs im Schulungsplan abgeschlossen wurde. Wenn er auf False gesetzt ist, kann eine Lernende/ein Lernender den Kurs starten, ohne den vorherigen abzuschließen.

• Order: Die Reihenfolge, in der der Kurs im Schulungsplan angezeigt wird. Es ist eine Zahl (Integer), wobei 0 der erste Kurs in einem Schulungsplan ist. Wenn keine Reihenfolge angegeben wird, wird der Kurs im Schulungsplan als letzter angezeigt.

  HINWEIS  

  Wenn Sie einen Kurs hinzufügen und die ursprüngliche Kursreihenfolge beibehalten, werden die vorhandenen Kurse entsprechend verschoben, um die Abfolge beizubehalten.

  Angenommen, Sie haben einen Schulungsplan mit zwei Kursen:

  • Der Kurs Onboarding (Order: 0).
  • Der Kurs Communication (Order: 1).

  Angenommen, Sie möchten den Kurs Set Up Your Laptop als ersten Kurs in Ihren Schulungsplan aufnehmen. Diesen Kurs würden Sie mit 0 als Order hinzufügen. In diesem Fall verschieben sich die bereits vorhandenen Kurse nach dem Hinzufügen eines neuen Kurses automatisch um eine Position. Dadurch enthält Ihr Schulungsplan diese Kurse in der folgenden Reihenfolge:
   

  • Der Kurs Set Up Your Laptop (Order: 0).
  • Der Kurs Onboarding (Order: 1).
  • Der Kurs Communication (Order: 2).

Der Anfragepfad und der Anfragetext können dann beispielsweise so aussehen:

POST /odata/v2/TrainingPlans(9c6f3579-1295-4bec-b19a-2d8a8dddd292)/

    Courses(ae733701-734c-40d8-b062-93d75381f509)

{
"Order": 0,
"HasPrerequisite": false
}

6. Wählen Sie Execute aus, um die Anfrage auszuführen.

7. Gehen Sie zum Response-Block, um die Ergebnisse zu überprüfen:

• Ein 200 code mit den Kursdetails weist auf eine erfolgreiche Antwort hin.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.

Einen Kurs aus einem Schulungsplan entfernen

Um einen Kurs aus einem Schulungsplan zu entfernen, benötigen Sie:

• Schulungsplan-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.
• Die Kurs-ID. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

So entfernen Sie per API einen Kurs aus einem Schulungsplan:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt TrainingPlans den DELETE /odata/v2/TrainingPlans({id})/Courses({courseId})-Endpunkt aus und wählen Sie oben rechts Try it out aus.

3. Geben Sie im Feld id die ID des Schulungsplans ein.

4. Geben Sie in das Feld courseId die Kurs-ID ein.

5. Wählen Sie Execute aus, um die Anfrage auszuführen.

6. Wechseln Sie zum Block Response, um die Ergebnisse zu prüfen:

• Ein 204-Code mit einem leeren Antworttext weist auf eine erfolgreiche Antwort hin.
• Im Fehlerfall enthält der Antworttext das Objekt error mit den Schlüsseln code und message, die das Problem erklären.