ReflexBlue Externe API V2 referentie: Relatiegroepen API
Met de ReflexBlue Externe API V2 raadpleeg je eenvoudig relatiegroepen. Onderstaand vind je een overzicht van de belangrijkste eindpunten waarmee je informatie over relatiegroepen kan opvragen.
Wil je meer technische details over deze API? Bekijk dan de Swagger documentatie.
Gedetailleerde informatie van één relatiegroep opvragen
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/relationgroups/{relationGroupId} |
Gebruik dit eindpunt om alle details van een specifieke relatiegroep op te halen. Dit is handig als je direct de meest recente gegevens van een relatiegroep wilt inzien.
Lijst met relatiegroepen opvragen
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/relationgroups/list |
Gebruik dit eindpunt om een lijst van beschikbare relatiegroepen op te halen. Je kan de resultaten filteren op verschillende criteria. Dit eindpunt is geschikt voor het initiëel vullen van je database of voor het periodiek bijwerken van nieuwe of gewijzigde relatiegroepen.