Groups Resource

GET: /groups | Paginated

Geeft een lijst terug met groepen. Alleen de groepen worden waar leden bij horen afhankelijk van welke rechten je hebt. Bijv. groepen met alleen reünisten worden niet terug gegeven als je alleen de rechten hebt om leden te bekijken.

Changes Since

Het is mogelijk om een lijst op te halen met veranderingen sinds een bepaalde tijd. Dit doe je door de volgende GET parameter mee te geven

Parameters:

Key	Beschrijving	Noodzaak
changes_since	De timestamp vanaf wanneer je de veranderingen wilt terug krijgen	optioneel

Response:

id	Groep id | Unique
name	Naam van de groep
alias	Een alias van de groep naam
group_type_id	Het id van het gekoppelde groep type
year	Het jaartal waarin de groep is opgericht
website	Website
notes	Prive notitities over de groep
notes_public	Publieke notities over de groep
allow_new_members	Mogen er nieuwe personen worden toegevoegd aan deze groep
leden_ids	Een lijst van alle leden binnen deze groep | is afhankelijk van de rechten van jou API key
reunisten_ids	Een lijst van alle reünisten binnen deze groep | is afhankelijk van de rechten van jou API key
created_at	De timestamp wanneer het record is aangemaakt in de headless (Format Y-m-d H:i:s)
updated_at	De timestamp wanneer het record voor het laatst is geüpdatet (Format: Y-m-d H:i:s)

GET: /groups/{group_id}

Geeft een specifieke group terug met de daaraan gekoppelde statussenn

Response:

id	Groep id | Unique
name	Naam van de groep
alias	Een alias van de groep naam
group_type_id	Het id van het gekoppelde groep type
grouptype	Een object met daarin: id en naam van het groep type
year	Het jaartal waarin de groep is opgericht
website	Website
notes	Prive notitities over de groep
notes_public	Publieke notities over de groep
allow_new_members	Mogen er nieuwe leden toegevoegd worden aan deze groep
leden_ids	Een lijst van alle leden binnen deze groep | is afhankelijk van de rechten van jou API key
reunisten_ids	Een lijst van alle reünisten binnen deze groep | is afhankelijk van de rechten van jou API key
group_history	Een lijst met de historie van de groep. Hierbij bevat een group history entry de volgende velden: lid_id | is afhankelijk van de rechten van jou API key reunist_id | is afhankelijk van de rechten van jou API key group_id role - Rol binnen de groep year - Het jaar dat het lid deze rol had
created_at	De timestamp wanneer het record is aangemaakt in de headless (Format Y-m-d H:i:s)
updated_at	De timestamp wanneer het record voor het laatst is geüpdatet (Format: Y-m-d H:i:s)

POST: /groups

Maak een nieuwe group aan.

Key	Beschrijving	Noodzaak
name	Naam van de groep	Optioneel
alias	Een alias van de groep naam	Optioneel
group_type_id	Het id van het gekoppelde groep type	Verplicht
year	Het jaartal waarin de groep is opgericht	Verplicht
website	Website	Optioneel
notes	Prive notitities over de groep	Optioneel
notes_public	Publieke notities over de groep	Optioneel
allow_new_members	Mogen er nieuwe leden toegevoegd worden aan deze groep	Boolean | Optioneel

PUT/PATCH: /groups/{group_id}

Update een specifieke groep

Parameters:

Key	Beschrijving	Noodzaak
name	Naam van de groep	Optioneel
alias	Een alias van de groep naam	Optioneel
group_type_id	Het id van het gekoppelde groep type	Optioneel
year	Het jaartal waarin de groep is opgericht	Optioneel
website	Website	Optioneel
notes	Prive notitities over de groep	Optioneel
notes_public	Publieke notities over de groep	Optioneel
allow_new_members	Mogen er nieuwe leden toegevoegd worden aan deze groep	Boolean | Optioneel

DELETE: /groups/{group_id}

Verwijderd een groep en alle member koppelingen

POST: /groups/{group_id}/link/members

Maakt het mogelijk leden toe te kennen aan een specifieke group.

LET OP: Alle leden/reunisten niet meegegeven zullen worden losgekoppeld.

Parameters:

Key	Beschrijving	Noodzaak
leden_ids	Array van leden_ids. NULL om alle leden te ontkoppelen.	Optioneel
reunisten_ids	Array van reunisten_ids. NULL om alle reunisten te ontkoppelen.	Optioneel

GET: /groups/types

Geeft een lijst terug van alle mogelijk group types