• Site Logo, Articulate

Artikelsuche

Wählen Sie ein Produkt aus

Supportverzeichnis von null

Entdecken Sie alle Artikel von null (Last Updated )

Keine Artikel gefunden.

Suchergebnisse

Keine Artikel gefunden.

Reach 360 API: API für Reporter und Berichtsgruppen

Artikel zuletzt aktualisiert am 22.04.2025

Endpunkte

  • GET /users/{userId}/reporting-groups- listet auf, für welche Gruppen ein Reporter berichtet
  • GET /groups/{groupId}/reporters- listet die Reporter einer Gruppe auf

Listet Gruppen auf, über die ein Reporter berichtet

GET /users/{userId}/reporting-groups

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 100 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
  "userUrl": "<https://api.rise.com/users/example-user-id-1>",
  "groups": [
    {
      "id": "example-group-id-1",
      "membersUrl": "<https://api.rise.com/groups/example-group-id-1/users>",
      "managersUrl": "<https://api.rise.com/groups/example-group-id-1/managers>",
      "reportersUrl": "<https://api.rise.com/groups/example-group-id-1/reporters>",
      "name": "Example Group",
      "url": "<https://api.rise.com/groups/example-group-id-1>"
    }, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Endpunktspezifische Fehlercodes:

  • user_not_found- Die Gruppen des Reporters können nicht aufgelistet werden, da der Benutzer nicht existiert
  • invalid_user_role- kann die Gruppen von Reportern nicht auflisten, da der Benutzer kein Reporter ist

Die Reporter einer Gruppe auflisten

GET /groups/{groupId}/reporters

Hinweis: Schließt Benutzer ein, die auch über die Gruppe Jeder berichten

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 100 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
  "groupUrl": "<http://api.rise.com/groups/example-group-id>",
  "reporters": [
    {
      "id": "example-user-id-1",
      "email": "foo@example.com",
      "groupsUrl": "<https://api.rise.com/users/example-user-id-1/groups>",
      "managingGroupsUrl": null,
      "reportingGroupsUrl": "<https://api.rise.com/users/example-user-id-1/reporting-groups>",
      "role" :"reporter",
      "firstName": "Example Group Reporter",
      "lastName": "Example Last Name",
      "lastActiveAt": "2021-10-28T20:39:52.659Z",
      "learnerReportUrl": "<https://api.rise.com/reports/learners/example-user-id-1>",
      "url": "<https://api.rise.com/users/example-user-id-1>"
    },
    {
      "id": "example-user-id-2",
      "email": "bar@example.com",
      "groupsUrl": "<https://api.rise.com/users/example-user-id-2/groups>",
      "managingGroupsUrl": null,
      "reportingGroupsUrl": "<https://api.rise.com/users/example-user-id-2/reporting-groups>",
      "role": "reporter",
      "firstName": "Example Everyone Reporter",
      "lastName": "Example Last Name",
      "lastActiveAt": "2021-10-28T20:39:52.659Z",
      "learnerReportUrl": "<https://api.rise.com/reports/learners/example-user-id-2>",
      "url": "<https://api.rise.com/users/example-user-id-2>"
    }, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Endpunktspezifische Fehlercodes:

  • group_not_found- Reporter können nicht aufgelistet werden, da die Gruppe nicht existiert

 

Reach 360 API: API für Reporter und Berichtsgruppen