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. Admins sehen, dass sich diese Änderungen auf der Registerkarte „Personen“ widerspiegeln. 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 einer Gruppe anhand der Gruppen-ID abrufen
  • PUT /groups/{groupId}- eine Gruppe anhand der Gruppen-ID aktualisieren
  • DELETE /groups/{groupId}- lösche eine Gruppe anhand der Gruppen-ID

Objekt gruppieren

  • id(string) - die eindeutige Kennung der Gruppe
  • membersUrl(string) — URL zum Auflisten der Gruppenmitglieder 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(Zeichenfolge, erforderlich) - der Name der Gruppe

Beispiel für eine Antwort

{
„id“: „example-group-id“,
 „membersURL“: "https://api.reach360.com/groups/example-group-id/users „,
 „name“: „Beispielgruppe“,
 „url“: "https://api.reach360.com/groups/example-group-id"
}

Endpunktspezifische Fehlercodes

  • code: 'duplicate_name'- kann keine Gruppe erstellen, da eine Gruppe mit dem angegebenenname bereits existiert

Gruppen auflisten

GET /groups

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 100 liegen (der Standardwert ist 50)
  • name(Zeichenfolge, 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 „,
 „name“: „Beispielgruppe“
 „url“: "https://api.reach60.com/groups/example-group-id-1"
},... 
],
 „nächste URL“: "https://url-for-next-page-of-results"
}

Gruppe nach ID abrufen

GET /groups/{groupId}

Beispiel für eine Antwort

{
„id“: „example-group-id“,
 „membersURL“: "https://api.reach360.com/groups/example-group-id/users „,
 „name“: „Beispielgruppe“
 „url“: "https://api.reach360.com/groups/example-group-id"
}

Endpunktspezifische Fehlercodes

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

Gruppe nach ID aktualisieren

PUT /groups/{groupId}

Anforderungsparameter (JSON)

  • name(Zeichenfolge, erforderlich) - der Name der Gruppe

Antwort auf Erfolg

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

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

Gruppe nach ID löschen

DELETE /groups/{groupId}

Antwort auf Erfolg

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

  • group_not_found- 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)