Browse Articles

Browse Articles

Reach 360: Gruppen-API

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Gruppen-API erstellen oder löschen Sie eine Gruppe und aktualisieren den Namen einer Gruppe. Administratoren sehen diese Änderungen auf der Registerkarte „Personen“. Sie verwenden diesen Endpunkt auch, um eine Liste von Gruppen oder Details einer bestimmten Gruppe abzurufen.

Endpunkte

  • POST /groups- eine neue Gruppe erstellen
  • GET /groups- Gruppen auflisten
  • GET /groups/{groupId}- Details zu einer Gruppe anhand der Gruppen-ID abrufen
  • PUT /groups/{groupId}- aktualisiert eine Gruppe anhand der Gruppen-ID
  • DELETE /groups/{groupId}- lösche eine Gruppe nach Gruppen-ID

Objekt gruppieren

  • id(string) — der eindeutige Bezeichner der Gruppe
  • membersUrl(string) — URL zur Auflistung der Gruppenmitglieder aus der API
  • reportersUrl(string) — URL zur Liste der Reporter für Gruppen aus der API
  • managersUrl(string) — URL zur Liste der Manager für Gruppen aus der API
  • name(string) — der Name der Gruppe
  • url(string) — URL zum Abrufen der Gruppendetails von der API

Gruppe erstellen

POST /groups

Anforderungsparameter (JSON)

  • name(string, erforderlich) — der Name der Gruppe

Beispiel für eine Antwort

{
„id“: „Beispielgruppen-ID“, 
 „membersURL“: "https://api.reach360.com/groups/example-group-id/users „, „reportersURL“: "https://api.reach360.com/groups/example-group-id/reporters 
 „, „managersURL“: "https://api.reach360.com/groups/example-group-id/managers „, 
 „name“: „Beispielgruppe“, 
 „url“: "https://api.reach360.com/groups/example-group-id"}

Endpunktspezifische Fehlercodes

  • code: 'duplicate_name'- Die Gruppe kann nicht erstellt werden, da eine Gruppe mit dem angegebenen Wert bereits existiert name

Gruppen auflisten

GET /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)
  • name(string, optional) — Gibt Gruppen mit dem angegebenen Namen zurück.

Beispiel für eine Antwort

{
„groups“: [
{
„id“: „example-group-id-1", 
 „membersURL“: "https://api.reach360.com/groups/example-group-id/users „, „reportersURL“: "https://api.reach360.com/groups/example-group-id-1/reporters 
 „, „managersURL“: "https://api.reach360.com/groups/example-group-id-1/managers „, 
 „name“: „Beispielgruppe“ „url“: "https://api.reach60.com/groups/example-group-id-1"},
... 
 
 
], „nextUrl“: "https://url-for-next-page-of-results"}

Gruppe nach ID abrufen

GET /groups/{groupId}

Beispiel für eine Antwort

{
„id“: „Beispielgruppen-ID“, 
 „membersURL“: "https://api.reach360.com/groups/example-group-id/users „, „reportersURL“: "https://api.reach360.com/groups/example-group-id/reporters 
 „, „managersURL“: "https://api.reach360.com/groups/example-group-id/managers „, 
 „name“: „Beispielgruppe“ „url“: "https://api.reach360.com/groups/example-group-id"}

Endpunktspezifische Fehlercodes

  • group_not_found- Die Gruppe kann nicht abgerufen werden, da die Gruppe nicht existiert

Gruppe nach ID aktualisieren

PUT /groups/{groupId}

Anforderungsparameter (JSON)

  • name(string, erforderlich) — der Name der Gruppe

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

  • group_not_found- Die Gruppe kann nicht aktualisiert werden, da die Gruppe nicht existiert
  • read_only_group- kann keine Änderungen an der angegebenen Gruppe vornehmen (Beispiel: Sie können die Gruppe „Jeder“ nicht ändern)

Gruppe nach ID löschen

DELETE /groups/{groupId}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

  • group_not_found- Die Gruppe kann nicht gelöscht werden, da die Gruppe nicht existiert
  • read_only_group- Die angegebene Gruppe kann nicht gelöscht werden (Beispiel: Sie können die Gruppe „Jeder“ nicht ändern)