Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

De API Key is nog niet actief op de staging omgeving. Voorlopig kan je de publieke API nog gebruiken zonder API Key.

🔜 [v8.1.0.0]

Verbeteringen aan de publieke zoekfunctie

We hebben de publieke zoek functie uitgebreid met 1 extra dataveld en 1 extra mogelijkheid.

Opgelet: deze uitbreidingen zijn enkel toegepast op de publieke zoek functie en niet op de zoekfunctie in de beheer API.

Relaties toegevoegd

We hebben de relaties tussen een afdeling en haar moeder (en omgekeerd) toegevoegd aan de zoekresultaten. Dit maakt het mogelijk om direct een link te tonen vanuit de resultaten en/of om te gaan zoeken op vereniging die een bepaalde relatie hebben met een andere vereniging.

Code Block
languagejson
GET <PubliekURL>/v1/verenigingen/zoeken?q=<zoekcriterium>
{
    "verenigingen": [
        {
            "vCode": "V0001001",
            "type": {
                "code": "AFD",
                "beschrijving": "Afdeling"
            },
            "naam": "Dit is een afdeling",
            ...
            "relaties": [
                {
                    "type": "Is afdeling van",
                    "andereVereniging": {
                        "kboNummer": "0123456789",
                        "vCode": "V0001002",
                        "naam": "Dit is een VZW",
                        "detail": "https://publiek.verenigingen.test-vlaanderen.be/v1/verenigingen/V0001002"
                    }
                }
            ]
            ...
        },
        {
            "vCode": "V0001002",
            "type": {
                "code": "VZW",
                "beschrijving": "Vereniging Zonder Winstoogmerk"
            },
            "naam": "Dit is een VZW",
            ...
            "relaties": [
                {
                    "type": "Heeft als afdeling",
                    "andereVereniging": {
                        "kboNummer": "",
                        "vCode": "V0001001",
                        "naam": "Dit is een afdeling",
                        "detail": "https://publiek.verenigingen.test-vlaanderen.be/v1/verenigingen/V0001001"
                    }
                },
            ],
            ...
        }

Sorteren van de zoek resultaten

De zoek resultaten kunnen gesorteerd worden door het toevoegen van een sort variabele. De zoekvelden waarop kan gesorteerd worden zijn vCode, naam, korteNaam, roepnaam, type.code, type.beschrijving, doelgroep.minimumleeftijd en doelgroep.maximumleeftijd.

Voorbeeld sorteren op naam:

Code Block
languagejson
<PubliekURL>/v1/verenigingen/zoeken?q=*&sort=naam

Wanneer je een sorteerveld opgeeft, wordt er oplopend gesorteerd op dat veld. Je kan de volgorde omdraaien door er een - voor te zetten. Voorbeeld, sorteren op dalende volgorde van naam (namen met een Z komen voor die met een A)

Code Block
languagejson
<PubliekURL>/v1/verenigingen/zoeken?q=*&sort=-naam

Je kan ook meerdere sorteer velden opgeven waardoor er eerst op het eerste veld gesorteerd wordt en daarbinnen dan op het tweede veld. Bijvoorbeeld: eerst sorteren op naam, dan op dalende volgorde van vCode.

Code Block
languagejson
<PubliekURL>/v1/verenigingen/zoeken?q=*&sort=naam,-vCode

Standaard wordt gesorteerd op aflopende volgorde van vCode. De meest recente vereniging wordt dan eerst getoond. (standaard sorteerveld is dus -vCode).

Wanneer je sorteert op velden die niet uniek zijn, dan wordt er binnen elke waarde standaard op aflopende volgorde van vCode gesorteerd. De volgende twee vragen gaan dus hetzelfde resultaat opleveren.

Code Block
languagejson
<PubliekURL>/v1/verenigingen/zoeken?q=*&sort=naam,-vCode
<PubliekURL>/v1/verenigingen/zoeken?q=*&sort=naam

Toevoegen KBO nummer en status aan ACM API

Wanneer ACM de verenigingen voor een bepaalde persoon komt opvragen, gaan we naast de vCode en de naam ook de huidige status van de vereniging meegeven alsook eventueel het kbo-nummer. Dat biedt ACM de mogelijkheid om al dan niet te filteren op actieve verenigingen , maar ook om de KBO-verenigingen uit het verenigingsregister te matchen met de resultaten die een gelijkaardige vraag in het KBO oplevert.

Code Block
languagejson
GET <ACMURL>/v1/verenigingen?insz=<INSZ>
{
    "insz": "00000000196",
    "verenigingen": [
        {
            "vCode": "V0001001",
            "naam": "Deze vereniging is niet meer actief",
            "status": "Gestopt",
            "kboNummer": ""
        },
        {
            "vCode": "V0001002",
            "naam": "Dit is een vereniging uit KBO",
            "status": "Actief",
            "kboNummer": "1234567890"
        }        
    ]
}

Verwijderen oude pad voor registratie van feitelijke verenigingen

De URL om een feitelijke vereniging te registreren werd in een vorige versie al gewijzigd naar

Code Block
languagejson
POST <BeheerURL>/v1/verenigingen/feitelijkeverenigingen

In deze versie werd oude pad (zonder extensie feitelijkeverenigingen ) verwijderd en is dus niet meer bruikbaar.

Verwerking ontvangen feedback

Fix inconsistentie beheer api problemdetails

In de swagger werd op sommige plaatsen nog gebruik gemaakt van Microsoft.AspNetCore.Mvc.ProblemDetails of Microsoft.AspNetCore.Mvc.ValidationProblemDetails. Deze zijn nu verwijderd.

Verwijder nullable uit Swagger doc

In de swagger werden sommmige velden als nullable aangeduid, wat problemen opleverde voor de Magda implementatie. Die nullable vermeldingen zijn overal weggehaald.

Fix: Etag wordt niet aangepast in beheer detail na Patch van een KBO contactgegeven

Na het wijzigen van een KBO contactgegeven (PATCH <BeheerURL>/v1/verenigingen/<vCode>/contactgegevens/kbo/<KBOContactgegevenId>) wordt een Etag in de response header meegegeven. Wanneer we vervolgens het Beheer detail van die vereniging opvragen (GET <BeheerURL>/v1/verenigingen/<vCode>) zien we dat daar de Etag niet werd aangepast.

Tijdstip in Beheer historiek wordt nu in Zulu time formaat getoond

Het tijdstip in beheer historiek werd weergegeven in UTC, maar zonder dit expliciet te vermelden. Een wijziging die om 15u werd uitgevoerd, kwam dus gewoon als 13:00:00 terug. Dit werd makkelijk fout geïnterpreteerd als 13u. Om duidelijk aan te geven hoe dit tijdstip moet geïnterpreteerd worden, wordt het nu in Zulu formaat getoond: 2023-09-28T13:00:00Z

[v7.29.0.0] 📚 Verrijken KBO gegevens, 📚 Stoppen van een vereniging, ⚠️ 📝 Aanpassingen aan swagger

...

Code Block
GET <BeheerURL>/v1/verenigingen/<vCode>
{
  "vCode": "V00010001",
  ...
  "vertegenwoordigers": [
    {
      "vertegenwoordigerId": 1,
      "INSZ": "12345678901",
      "voornaam": "John",
      "achternaam": "Doe",
      ...
    }
  ]
}

Verwerking ontvangen feedback

Wijzigen direct na registratie geeft issue met If-match

...

Locatie type Maatschappelijke zetel (enkel beschikbaar bij het zoeken naar of bij het opvragen van het detail van een vereniging) is hernoemd naar Maatschappelijke zetel volgens KBO

Verwerking ontvangen feedback

Beschrijving in historiek bij beheren van contactgegevens

...