GET: /leden | Paginated
Geeft een lijst van leden terug.
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:
| Key |
Beschrijving |
| id |
Lid id | unique
|
debit_nr
|
Debiteuren nummer
|
| leden_type_id |
Id van het type uit Exact |
| cash_status |
De contant status van dit lid |
| payment_condition |
De betaalconditie van het lid |
| group_ids |
Een lijst met id's van de groepen waar dit lid toe behoord
|
| initials |
Initialen |
| first_name |
Voornaam |
| last_name |
Achternaam |
| email |
E-mailadres |
| year |
Startjaar bij Minerva |
| gender |
geslacht [m => Man, f => Vrouw, o => Overig/Anders] |
| address |
Adres |
| postal_code |
Postcode |
| city |
Woonplaats |
| country_code |
Landcode in twee letters (ISO 3166-1 alpha-2) |
| phone |
Telefoonnummer algemeen |
| phone_mobile |
Mobiel nummer |
| phone_work |
Werk nummer |
| company |
Werkgever |
| job |
Baan |
| department |
Afdeling werkgever |
| twitter |
Twitter profiel URL |
| linkedin |
Linkedin profiel URL |
| facebook |
Facebook profiel URL |
| website |
Website URL |
| notes |
Extra persoonsnotities |
| 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: /leden/{lid_id}
Geeft een specifiek lid terug met de
objecten van de gekoppelde resources.
Response:
| id |
Lid id | unique
|
debit_nr
|
Debiteuren nummer
|
| leden_type_id |
Id van het type uit Exact |
| leden_type |
Lid type object |
| cash_status |
De contant status van dit lid |
| payment_condition |
De betaalconditie van het lid |
| group_ids |
Een lijst met id's van de groepen waar dit lid toe behoord
|
| group_history |
Een lijst van de groepen historie van het lid. Hierbij bevat een group history entry de
volgende velden:
-
group_id - De identifier van de groep
-
role - Rol binnen de groep
-
year - Het jaar dat het lid deze rol had
|
| initials |
Initialen |
| first_name |
Voornaam |
| last_name |
Achternaam |
| year |
Startjaar bij Minerva |
| gender |
geslacht [m => Man, f => Vrouw, o => Overig/Anders] |
| address |
Adres |
| postal_code |
Postcode |
| city |
Woonplaats |
| country_code |
Landcode in twee letters (ISO 3166-1 alpha-2) |
| phone |
Telefoonnummer algemeen |
| phone_mobile |
Mobiel nummer |
| phone_work |
Werk nummer |
| company |
Werkgever |
| job |
Baan |
| department |
Afdeling werkgever |
| twitter |
Twitter profiel URL |
| linkedin |
Linkedin profiel URL |
| facebook |
Facebook profiel URL |
| website |
Website URL |
| notes |
Extra persoonsnotities |
| 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: /leden
Maak een nieuw lid aan.
| Key |
Beschrijving |
Noodzaak |
debit_nr
|
Debiteuren nummer
|
Verplicht | Unique
|
| leden_type_id |
Id van het type uit Exact |
Optioneel
|
| cash_status |
De contant status van dit lid |
Verplicht | Integer
|
| payment_condition |
De betaalconditie van het lid |
Verplicht | Integer
|
| initials |
Initialen |
Optioneel
|
| first_name |
Voornaam |
Optioneel
|
| last_name |
Achternaam |
Optioneel |
| email |
E-mailadres |
Verplicht
|
| year |
Startjaar bij Minerva |
Verplicht
|
| gender |
geslacht [m => Man, f => Vrouw, o => Overig/Anders] |
Optioneel |
| address |
Adres |
Optioneel |
| postal_code |
Postcode |
Optioneel |
| city |
Woonplaats |
Optioneel |
| country_code |
Landcode in twee letters (ISO 3166-1 alpha-2) |
Optioneel |
| phone |
Telefoonnummer algemeen |
Optioneel
|
| phone_mobile |
Mobiel nummer |
Optioneel
|
| phone_work |
Werk nummer |
Optioneel
|
| company |
Werkgever |
Optioneel
|
| job |
Baan |
Optioneel
|
| department |
Afdeling werkgever |
Optioneel
|
| twitter |
Twitter profiel URL |
Optioneel
|
| linkedin |
Linkedin profiel URL |
Optioneel
|
| facebook |
Facebook profiel URL |
Optioneel
|
| website |
Website URL |
Optioneel
|
| notes |
Extra persoonsnotities |
Optioneel
|
PUT/PATCH: /leden/{lid_id}
Update een lid.
| Key |
Beschrijving |
Noodzaak |
debit_nr
|
Debiteuren nummer
|
Optioneel
|
| leden_type_id |
Id van het type uit Exact |
Optioneel
|
| cash_status |
De contant status van dit lid |
Optioneel
|
| payment_condition |
De betaalconditie van het lid |
Optioneel
|
| initials |
Initialen |
Optioneel
|
| first_name |
Voornaam |
Optioneel
|
| last_name |
Achternaam |
Optioneel
|
| email |
E-mailadres |
Optioneel
|
| year |
Startjaar bij Minerva |
Optioneel
|
| gender |
geslacht [m => Man, f => Vrouw, o => Overig/Anders] |
Optioneel |
| address |
Adres |
Optioneel |
| postal_code |
Postcode |
Optioneel |
| city |
Woonplaats |
Optioneel |
| country_code |
Landcode in twee letters (ISO 3166-1 alpha-2) |
Optioneel |
| phone |
Telefoonnummer algemeen |
Optioneel
|
| phone_mobile |
Mobiel nummer |
Optioneel
|
| phone_work |
Werk nummer |
Optioneel
|
| company |
Werkgever |
Optioneel
|
| job |
Baan |
Optioneel
|
| department |
Afdeling werkgever |
Optioneel
|
| twitter |
Twitter profiel URL |
Optioneel
|
| linkedin |
Linkedin profiel URL |
Optioneel
|
| facebook |
Facebook profiel URL |
Optioneel
|
| website |
Website URL |
Optioneel
|
| notes |
Extra persoonsnotities |
Optioneel
|
DELETE: /leden/{lid_id}
Verwijderd een lid en alle
resource koppelingen.
Een verwijderd lid wordt ge-softdelete. Dit houd in dat het lid niet meer
opgevraagd wordt maar nog wel voor een korte periode bestaat in het systeem. Deze ge-softdelete
leden worden periodiek opgeschoont waarna ze permanent verwijderd worden.
POST: /leden/{lid_id}/link/groups
Maakt het mogelijk groepen
te
linken aan een specifiek lid
LET OP: Alle groepen niet niet meegegeven worden zullen worden
losgekoppeld!
Data:
| Key |
Beschrijving |
Noodzaak |
| group_ids |
Een volledige JSON array met de id's van alle groepen die aan dit lid
gekoppeld zijn.
|
Verplicht |
GET: /leden/deleted
Geeft een lijst terug van de leden welke gemarkeerd staan als verwijderd of welke reünist
geworden zijn.
Response:
|
Key
|
Beschrijving
|
| deleted |
array van objecten met daar in:
-
id - Id van het verwijderde lid
-
deleted_at - Tijdstip waarop het lid is verwijderd (Format: Y-m-d H:i:s)
|
|
reunisten
|
array van objecten met daar in:
-
id - Id van het verwijderde lid
-
reunist_at - Tijdstip waarop de headless door heeft gekregen dat dit lid
reünist wordt (Format: Y-m-d H:i:s)
|
GET: /leden/types
Geeft een lijst terug van alle mogelijk group types