DIGITAAL VLAANDEREN
Response codes (POST organisaties/verenigingen/verenigingen/feitelijkeverenigingen - v1)
Algemeen
Voor meer informatie rond de werking van uitzonderingen in RESTful service, wordt verwezen naar Werking en overzicht uitzonderingen MAGDA RESTful services. Op deze pagina zijn de verschillende response codes te vinden en voorbeelden ervan.
Hieronder zijn de dienst specifieke response codes te vinden.
202 Accepted
Bij een succesvol antwoord bevat de response header parameters zoals omschreven op Beschrijving Antwoord (POST organisaties/verenigingen/verenigingen/feitelijkeverenigingen - v1)
400 Bad Request door Verenigingsregister
Indien Verenigingsregister een 400 Bad request doorgeeft, zal MAGDA die doorgeven aan de afnemer waarbij de details van de foutmelding van verenigingsregister worden opgenomen in het detail element
MAGDA | Description | ||
|---|---|---|---|
validationErrors | Validatiefouten | ||
| property name | Array van objects | |
| code |
| |
| reason |
| |
type | URI referentie die het probleem type bepaalt | ||
title | korte omschrijving van het probleem | ||
detail | Specifieke details voor dit probleem, doorgegeven door de bron verenigingsregister | ||
status | HTTP status code komende van de server van de bron | ||
instance | MAGDA instance | ||
{
"validationErrors": {
"contactgegeven.Waarde": [
{
"code": "NotEmptyValidator",
"reason": "'Waarde' mag niet leeg zijn."
}
]
},
"type": "urn:associationregistry.admin.api:validation",
"title": "Er heeft zich een fout voorgedaan!",
"detail": "Source: Validatie mislukt!",
"status": 400,
"instance": "f2eb9c9a-bbae-460b-8107-72f8536bde2d"500 Bad Gateway door Verenigingsregister
Indien er een interne fout is opgetreden bij verenigingsregister
MAGDA | Description |
|---|---|
type | URI referentie die het probleem type bepaalt |
title | Korte omschrijving van het probleem |
status | HTTP status code komende van de server van de bron |
detail | Specifieke details voor dit probleem, doorgegeven door de bron verenigingsregister |
instance | MAGDA instance |
{
"type": "urn:be.vlaanderen.basisregisters.api:internal-server-error",
"title": "Er heeft zich een fout voorgedaan!",
"detail": "Source: <meer informatie over de interne fout>",
"status": 500,
"instance": "f2eb9c9a-bbae-460b-8107-72f8536bde2d"
}
409 Dubbeldetectie bij Verenigingsregister
Bij registratie van een nieuwe feitelijke vereniging wordt gecontroleerd of deze mogelijks al bestaat. Als mogelijke dubbels ontdekt worden, krijg je een status 409 terug. In de response body staat dan de lijst van mogelijke dubbels, maar ook een bevestigingstoken.
Het is de bedoeling dat je gaat verifiëren of de vereniging al dan niet verschillend is van de potentiële dubbels. Om de vereniging alsnog toe te voegen met de gegevens zoals eerder opgegeven, herhaal je dezelfde registreer actie, maar in een request header met naam VR-BevestigingsToken geef je het token mee uit de eerdere respons.
Wanneer het opgegeven token overeenkomt met de inhoud van de request, dan zal de vereniging geregistreerd worden. Komt het token niet overeen, dan krijg je een foutboodschap en status 400 terug.
MAGDA | Description | ||
|---|---|---|---|
bevestigingsToken | Dit token wordt gebruikt als bevestiging dat de vereniging uniek is en geregistreerd mag worden, ondanks de voorgestelde duplicaten | ||
mogelijkeDuplicateVerenigingen | Array of objects Een lijst van verenigingen die mogelijks een duplicaat zijn van de vereniging uit de registreer aanvraag | ||
| vCode | De unieke identificatie code van deze vereniging | |
| naam | Naam van de vereniging | |
| korteNaam | Korte naam van de vereniging | |
| verenigingstype | Type van de vereniging | |
| code | De code van het type van deze vereniging | |
| naam | De beschrijving van het type van deze vereniging | |
| hoofdactiviteitenVerenigingsloket | Array of objects De hoofdactiviteiten van deze vereniging volgens het verenigingsloket | |
|
| code | De code van de hoofdactiviteit |
|
| naam | De beschrijving van de hoofdactiviteit |
| locaties | Array of objects Alle locaties waar deze vereniging actief is | |
| locatietype | Het soort locatie dat beschreven wordt | |
| isPrimair | Duidt aan dat dit de primaire locatie is | |
| adresvoorstelling | Het samengestelde adres van de locatie | |
| naam | Een beschrijvende naam voor de locatie | |
| postcode | De postcode van de locatie | |
| gemeente | De gemeente van de locatie | |
| links | Weblinks i.v.m. deze vereniging | |
| detail | De link naar het beheer detail van de vereniging | |
| magdaDetail | De link naar het beheer detail van de vereniging in MAGDA | |
{"bevestigingsToken":"60-B2-C6-37-83-9D-37-B8-77-73-15-4A-3D-50-BD-3A",
"mogelijkeDuplicateVerenigingen":[{
"vCode":"V0001017",
"naam":"Chocolat",
"korteNaam":"Choco",
"type":{"code":"FV","beschrijving":"Feitelijke vereniging"},
"hoofdactiviteitenVerenigingsloket":[{"code":"BWWC","beschrijving":"Buurtwerking & Wijkcomité"},{"code":"DINT","beschrijving":"Diversiteit & Integratie"},{"code":"GEWE","beschrijving":"Gezondheid & Welzijn"},{"code":"HOSP","beschrijving":"Hobby & Spel"}],
"locaties":[{"locatietype":"Activiteiten","isPrimair":true,"adresvoorstelling":"Straatnddddaam 234 bus 12, 1000 Gemeente, België","naam":"Naam locatie","postcode":"1000","gemeente":"Gemeente"}],
"links":{"detail":"https://beheer.verenigingen.staging-vlaanderen.be/v1/verenigingen/V0001017", "magdaDetail":"organisaties/verenigingen/v0001017"}}]}