Beschrijving Antwoord (GET organisaties/verenigingen/verenigingen/zoeken - v1)
Algemeen
Het antwoord van deze dienst bevat een lijst van verenigingen, @context en metadata.
Detail
Antwoord in detail
Element | Beschrijving | Opmerkingen | ||
---|---|---|---|---|
@context | De JSON-LD open data context |
| ||
verenigingen | Dit is de lijst van verenigingen die het resultaat van de zoekopdracht zijn | array van objects | ||
| @type | De json-ld id |
| |
| vCode | De unieke code van de vereniging |
| |
| verenigingstype | Het type van de vereniging |
| |
|
| code | De code van het type vereniging |
|
|
| naam | De beschrijving van het type vereniging |
|
| naam | De naam van de vereniging |
| |
| roepnaam | Roepnaam van de vereniging. Dit veld is enkel aanwezig bij verenigingen met rechtspersoonlijkheid |
| |
| korteNaam | De korte naam van de vereniging. |
| |
| korteBeschrijving | Korte beschrijving van de vereniging |
| |
| startdatum | Datum waarop de vereniging gestart is | binnenkort beschikbaar | |
| einddatum | Datum waarop de vereniging gestopt is | binnenkort beschikbaar | |
| status | Status van de vereniging met mogelijke waardes: Actief, Gestopt |
| |
| isUitgeschrevenUitPubliekeDatastroom |
|
| |
| contactgegevens |
|
| |
| vertegenwoordigers |
|
| |
| doelgroep | De doelgroep waar de activiteiten van deze vereniging zich op concentreert |
| |
|
| @id | De json-ld id |
|
|
| @type | Het json-ld type |
|
|
| minimumleeftijd | De minimum leeftijd voor de doelgroep |
|
|
| maximumleeftijd | De maximum leeftijd voor de doelgroep |
|
| hoofdactiviteitenVerenigingsloket | De lijst van hoofdactiviteiten erkend door het verenigingsloket | array van objects | |
|
| @id | De json-ld id |
|
|
| @type | Het json-ld type |
|
|
| code | De verkorte code van de hoofdactiviteit |
|
|
| naam | De volledige beschrijving van de hoofdactiviteit |
|
| locaties |
| array van objects | |
|
| @id | De json-ld id |
|
|
| @type | Het json-ld type |
|
|
| locatietype | Het soort locatie dat beschreven wordt met de mogelijke waarden:
|
|
|
| isPrimair | Het geeft aan dat de locatie een primaire locatie is van deze vereniging |
|
|
| adresvoorstelling | De volldedige adresvoorstelling van de locatie |
|
|
| naam | De naam van de locatie |
|
|
| postcode | De postcode van de locatie |
|
|
| gemeente | De gemeente waarin de locatie ligt |
|
| sleutels | De sleutels van deze vereniging | array van objects | |
|
| @id | De json-ld id |
|
|
| @type | Het json-ld type |
|
|
| bron | De bron van de sleutel |
|
|
| waarde | De externe identificator van de vereniging in de bron |
|
| links | Weblinks ivm deze vereniging |
| |
|
| detail | De link naar het beheer detail van de vereniging bij verenigingsregister |
|
|
| magdaDetail | De link naar het beheer detail van de vereniging bij MAGDA |
|
metadata | In deze metadata bevat alle relevante metadata voor de zoekopdracht, paginering informatie. |
| ||
| pagination | De paginatie metadata |
| |
|
| totalCount | Het totaal aantal verenigingen dat voldoet aan de zoekcriteria. |
|
|
| offset | Het aantal overgeslagen resultaten. |
|
|
| limit | Het maximum aantal teruggegeven resultaten |
|
Voorbeeld
GET organisaties/verenigingen/verenigingen/zoeken?q=doelgroep.maximumleeftijd:100&limit=5
header X-Correlation-Id : "761c1f36-bd5f-4f7c-b32f-16045cccc9ee"
{
"@context": "https://publiek.verenigingen.staging-vlaanderen.be/v1/contexten/beheer/zoek-verenigingen-context.json",
"verenigingen": [
{
"@type": "fei:FeitelijkeVerenigingen",
"vCode": "V0001032",
"verenigingstype": {
"code": "FV",
"naam": "Feitelijke vereniging"
},
"naam": "Test MAGDA patches",
"korteNaam": "MAGDA",
"status": "Actief",
"doelgroep": {
"@id": "doel:988f76ab-f295-51d7-af20-edbc4c010b36",
"@type": "verenigingen_ext:Doelgroep",
"minimumleeftijd": 0,
"maximumleeftijd": 100
},
"hoofdactiviteitenVerenigingsloket": [
{
"@id": "act:68023564-66df-5717-beb8-d974fc7da114",
"@type": "skos:Concept",
"code": "BWWC",
"naam": "Buurtwerking & Wijkcomité"
},
{
"@id": "act:1e562652-7c0c-5db6-bfcd-c6d195b9c784",
"@type": "skos:Concept",
"code": "DINT",
"naam": "Diversiteit & Integratie"
},
{
"@id": "act:7d2f1817-a098-5cdd-aa8b-7393fd71a9fc",
"@type": "skos:Concept",
"code": "HOSP",
"naam": "Hobby & Spel"
}
],
"locaties": [
{
"@id": "loc:6f59d980-0ceb-5cf7-b5ec-c67f431f0563",
"@type": "org:Site",
"locatietype": "Activiteiten",
"isPrimair": true,
"adresvoorstelling": "Straatndddddddaam 234 bus 12, 1000 Gemeente, België",
"naam": "Naam locatie",
"postcode": "1000",
"gemeente": "Gemeente"
}
],
"sleutels": [
{
"@id": "identificatoren:c281398d-6ae0-5c14-a1c6-40a67fc9cda6",
"@type": "adms:Identifier",
"bron": "Vcode",
"waarde": "V0001032",
"codeerSysteem": "Vcode",
"gestructureerdeIdentificator": {
"@id": "ges:628bdf8a-c90c-5c64-b280-95fc6c69c4f9",
"@type": "generiek:GestructureerdeIdentificator",
"nummer": "V0001032"
}
}
],
"links": {
"detail": "https://beheer.verenigingen.staging-vlaanderen.be/v1/verenigingen/V0001032"
"magdaDetail": "/organisaties/verenigingen/verenigingen/V0001032"
}
},
{
"@type": "fei:FeitelijkeVerenigingen",
"vCode": "V0001031",
"verenigingstype": {
"code": "FV",
"naam": "Feitelijke vereniging"
},
"naam": "Chocolat Biscuit",
"korteNaam": "Choco",
"status": "Actief",
"doelgroep": {
"@id": "doel:822da1f9-21b6-563d-a778-f094e171bb79",
"@type": "verenigingen_ext:Doelgroep",
"minimumleeftijd": 0,
"maximumleeftijd": 100
},
"hoofdactiviteitenVerenigingsloket": [
{
"@id": "act:68023564-66df-5717-beb8-d974fc7da114",
"@type": "skos:Concept",
"code": "BWWC",
"naam": "Buurtwerking & Wijkcomité"
},
{
"@id": "act:1e562652-7c0c-5db6-bfcd-c6d195b9c784",
"@type": "skos:Concept",
"code": "DINT",
"naam": "Diversiteit & Integratie"
},
{
"@id": "act:08abc36c-2ac4-5efc-844c-17686bf327c2",
"@type": "skos:Concept",
"code": "GEWE",
"naam": "Gezondheid & Welzijn"
},
{
"@id": "act:7d2f1817-a098-5cdd-aa8b-7393fd71a9fc",
"@type": "skos:Concept",
"code": "HOSP",
"naam": "Hobby & Spel"
}
],
"locaties": [
{
"@id": "loc:839fe85a-a9f4-5109-a287-afc8abd65ff3",
"@type": "org:Site",
"locatietype": "Activiteiten",
"isPrimair": true,
"adresvoorstelling": "Straatnddddaam 234 bus 12, 1000 Gemeente, België",
"naam": "Naam locatie",
"postcode": "1000",
"gemeente": "Gemeente"
}
],
"sleutels": [
{
"@id": "identificatoren:3fa4b88f-c940-5359-99fa-76fa9b5d3c43",
"@type": "adms:Identifier",
"bron": "Vcode",
"waarde": "V0001031",
"codeerSysteem": "Vcode",
"gestructureerdeIdentificator": {
"@id": "ges:21f77ad4-eee4-5c25-8424-0111a1f80927",
"@type": "generiek:GestructureerdeIdentificator",
"nummer": "V0001031"
}
}
],
"links": {
"detail": "https://beheer.verenigingen.staging-vlaanderen.be/v1/verenigingen/V0001031"
"magdaDetail": "/organisaties/verenigingen/verenigingen/V0001031"
}
}
],
"metadata": {
"pagination": {
"totalCount": 2,
"offset": 0,
"limit": 5
}
}
}
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen