Authenticatie
Geef een API token mee in een GET parameter genaamd 'api_token={api_token}'. Deze API token is persoonsgebonden en kan worden aangevraagd via support@projectie.com
Request limiet
Er is een limiet voor het doen van aanvragen naar een API resource. Er mag per resource een maximum van 60 requests per minuut gedaan worden. Bij iedere request worden de volgende headers in de response mee gegeven
| x-ratelimit-limit | Hoeveelheid requests die per minuut gedaan mogen worden |
| x-ratelimit-remaining | Hoeveelheid requests die nog gedaan mogen worden deze minuut.
|
Als de limiet wordt overschreven zal er een extra header worden terug gegeven.
| retry-after | De hoeveelheid tijd in seconden die gewacht moet worden voordat de request opnieuw uitgevoerd mag worden |
Pagination
Sommige resultaten worden opgedeelt in pagina's. Deze urls zijn aangegeven doordat er | Paginated achter de beschrijving staat. Er kan gewisseld worden van pagina door een GET parameter genaamd 'page={pagina_nummer}' mee te geven
De volgende parameters kunnen meegegeven worden om de pagination te beinvloeden
| page | Geef aan welke pagina teruggegeven moet worden |
| per_page | Kies hoeveel items er per pagina getoond worden | Maximaal 100 |
GET: /groups | Paginated
Geeft een lijst terug met alle groeps erin.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 gevenParameters:
| Key | Beschrijving | Noodzaak |
| changes_since | De timestamp vanaf wanneer je de veranderingen wilt terug krijgen | optioneel |
| 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 leden toegevoegd worden aan deze groep |
| member_ids | Een lijst van alle leden binnen deze groep |
GET: /groups/{groups_id}
Geeft een specifieke group terug met de daaraan gekoppelde leden en statussen.| 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 |
| member_ids | Een lijst van alle leden binnen deze groep |
PUT/PATCH: /groups/{groups_id}
Update een specifieke groep| 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
|
POST: /groups/{groups_id}/link/members
Maakt het mogelijk leden te linken aan een specifieke groep.
LET OP: Alle leden niet niet meegegeven worden zullen worden losgekoppeld!
Data:
| Key | Noodzaak | beschrijving |
| member_ids | Verplicht | Een volledige JSON array met de id's van alle leden die aan een groep gekoppeld zijn. |
DELETE: /groups/{groups_id}
Verwijderd een groep en alle member koppelingen
