Wat dit API-eindpunt doet

Met de Groups API maak of verwijder je een groep en werk je de naam van een groep bij. Beheerders zien deze wijzigingen weergegeven op het tabblad Personen. Je gebruikt dit eindpunt ook om een lijst met groepen of details van een specifieke groep op te halen.

• Eindpunten
• Object groeperen
• Groep aanmaken
• Groepen opsommen
• Ophalen via groeps-ID
• Bijwerken via groeps-ID
• Verwijderen op basis van groeps-ID

Eindpunten

• POST /groups- maak een nieuwe groep
• GET /groups- groepen opsommen
• GET /groups/{groupId}- verkrijg informatie over een groep op groeps-ID
• PUT /groups/{groupId}- update een groep op groeps-ID
• DELETE /groups/{groupId}- verwijder een groep op groeps-ID

Object groeperen

• id(string) - de unieke identificator van de groep
• membersUrl(string) - URL om groepsleden op te sommen vanuit de API
• reportersUrl(string) - URL om verslaggevers voor groepen uit de API weer te geven
• managersUrl(string) - URL naar lijstbeheerders voor groepen vanuit de API
• name(string) - de naam van de groep
• url(string) - URL om de gegevens van de groep op te halen uit de API

Groep aanmaken

POST /groups

Parameters aanvragen (JSON)

• name(string, vereist) - de naam van de groep

Voorbeeldreactie

{
„id”: „examplegroup-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”: „Voorbeeldgroep”, 
 „url”: "https://api.reach360.com/groups/example-group-id"} 
 

Endpoint-specifieke foutcodes

• code: 'duplicate_name'- kan geen groep aanmaken omdat er name al een groep bestaat met de opgegeven

Groepen opsommen

GET /groups

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 100 liggen (standaard 50)
• name(tekenreeks, optioneel) - Retourneer groepen met de opgegeven naam.

Voorbeeldreactie

{
„groups”: [
{
„id”: „voorbeeldgroep-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”: „Voorbeeldgroep” „url”: "https://api.reach60.com/groups/example-group-id-1"},
... 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Groep ophalen op basis van ID

GET /groups/{groupId}

Voorbeeldreactie

{
„id”: „examplegroup-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”: „Voorbeeldgroep” „url”: "https://api.reach360.com/groups/example-group-id"} 
 
 

Endpoint-specifieke foutcodes

• group_not_found- kan de groep niet ophalen omdat de groep niet bestaat

Groeperen op ID bijwerken

PUT /groups/{groupId}

Parameters aanvragen (JSON)

• name(string, vereist) - de naam van de groep

Reactie op succes

204 „Geen inhoud”

Endpoint-specifieke foutcodes:

• group_not_found- kan de groep niet updaten omdat de groep niet bestaat
• read_only_group- kan geen wijzigingen aanbrengen in de opgegeven groep (bijvoorbeeld: u kunt de groep „Iedereen” niet wijzigen)

Groep op ID verwijderen

DELETE /groups/{groupId}

Reactie op succes

204 „Geen inhoud”

Endpoint-specifieke foutcodes:

• group_not_found- kan de groep niet verwijderen omdat de groep niet bestaat
• read_only_group- kan de opgegeven groep niet verwijderen (bijvoorbeeld: u kunt de groep „Iedereen” niet wijzigen)