Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop branch weer in line met de master branch. #567

Merged
merged 57 commits into from
Aug 21, 2024
Merged
Changes from 1 commit
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
7ea4cda
Update _config.yml
melsk-r Jan 4, 2024
ead3253
Rename getting-started.md to getting-started-HB.md
melsk-r Jan 4, 2024
6d72ac6
Rename getting-started-IB.md to getting-started.md
melsk-r Jan 4, 2024
b3c7e02
Rename redoc.md to redoc-HB.md
melsk-r Jan 4, 2024
6c930ee
Rename redoc-IB.md to redoc.md
melsk-r Jan 4, 2024
e283547
Rename swagger-ui.md to swagger-ui-HB.md
melsk-r Jan 4, 2024
e8e9471
Rename swagger-ui-IB.md to swagger-ui.md
melsk-r Jan 4, 2024
1b3219e
Rename user-stories-prod.md to user-stories-prod-HB.md
melsk-r Jan 4, 2024
5cf78bd
Rename user-stories-prod-IB.md to user-stories-prod.md
melsk-r Jan 4, 2024
3f0aaf3
Delete docs/user-stories.md
melsk-r Jan 4, 2024
59550ca
Update index.md
melsk-r Jan 4, 2024
2e0d46a
Update index.md
melsk-r Jan 4, 2024
1097c00
Update index.md
melsk-r Jan 4, 2024
428a6fa
Update _config.yml
melsk-r Jan 4, 2024
de967cd
Update getting-started-HB.md
melsk-r Jan 4, 2024
7936587
Update getting-started.md
melsk-r Jan 4, 2024
fa1c193
Update README.md
melsk-r Jan 4, 2024
9b08bf0
Update README.md
melsk-r Jan 4, 2024
9393ade
Update README.md
melsk-r Jan 4, 2024
715f025
Update README.md
melsk-r Jan 4, 2024
5d027b7
Update README.md
melsk-r Jan 4, 2024
fcacd59
Update index.md
melsk-r Jan 8, 2024
ab24de5
Update index.md
melsk-r Jan 8, 2024
897aaa6
Opgeschoond
melsk-r Jan 22, 2024
0c4d4d2
Merge branch 'Opschonen-repository' of https://github.com/VNG-Realisa…
melsk-r Jan 22, 2024
43e0413
Update README.md
melsk-r Jan 22, 2024
c5e7da8
Update README.md
melsk-r Feb 7, 2024
94c40db
Update redoc-HB.md
melsk-r Feb 7, 2024
b9af334
Update swagger-ui-HB.md
melsk-r Feb 7, 2024
8684112
Merge pull request #564 from VNG-Realisatie/Opschonen-repository
melsk-r Feb 8, 2024
0f83580
Update releasenotes.md
melsk-r Feb 8, 2024
c70df3c
Update releasenotes.md
melsk-r Feb 8, 2024
726b2e6
Merge branch 'master' into Check-op-links-en-teksten
melsk-r Feb 8, 2024
290849c
Update user-stories-prod.md
melsk-r Feb 19, 2024
bb41748
Update features.md
melsk-r Feb 19, 2024
4b31c47
Update getting-started-HB.md
melsk-r Feb 19, 2024
0550239
Update goals-canvas.md
melsk-r Feb 19, 2024
18b7bc6
Update index.md
melsk-r Feb 19, 2024
8f16096
Update redoc-HB.md
melsk-r Feb 19, 2024
be15d9a
Update redoc-io.md
melsk-r Feb 19, 2024
41c1bd8
Update swagger-ui-HB.md
melsk-r Feb 19, 2024
a20b543
Update swagger-ui-io.md
melsk-r Feb 19, 2024
e480387
Update user-stories-dev.md
melsk-r Feb 19, 2024
e49393d
Update user-stories-prod-HB.md
melsk-r Feb 19, 2024
af17811
Update user-stories-prod.md
melsk-r Feb 19, 2024
ad1673a
Merge pull request #562 from VNG-Realisatie/Check-op-links-en-teksten
melsk-r Feb 19, 2024
1b6544b
Update getting-started-HB.md
melsk-r Feb 19, 2024
dfb67e4
Update getting-started-HB.md
melsk-r Feb 19, 2024
6830de1
Update index.md
melsk-r Feb 19, 2024
d71ba9d
Update index.md
melsk-r Mar 8, 2024
5051474
Bump follow-redirects from 1.15.4 to 1.15.6
dependabot[bot] Mar 16, 2024
b84ead3
Merge pull request #565 from VNG-Realisatie/dependabot/npm_and_yarn/f…
melsk-r Mar 18, 2024
f54ee8a
Bump braces from 3.0.2 to 3.0.3
dependabot[bot] Jun 16, 2024
fa79d78
Merge pull request #566 from VNG-Realisatie/dependabot/npm_and_yarn/b…
melsk-r Jun 17, 2024
93dc9b2
Update index.md
melsk-r Jun 17, 2024
9b0b81b
Update index.md
melsk-r Jun 19, 2024
61b387a
Resolved security vulnerabilities.
melsk-r Aug 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update getting-started.md
melsk-r authored Jan 4, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 793658719a87e3e05d0e52478a5c43db632a3c74
47 changes: 21 additions & 26 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -24,21 +24,17 @@ De (resolved) OAS3 is hier te downloaden: [openapi.yaml](https://api.bag.kadaste

De API kent de volgende endpoints:

*Woonplaatsen*
*Openbare ruimten*
*Nummeraanduidingen*
*Verblijfsobjecten*
*Standplaatsen*
*Ligplaatsen*
*Panden*
*Bronhouders*


*Adressen*: hierin zijn samenhangende en gerelateerde gegevens samengevoegd uit de nummeraanduiding, openbare ruimte en woonplaats die samen een adres vormen.

*Adressen uitgebreid*: deze resource ondersteunt de mogelijkheid om met één bevraging meer informatie over het adres op te halen, zoals het bouwjaar en de gebruiksoppervlakte.

*Adresseerbare objecten*: dit kan een verblijfsobject, ligplaats of standplaats zijn.
* *Woonplaatsen*
* *Openbare ruimten*
* *Nummeraanduidingen*
* *Verblijfsobjecten*
* *Standplaatsen*
* *Ligplaatsen*
* *Panden*
* *Bronhouders*
* *Adressen*:<br/>hierin zijn samenhangende en gerelateerde gegevens samengevoegd uit de nummeraanduiding, openbare ruimte en woonplaats die samen een adres vormen.
* *Adressen uitgebreid*:<br/>deze resource ondersteunt de mogelijkheid om met één bevraging meer informatie over het adres op te halen, zoals het bouwjaar en de gebruiksoppervlakte.
* *Adresseerbare objecten*:<br/>dit kan een verblijfsobject, ligplaats of standplaats zijn.

De objecten endpoints leveren één of meer (voorkomens van) object(en), met embedded resources en links.

@@ -53,21 +49,21 @@ In de tabel [Wat zit in welk endpoint](https://github.com/lvbag/BAG-API/blob/mas

Er zijn een aantal algemene functies die gelden voor bovenstaande aanvragen:

De expand resource is te gebruiken om binnen een response extra informatie te ontvangen over een van de objecttypen. Zo kan bijvoorbeeld bij een adres de volledige informatie (inclusief registratie tijdstippen) van een openbare ruimte worden opgevraagd door expand=openbareruimte mee te nemen in de bevraging. Voor de werking, zie feature [expand.](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature)
* De expand resource is te gebruiken om binnen een response extra informatie te ontvangen over een van de objecttypen. Zo kan bijvoorbeeld bij een adres de volledige informatie (inclusief registratie tijdstippen) van een openbare ruimte worden opgevraagd door expand=openbareruimte mee te nemen in de bevraging. Voor de werking, zie feature [expand.](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature)

De functionaliteit exacte match biedt de mogelijkheid om een specifiek object te bevragen. Ook wanneer er meerdere objecten aan de opgegeven parameters voldoen. Parameter exacteMatch=true werkt als een filter op de objecten die voldoen aan de opgegeven parameters huisnummer, huisletter en huisnummertoevoeging. De endpoints waar exacte match kan worden toegepast kennen geen fuzzy search. Voor de werking, zie feature [exacte match.](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature)
* De functionaliteit exacte match biedt de mogelijkheid om een specifiek object te bevragen. Ook wanneer er meerdere objecten aan de opgegeven parameters voldoen. Parameter exacteMatch=true werkt als een filter op de objecten die voldoen aan de opgegeven parameters huisnummer, huisletter en huisnummertoevoeging. De endpoints waar exacte match kan worden toegepast kennen geen fuzzy search. Voor de werking, zie feature [exacte match.](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature)

Er wordt paginering gebruikt om het aantal zoekresultaten per zoekvraag te beperken. Met de page parameter kan een volgende pagina worden gevraagd. Met de pageSize parameter kan gekozen worden voor meer of minder zoekresultaten per pagina (standaard is 20, maximum is 100). Voor de werking, zie feature [paginering.](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature)
* Er wordt paginering gebruikt om het aantal zoekresultaten per zoekvraag te beperken. Met de page parameter kan een volgende pagina worden gevraagd. Met de pageSize parameter kan gekozen worden voor meer of minder zoekresultaten per pagina (standaard is 20, maximum is 100). Voor de werking, zie feature [paginering.](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature)

Bij enkele endpoints wordt de mogelijkheid geboden om met de parameter Huidig alleen huidige objecten op te vragen. Huidig betekent dat het object actueel is en geen eindstatus heeft. De endpoints Adressen en Adressen uitgebreid leveren alleen huidige gegevens. Voor meer informatie, zie feature [huidig.](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature)
* Bij enkele endpoints wordt de mogelijkheid geboden om met de parameter Huidig alleen huidige objecten op te vragen. Huidig betekent dat het object actueel is en geen eindstatus heeft. De endpoints Adressen en Adressen uitgebreid leveren alleen huidige gegevens. Voor meer informatie, zie feature [huidig.](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature)

Soms kan een onderzoek lopen naar de juistheid van een gegeven. Er zijn dan twijfels over de juistheid van de geregistreerde waarde. De API levert deze waarde wel, maar neemt die velden dan op in Inonderzoek met de waarde True. Voor de werking, zie feature [Inonderzoek bij adressen en adressenUitgebreid.](https://github.com/lvbag/BAG-API/blob/master/Features/inonderzoek-bij-adressen-en-adressen-uitgebreid.feature)
* Soms kan een onderzoek lopen naar de juistheid van een gegeven. Er zijn dan twijfels over de juistheid van de geregistreerde waarde. De API levert deze waarde wel, maar neemt die velden dan op in Inonderzoek met de waarde True. Voor de werking, zie feature [Inonderzoek bij adressen en adressenUitgebreid.](https://github.com/lvbag/BAG-API/blob/master/Features/inonderzoek-bij-adressen-en-adressen-uitgebreid.feature)

De gegevens die worden geleverd met de endpoints adressen en adressen uitgebreid zijn huidige gegevens. Door middel van de boolean inclusief eindstatus, is het mogelijk om ook adressen te zoeken waarbij één van de bronobjecten (nummeraanduiding, openbare ruimte en woonplaats) een eindstatus heeft.
* De gegevens die worden geleverd met de endpoints adressen en adressen uitgebreid zijn huidige gegevens. Door middel van de boolean inclusief eindstatus, is het mogelijk om ook adressen te zoeken waarbij één van de bronobjecten (nummeraanduiding, openbare ruimte en woonplaats) een eindstatus heeft.

Sommige resources bevatten geometrie. De API ondersteunt op dit moment alleen het RD coördinatenstelsel (epsg:28992). Bij een aanvraag die geometrie teruglevert, moet de request header Accept-Crs worden meegestuurd.
* Sommige resources bevatten geometrie. De API ondersteunt op dit moment alleen het RD coördinatenstelsel (epsg:28992). Bij een aanvraag die geometrie teruglevert, moet de request header Accept-Crs worden meegestuurd.

Bij het zoeken naar panden en adresseerbare objecten kan gebruik worden gemaakt van een boundingbox.
* Bij het zoeken naar panden en adresseerbare objecten kan gebruik worden gemaakt van een boundingbox.

### Uitwerking Use cases

@@ -114,7 +110,6 @@ Het gebruik van de BAG API Individuele Bevragingen is kosteloos. Bij het gebruik
## Implementeer de API client

Client code kan worden gegenereerd met de “[genereervariant](https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml)” van de API-specificaties en een code generator. Een overzicht met codegeneratoren is te vinden op [OpenAPI.Tools.](https://openapi.tools/#sdk)

## Probeer en test de API

De werking van de API is het gemakkelijkst te testen met behulp van [Postman](https://www.getpostman.com/). De [openapi.yaml](https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml) kan je importeren als project, waarna de verschillende requests worden ingeladen die deze API ondersteunt.
@@ -150,8 +145,8 @@ Tip: Je kan ook de [BAG Viewer](https://bagviewer.kadaster.nl/lvbag/bag-viewer/i

De API is te benaderen via de volgende url:

Testomgeving:
**Testomgeving**:
https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2/

Productieomgeving:
**Productieomgeving**:
https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/