Delegierte über die Learn365-API zuweisen oder die Zuweisung aufheben

Durch Zuweisen eines Delegierten kann jeder Benutzer in Ihrer Organisation jeden anderen Benutzer verwalten, während das Aufheben der Zuweisung eines Delegierten diese Möglichkeit entfernt. Es gibt zwei Möglichkeiten, in der Learn365-API die Zuweisung von Delegierten aufzuheben:

• Die Zuweisung eines Delegierten für alle zugehörigen Teammitglieder aufheben.
• Die Zuweisung eines bestimmten Teammitglieds für einen Delegierten aufheben.

Später können Sie die gelöschte Zuweisung für ein bestimmtes Teammitglied wiederherstellen.

Weitere Informationen zu Delegierten finden Sie in diesem Artikel.

Einen Delegierten zuweisen

POST /services/users/v2/Delegates

Mit dieser Anfrage können Sie einem Teammitglied einen Delegierten zuweisen. 

Derzeit ist es möglich, mit einer Anfrage einen Delegierten einem Teammitglied zuzuweisen. Um einem Delegierten mehrere Teammitglieder zuzuweisen, senden Sie für jede Zuweisung eine separate Anfrage.

Voraussetzungen

Um die Anfrage zu senden, benötigen Sie einen API-Schlüssel.

Es lohnt sich zu prüfen, welche Delegiertenzuweisungen in Ihrer Organisation bereits vorhanden sind. Um eine Liste der aktuellen Delegierten und ihrer Teammitglieder zu erhalten, senden Sie die Anfrage GET /services/users/v2/Delegates. Weitere Informationen zu dieser Anfrage finden Sie in diesem Artikel.

Um einem Teammitglied einen Delegierten zuzuweisen, benötigen Sie die Benutzer-IDs beider Benutzer. Sie können diese Information per API ermitteln, indem Sie die Schritte in diesem Artikel befolgen.

Parameter des Request Bodys

Das Body-Objekt enthält zwei erforderliche Parameter:

• delegateId (string). Die Benutzer-ID eines Delegierten.
• teamMemberId (string). Die Benutzer-ID des Teammitglieds, das vom Delegierten verwaltet wird.

Anfragebeispiel

POST /services/users/v2/Delegates
{
"delegateId": "7853ce01-9a6f-4e07-a3e0-1e3a578655d7",
"teamMemberId": "8a47813f-62c7-4a6f-a721-496692347c14"
}

Parameter des Antwort-Bodys

Die erfolgreiche 201-Antwort enthält diese Parameter:

• delegateId (string). Die Benutzer-ID eines Delegierten.
• teamMemberId (string). Die Benutzer-ID des Teammitglieds, das nun vom Delegierten verwaltet wird.
• isDeleted (boolean). Gibt an, ob die Delegiertenzuweisung gelöscht (true) wurde oder nicht (false).

Antwortbeispiel

Die erfolgreiche 201-Antwort gibt einen Body ähnlich diesem zurück:

{
 "delegateId": "7853ce01-9a6f-4e07-a3e0-1e3a578655d7",
 "teamMemberId": "8a47813f-62c7-4a6f-a721-496692347c14",
 "isDeleted": false
}

Zuweisung eines Delegierten für alle seine Teammitglieder aufheben

LÖSCHEN /services/users/v2/Delegates/{delegateId}

Mit dieser Anfrage können Sie die Zuweisung eines Delegierten für alle seine Teammitglieder aufheben.

Voraussetzungen

Zum Senden der Anfrage benötigen Sie einen API-Schlüssel.

Es lohnt sich zu prüfen, welche Teammitglieder dem Delegierten derzeit zugewiesen sind. Um eine Liste der Delegierten und ihrer Teammitglieder abzurufen, senden Sie die Anfrage GET /services/users/v2/Delegates. Die Antwort enthält außerdem den Parameter delegateId. Sie benötigen diese Delegierten-ID, um die Zuweisung des Delegierten aufzuheben. Weitere Informationen zu dieser Anfrage finden Sie in diesem Artikel.

Pfadparameter

• delegateId (string). Die Benutzer-ID eines Delegierten.

Beispielanfrage

LÖSCHEN /services/users/v2/Delegates/7853ce01-9a6f-4e07-a3e0-1e3a578655d7

Antwort

Eine 204-Antwort ohne Inhalt bedeutet, dass die Anfrage erfolgreich war. 

Die beim Delegierten aufgehobenen Zuweisungen werden in der Antwort auf die Anfrage GET /services/users/v2/Delegates weiterhin aufgeführt, wenn der Parameter isDeleted auf true gesetzt ist.

Später können Sie diese Zuweisungen einzeln wiederherstellen. 

Die Zuweisung eines bestimmten Teammitglieds von einem Delegierten aufheben

LÖSCHEN /services/users/v2/Delegates/{delegateId}/members/{teamMemberId}

Mit dieser Anfrage können Sie die Zuweisung eines bestimmten Teammitglieds von einem bestimmten Delegierten aufheben.

Voraussetzungen

Um die Anfrage zu senden, benötigen Sie einen API-Schlüssel.

Um die Zuweisung eines Teammitglieds von einem Delegierten aufzuheben, benötigen Sie die Benutzer-IDs von beiden. Um diese zu finden: 

1. Senden Sie die GET /services/users/v2/Delegates-Anfrage. Weitere Informationen zu dieser Anfrage finden Sie in diesem Artikel.

2. Suchen Sie in der Antwort die delegateId und teamMemberId des benötigten Delegierten bzw. Teammitglieds.

Pfadparameter

• delegateId (String). Die Benutzer-ID eines Delegierten.
• teamMemberId (String). Die Benutzer-ID eines Teammitglieds.

Beispiel für eine Anfrage

LÖSCHEN /services/users/v2/Delegates/8a47813f-62c7-4a6f-a721-496692347c14/
members/60118dd9-4cde-4848-b954-bc895c6393dd

Antwort

Eine 204-Antwort ohne Textkörper bedeutet, dass die Anfrage erfolgreich war. 

Die dem Delegaten entzogenen Zuweisungen sind in der Antwort auf die Anfrage GET /services/users/v2/Delegates weiterhin aufgeführt, wenn der Parameter isDeleted auf true gesetzt ist.

Später können Sie diese spezifische Zuweisung wiederherstellen.

Eine gelöschte Zuweisung für ein bestimmtes Teammitglied wiederherstellen

PATCH /services/users/v2/Delegates/{delegateId}/members/{teamMemberId}/update

Mit dieser Anfrage können Sie eine zuvor gelöschte Zuweisung für einen bestimmten Delegaten und ein bestimmtes Teammitglied wiederherstellen.

Voraussetzungen

Um die Anfrage zu senden, benötigen Sie einen API-Schlüssel.

Um die Zuweisung für einen bestimmten Delegaten und ein bestimmtes Teammitglied wiederherzustellen, benötigen Sie für beide die Benutzer-IDs. So finden Sie sie: 

1. Senden Sie die Anfrage GET /services/users/v2/Delegates. Weitere Informationen zu dieser Anfrage finden Sie in diesem Artikel.

2. Suchen Sie in der Antwort nach delegateId und teamMemberId des benötigten Delegaten bzw. des Teammitglieds.

So stellen Sie sicher, dass die Zuweisung für einen bestimmten Delegaten und ein bestimmtes Teammitglied aktuell gelöscht ist:

1. Senden Sie die Anfrage GET /services/users/v2/Delegates/{delegateId}/members/{teamMemberId} mit den IDs des Delegaten und des Teammitglieds als Pfadparameter.

2. Prüfen Sie in der Antwort, ob der Parameter isDeleted auf true gesetzt ist.

Pfadparameter

• delegateId (string). Die Benutzer-ID eines Delegaten.
• teamMemberId (string). Die Benutzer-ID eines Teammitglieds.

Beispiel für eine Anfrage

PATCH /services/users/v2/Delegates/8a47813f-62c7-4a6f-a721-496692347c14/
members/60118dd9-4cde-4848-b954-bc895c6393dd/update

Antwort

Eine 204-Antwort ohne Response-Body bedeutet, dass die Anfrage erfolgreich war. Die Zuweisung ist wieder aktiv.