Skip to content

Commit

Permalink
Merge pull request #457 from JohanBoer/documentatie-1.3
Browse files Browse the repository at this point in the history
Documentatie 1.3
  • Loading branch information
JohanBoer authored Sep 23, 2021
2 parents 7abb358 + 3cf8b6d commit 19b953f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,11 @@ Wanneer je alle adressen in een pand wilt zoeken, kan je dit doen met /adressen?

Aangezien dit veel adressen kan opleveren, wordt hier [paginering](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.1.0/features/paginering.feature){:target="_blank"} toegepast.

Met dit endpoint kun je ook zoeken op postcode, huisnummer, huisletter en huisnummertoevoeging.
De manier waarop je met de parameter exacteMatch kunt zoeken, kun je vinden in de feature.

#### Geometrie van een woonplaats
De geometrie van een woonplaats kan zeer omvangrijk zijn. Daarom wordt bij het raadplegen van een woonplaats standaard de geometrie niet meegeleverd. Wanneer je de geometrie van de woonplaats wel geleverd wilt krijgen, dan moet bij de aanvraag de expand parameter worden gebruikt. Bijvoorbeeld /woonplaatsen/2258?expand=geometrie.
De geometrie van een woonplaats kan zeer omvangrijk zijn. Daarom wordt de geometrie niet standaard met een woonplaats meegeleverd. Wanneer je de geometrie van de woonplaats wel wilt krijgen, dan moet je de expand parameter gebruiken. Bijvoorbeeld /woonplaatsen/2258?expand=geometrie.

### Algemene functionaliteit
Verder zijn er nog een paar algemene functies die gelden voor alle bovenstaande aanvragen:
Expand All @@ -84,7 +87,7 @@ We hebben al een project voor je gemaakt die je kan gebruiken: [BAG-Bevragen-pos

### API key
Om de API te kunnen bevragen is een API key nodig. Deze moet je bij het request opnemen in request header "X-Api-Key".
[Vraag een API key voor de productieomgeving aan](https://formulieren.kadaster.nl/aanvraag_bag_api_huidige_bevragingen_productie){:target="_blank"}.
[Vraag een API key voor de productieomgeving aan](https://formulieren.kadaster.nl/aanvraag_bag_api_huidige_bevragingen_productie){:target="_blank"}.

### Testgevallen
Onderstaande tabellen bevatten testgevallen voor specifieke situaties waarmee de werking van de API kan worden getest.
Expand All @@ -106,7 +109,7 @@ Onderstaande tabellen bevatten testgevallen voor specifieke situaties waarmee de
| panden | Met nevenadres | /panden/0014100010921152 |
| panden | Zonder adres | /panden/0503100000034877 |

Tip: Je kan ook de [BAG Viewer](https://bagviewer.kadaster.nl/lvbag/bag-viewer/index.html){:target="_blank"} gebruiken om meer testgevallen te zoeken.
Tip: Je kan ook de [BAG Viewer](https://bagviewer.kadaster.nl/lvbag/bag-viewer/index.html){:target="_blank"} gebruiken om meer testgevallen te zoeken.

### URL
De API is te benaderen via de volgende url: https://api.bag.kadaster.nl/esd/huidigebevragingen/v1.
13 changes: 13 additions & 0 deletions docs/releasenotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ title: Releasenotes

# Release notes BAG Huidige bevragingen API

## Versie 1.3.0 (20-09-2021)
In deze release is een bugfix opgenomen over "mogelijk onjuist" bij een adres. Naast wijzigingen in de API specificaties is een feature-file toegevoegd.

### Opgeloste issues

| Link Github | Beschrijving |
| --- | --- |
| [306](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/306) | Als medewerker gebiedsontwikkeling wil ik op basis van bepaalde kenmerken van appartements-adressen/verblijfsobjecten zoals bouwjaar Pand (en energielabel) in een bepaald gebied kunnen zoeken |
| [370](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/370) | Http status code 415 voor fout "Coördinatenstelsel {crs} in Content-Crs wordt niet ondersteund." incorrect |
| [404](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/404) | Als gebruikers van de API wil ik exact kunnen zoeken zoeken op postcode en huisnummer |



## Versie 1.2.0 (22-06-2021)
In deze release zijn enkele bugs in productie opgelost. Tevens zijn er enkele wijzigingen aan de API-specificaties en de feature-files aangebracht.
Er worden nu adresregels geleverd met daarin het samengestelde adres.
Expand Down

0 comments on commit 19b953f

Please sign in to comment.