-
Notifications
You must be signed in to change notification settings - Fork 18
/
openapi.yaml
13369 lines (13369 loc) · 552 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: IMBAG API - van de LVBAG
description: "Dit is de [BAG API](https://zakelijk.kadaster.nl/-/bag-api) Individuele\
\ Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen\
\ (LVBAG).\n <br/>\n \
\ Meer informatie over de Basisregistratie Adressen en Gebouwen\
\ is te vinden op de website van het [Ministerie van Binnenlandse Zaken en Koninkrijksrelaties](https://www.geobasisregistraties.nl/basisregistraties/adressen-en-gebouwen)\
\ en [Kadaster](https://zakelijk.kadaster.nl/bag).\n \
\ <br/>\n <br/>\n \
\ De BAG API levert informatie conform de [BAG\
\ Catalogus 2018](https://www.geobasisregistraties.nl/documenten/publicatie/2018/03/12/catalogus-2018)\
\ en het informatiemodel IMBAG 2.0.\n De\
\ API specificatie volgt de [Nederlandse API-Strategie](https://docs.geostandaarden.nl/api/API-Strategie)\
\ specificatie versie van 20200204 en is opgesteld in [OpenAPI Specificatie](https://www.forumstandaardisatie.nl/standaard/openapi-specification)\
\ (OAS) v3.\n <br/>\n \
\ Het standaard mediatype HAL (`application/hal+json`) wordt\
\ gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties\
\ via hyperlinks.\n <br/>\n \
\ <br/>\n Deze\
\ API is vooral gericht op individuele bevragingen (op basis van de identificerende\
\ gegevens van een object).\n Om gebruik\
\ te kunnen maken van de BAG API is een API key nodig, deze kan verkregen worden\
\ door het [aanvraagformulier](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie)\
\ in te vullen.\n <br/>\n \
\ <br/>\n Voor\
\ vragen, neem contact op met de LVBAG beheerder o.v.v. BAG API 2.0. We zijn aan\
\ het kijken naar een geschikt medium hiervoor, mede ook om de API iteratief te\
\ kunnen opstellen of doorontwikkelen samen met de community. Als de API iets\
\ (nog) niet kan, wat u wel graag wilt, neem dan contact op."
termsOfService: '"https://zakelijk.kadaster.nl/algemene-voorwaarden"'
contact:
name: Kadaster - Beheerder LVBAG
url: https://zakelijk.kadaster.nl/bag
license:
name: "European Union Public License, version 1.2 (EUPL-1.2)"
url: https://eupl.eu/1.2/nl/
version: 2.0.0
servers:
- url: https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2
description: LVBAG - ACCEPTATIE
- url: https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2
description: LVBAG - PRODUCTIE
security:
- apiKeyBAG: []
tags:
- name: Adresseerbaar object
description: Dit endpoint levert één of meer (voorkomens van) adresseerbare objecten
met embedded resources en links.
- name: Adres
description: "Deze services leveren één of meer huidige adressen, met embedded resources\
\ en links. Huidig betekent dat het adres actueel is en geen eind status heeft.\
\ Voor een toelichting zie de [Praktijkhandleiding BAG](https://imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens)."
- name: Adres uitgebreid
description: "Deze service levert uitgebreide informatie van één of meer huidige\
\ adressen, met embedded resources en links. Huidig betekent dat het adres actueel\
\ is en geen eind status heeft. Voor een toelichting zie de [Praktijkhandleiding\
\ BAG](https://imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens)."
- name: Algemene informatie
description: Het endpoint voor algemene informatie levert informatie op van de API.
- name: Bronhouder
description: Dit endpoint levert één of meer bronhouder(s).
- name: Ligplaats
description: "Dit endpoint levert één of meer (voorkomens van) ligplaats(en), met\
\ embedded resources en links."
- name: Nummeraanduiding
description: "Dit endpoint levert één of meer (voorkomens van) nummeraanduiding(en),\
\ met embedded resources en links."
- name: Openbare ruimte
description: "Dit endpoint levert één of meer (voorkomens van) openbare ruimte(n),\
\ met embedded resources en links."
- name: Pand
description: "Dit endpoint levert één of meer (voorkomens van) pand(en), met embedded\
\ resources en links."
- name: Standplaats
description: "Dit endpoint levert één of meer (voorkomens van) standplaats(en),\
\ met embedded resources en links."
- name: Verblijfsobject
description: "Dit endpoint levert één of meer (voorkomens van) verblijfsobject(en),\
\ met embedded resources en links."
- name: Woonplaats
description: "Dit endpoint levert één of meer (voorkomens van) woonplaats(en), met\
\ embedded resources en links."
paths:
/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}:
get:
tags:
- Adresseerbaar object
summary: Bevragen van één adresseerbaar object met een adresseerbaar object
identificatie.
description: "Bevragen van één adresseerbaar object (ligplaats, standplaats\
\ of verblijfsobject) met de identificatie van een adresseerbaar object. Als\
\ geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens\
\ geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan\
\ (of een combinatie daarvan) of als expand=true, dan worden de gevraagde\
\ of alle gerelateerde resources als geneste resource geleverd."
operationId: bevragenAdresseerbaarObject
parameters:
- name: adresseerbaarObjectIdentificatie
in: path
description: Identificatie van een object uit de BAG. Deze is 4 lang bij een
woonplaats en 16 lang bij de andere objecten.
required: true
style: simple
explode: false
schema:
title: identificatie van adresseerbaar object
pattern: "^[0-9]{4}(01|02|03)[0-9]{10}$"
type: string
example: "0226010000038820"
- name: geldigOp
in: query
description: "Filtert op objecten die geldig zijn op de opgegeven datum 'YYYY-MM-DD'\
\ Deze parameters komen uit de API strategie, het hoofdstuk [tijdreizen](https://docs.geostandaarden.nl/api/API-Strategie/#tijdreizen)\n"
required: false
style: form
explode: true
schema:
type: string
format: date
example: 2019-06-01
- name: beschikbaarOp
in: query
description: "Filtert op objecten die beschikbaar zijn gekomen op de opgegeven\
\ datum en tijd `YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss'\
\ en milliseconden '.sss' of alleen de milliseconden conform ISO 8601 specificatie\
\ worden weggelaten, in dat geval krijgen deze automatisch de waarde ':00'\
\ respectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan\
\ 3 cijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\
\ Deze parameters komen uit de API strategie, het hoofdstuk [tijdreizen](https://docs.geostandaarden.nl/api/API-Strategie/#tijdreizen)\n"
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: expand
in: query
description: "Hier kan aangegeven worden welke gerelateerde resources meegeladen\
\ moeten worden. Resources en velden van resources die gewenst zijn kunnen\
\ in de expand parameter kommagescheiden worden opgegeven. Specifieke velden\
\ van resource kunnen worden opgegeven door het opgeven van de resource-naam\
\ gevolgd door de veldnaam, met daartussen een punt."
required: false
style: form
explode: true
schema:
type: string
- name: Accept-Crs
in: header
description: Gewenste CRS van de co�rdinaten in de response.
required: false
style: simple
explode: false
schema:
type: string
description: CRS van de co�rdinaten in de response.
enum:
- epsg:28992
responses:
"200":
description: "Bevraging bevragenAdresseerbaarObject geslaagd geslaagd. Ondanks\
\ dat er in de example een voorbeeld van alle mogelijke adresseerbare\
\ objecten (ligplaats, standplaats of verblijfspobject) staat, wordt er\
\ altijd slechts één van deze objecten geretourneerd."
headers:
api-version:
$ref: '#/components/headers/api_version'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/AdresseerbaarObjectIOHal'
"400":
description: Bad request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 400
title: Ten minste één parameter moet worden opgegeven.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1
400 Bad Request
detail: The request could not be understood by the server due to malformed
syntax. The client SHOULD NOT repeat the request without modification.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: paramsRequired
invalid-params:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats_huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key`
header meegestuurd.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 401
title: Niet correct geauthenticeerd.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2
401 Unauthorized
detail: The request requires user authentication. The response MUST
include a WWW-Authenticate header field (section 14.47) containing
a challenge applicable to the requested resource.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: authentication
"403":
description: Forbidden. Je hebt geen rechten om deze URL te benaderen.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 403
title: U bent niet geautoriseerd voor deze operatie.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4
403 Forbidden
detail: "The server understood the request, but is refusing to fulfill\
\ it."
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: autorisation
"404":
description: Not found.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 404
title: Opgevraagde resource bestaat niet.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5
404 Not Found
detail: The server has not found anything matching the Request-URI.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notFound
"406":
description: Not Acceptable. Je hebt waarschijnlijk een gewenst formaat
met de `Accept` header verstuurd welke niet ondersteund wordt.
headers:
api-version:
$ref: '#/components/headers/api_version'
acceptCrs:
$ref: '#/components/headers/acceptCrs'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 406
title: Gevraagde contenttype wordt niet ondersteund.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7
406 Not Acceptable
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to the accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"412":
description: Precondition failed.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 412
title: Niet voldaan aan vooraf gestelde voorwaarde
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13
412 Precondition Failed
detail: The precondition given in one or more of the request-header
fields evaluated to false when it was tested on the server.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: preconditionFailed
"500":
description: Internal server error.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 500
title: Interne server fout.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1
500 Internal server error
detail: The server encountered an unexpected condition which prevented
it from fulfilling the request.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: serverError
"503":
description: Service Unavailable. Er vindt mogelijk (gepland) onderhoud
of een storing plaats.
headers:
api-version:
$ref: '#/components/headers/api_version'
Retry-After:
description: Tijdstip waarop verwacht wordt dat de service weer beschikbaar
zal zijn.
style: simple
explode: false
schema:
type: string
format: date-time
x-example: "Sun, 28 Nov 2017 16:41:41 GMT"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 503
title: "Bronservice {bron} is tijdelijk niet beschikbaar."
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4
503 Service Unavailable
detail: The service is currently unable to handle the request due
to a temporary overloading or maintenance of the server.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAvailable
default:
description: Er is een onverwachte fout opgetreden.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
security:
- apiKeyBAG: []
/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}/lvc:
get:
tags:
- Adresseerbaar object
summary: Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar
object identificatie.
description: "Bevragen van de levenscyclus van een adresseerbaar object (ligplaats,\
\ standplaats of verblijfsobject) met de identificatie van een adresseerbaar\
\ object. Met de geheleLvc parameter kan worden aangegeven of de gehele levenscyclus\
\ (inclusief voorkomens die uit de geldige levenscyclus zijn verwijderd) of\
\ alleen de actieve levenscyclus (alleen de voorkomens die onderdeel zijn\
\ van de geldige levenscyclus) gewenst zijn. "
operationId: bevragenAdresseerbaarObjectLvc
parameters:
- name: adresseerbaarObjectIdentificatie
in: path
description: Identificatie van een object uit de BAG. Deze is 4 lang bij een
woonplaats en 16 lang bij de andere objecten.
required: true
style: simple
explode: false
schema:
title: identificatie van adresseerbaar object
pattern: "^[0-9]{4}(01|02|03)[0-9]{10}$"
type: string
example: "0226010000038820"
- name: geheleLvc
in: query
description: |
Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd. Als deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false).
required: false
style: form
explode: true
schema:
type: boolean
example: true
default: false
- name: Accept-Crs
in: header
description: Gewenste CRS van de co�rdinaten in de response.
required: false
style: simple
explode: false
schema:
type: string
description: CRS van de co�rdinaten in de response.
enum:
- epsg:28992
responses:
"200":
description: "Bevraging bevragenAdresseerbaarObjectLvc geslaagd. Ondanks\
\ dat er in de example een voorbeeld van alle mogelijke adresseerbare\
\ objecten (ligplaats, standplaats of verblijfspobject) staat, wordt er\
\ altijd slechts één van deze objecten geretourneerd."
headers:
api-version:
$ref: '#/components/headers/api_version'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/AdresseerbaarObjectLvcIOHalCollection'
"400":
description: Bad request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 400
title: Ten minste één parameter moet worden opgegeven.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1
400 Bad Request
detail: The request could not be understood by the server due to malformed
syntax. The client SHOULD NOT repeat the request without modification.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: paramsRequired
invalid-params:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats_huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key`
header meegestuurd.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 401
title: Niet correct geauthenticeerd.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2
401 Unauthorized
detail: The request requires user authentication. The response MUST
include a WWW-Authenticate header field (section 14.47) containing
a challenge applicable to the requested resource.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: authentication
"403":
description: Forbidden. Je hebt geen rechten om deze URL te benaderen.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 403
title: U bent niet geautoriseerd voor deze operatie.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4
403 Forbidden
detail: "The server understood the request, but is refusing to fulfill\
\ it."
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: autorisation
"404":
description: Not found.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 404
title: Opgevraagde resource bestaat niet.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5
404 Not Found
detail: The server has not found anything matching the Request-URI.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notFound
"406":
description: Not Acceptable. Je hebt waarschijnlijk een gewenst formaat
met de `Accept` header verstuurd welke niet ondersteund wordt.
headers:
api-version:
$ref: '#/components/headers/api_version'
acceptCrs:
$ref: '#/components/headers/acceptCrs'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 406
title: Gevraagde contenttype wordt niet ondersteund.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7
406 Not Acceptable
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to the accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"412":
description: Precondition failed.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 412
title: Niet voldaan aan vooraf gestelde voorwaarde
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13
412 Precondition Failed
detail: The precondition given in one or more of the request-header
fields evaluated to false when it was tested on the server.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: preconditionFailed
"500":
description: Internal server error.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 500
title: Interne server fout.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1
500 Internal server error
detail: The server encountered an unexpected condition which prevented
it from fulfilling the request.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: serverError
"503":
description: Service Unavailable. Er vindt mogelijk (gepland) onderhoud
of een storing plaats.
headers:
api-version:
$ref: '#/components/headers/api_version'
Retry-After:
description: Tijdstip waarop verwacht wordt dat de service weer beschikbaar
zal zijn.
style: simple
explode: false
schema:
type: string
format: date-time
x-example: "Sun, 28 Nov 2017 16:41:41 GMT"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 503
title: "Bronservice {bron} is tijdelijk niet beschikbaar."
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4
503 Service Unavailable
detail: The service is currently unable to handle the request due
to a temporary overloading or maintenance of the server.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAvailable
default:
description: Er is een onverwachte fout opgetreden.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
security:
- apiKeyBAG: []
/adresseerbareobjecten:
get:
tags:
- Adresseerbaar object
summary: Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding
identificatie.
description: "Bevragen/zoeken van alle aan een nummeraanduiding identificatie\
\ gerelateerde adresseerbare objecten (ligplaats, standplaats of verblijfsobject).\
\ Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp\
\ niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres,\
\ heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true,\
\ dan worden de gevraagde of alle gerelateerde resources als geneste resource\
\ geleverd."
operationId: zoekAdresseerbaarObject
parameters:
- name: nummeraanduidingIdentificatie
in: query
description: Identificatie van een object uit de BAG. Deze is 4 lang bij een
woonplaats en 16 lang bij de andere objecten.
required: false
style: form
explode: true
schema:
pattern: "^[0-9]{4}20[0-9]{10}$"
type: string
example: "0226200000038923"
- name: huidig
in: query
description: Indicatie dat alleen actuele object voorkomens zonder eindstatus
gewenst zijn.
required: false
style: form
explode: true
schema:
type: boolean
example: false
default: false
- name: geldigOp
in: query
description: "Filtert op objecten die geldig zijn op de opgegeven datum 'YYYY-MM-DD'\
\ Deze parameters komen uit de API strategie, het hoofdstuk [tijdreizen](https://docs.geostandaarden.nl/api/API-Strategie/#tijdreizen)\n"
required: false
style: form
explode: true
schema:
type: string
format: date
example: 2019-06-01
- name: beschikbaarOp
in: query
description: "Filtert op objecten die beschikbaar zijn gekomen op de opgegeven\
\ datum en tijd `YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss'\
\ en milliseconden '.sss' of alleen de milliseconden conform ISO 8601 specificatie\
\ worden weggelaten, in dat geval krijgen deze automatisch de waarde ':00'\
\ respectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan\
\ 3 cijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\
\ Deze parameters komen uit de API strategie, het hoofdstuk [tijdreizen](https://docs.geostandaarden.nl/api/API-Strategie/#tijdreizen)\n"
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: expand
in: query
description: "Hier kan aangegeven worden welke gerelateerde resources meegeladen\
\ moeten worden. Resources en velden van resources die gewenst zijn kunnen\
\ in de expand parameter kommagescheiden worden opgegeven. Specifieke velden\
\ van resource kunnen worden opgegeven door het opgeven van de resource-naam\
\ gevolgd door de veldnaam, met daartussen een punt."
required: false
style: form
explode: true
schema:
type: string
- name: Accept-Crs
in: header
description: Gewenste CRS van de co�rdinaten in de response.
required: false
style: simple
explode: false
schema:
type: string
description: CRS van de co�rdinaten in de response.
enum:
- epsg:28992
responses:
"200":
description: "Bevraging zoekAdresseerbaarObject geslaagd. Ondanks dat er\
\ in de example een voorbeeld van alle mogelijke adresseerbare objecten\
\ (ligplaats, standplaats of verblijfspobject) staat, wordt er altijd\
\ slechts één van deze objecten geretourneerd."
headers:
api-version:
$ref: '#/components/headers/api_version'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/AdresseerbareObjectenIOHalCollection'
"400":
description: Bad request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 400
title: Ten minste één parameter moet worden opgegeven.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1
400 Bad Request
detail: The request could not be understood by the server due to malformed
syntax. The client SHOULD NOT repeat the request without modification.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: paramsRequired
invalid-params:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats_huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key`
header meegestuurd.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 401
title: Niet correct geauthenticeerd.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2
401 Unauthorized
detail: The request requires user authentication. The response MUST
include a WWW-Authenticate header field (section 14.47) containing
a challenge applicable to the requested resource.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: authentication
"403":
description: Forbidden. Je hebt geen rechten om deze URL te benaderen.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 403
title: U bent niet geautoriseerd voor deze operatie.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4
403 Forbidden
detail: "The server understood the request, but is refusing to fulfill\
\ it."
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: autorisation
"406":
description: Not Acceptable. Je hebt waarschijnlijk een gewenst formaat
met de `Accept` header verstuurd welke niet ondersteund wordt.
headers:
api-version:
$ref: '#/components/headers/api_version'
acceptCrs:
$ref: '#/components/headers/acceptCrs'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 406
title: Gevraagde contenttype wordt niet ondersteund.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7
406 Not Acceptable
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to the accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"412":
description: Precondition failed.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 412
title: Niet voldaan aan vooraf gestelde voorwaarde
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13
412 Precondition Failed
detail: The precondition given in one or more of the request-header
fields evaluated to false when it was tested on the server.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: preconditionFailed
"500":
description: Internal server error.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 500
title: Interne server fout.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1
500 Internal server error
detail: The server encountered an unexpected condition which prevented
it from fulfilling the request.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: serverError
"503":
description: Service Unavailable. Er vindt mogelijk (gepland) onderhoud
of een storing plaats.
headers:
api-version:
$ref: '#/components/headers/api_version'
Retry-After:
description: Tijdstip waarop verwacht wordt dat de service weer beschikbaar
zal zijn.
style: simple
explode: false
schema:
type: string
format: date-time
x-example: "Sun, 28 Nov 2017 16:41:41 GMT"
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 503
title: "Bronservice {bron} is tijdelijk niet beschikbaar."
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4
503 Service Unavailable
detail: The service is currently unable to handle the request due
to a temporary overloading or maintenance of the server.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAvailable
default:
description: Er is een onverwachte fout opgetreden.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
security:
- apiKeyBAG: []
/adressen/zoek:
get:
tags:
- Adres
summary: Zoeken van huidige adressen
description: "Zoeken van huidige adressen met postcode, woonplaats, straatnaam,\
\ huisnummer, huisletter, huisnummertoevoeging. Een adres kan worden gevonden\
\ door de zoekresultaatidentificatie uit het antwoord als parameter mee te\
\ geven in get /adressen. Voor paginering, zie: [functionele specificatie\
\ paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature)."
operationId: zoek
parameters:
- name: zoek
in: query
description: "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,\
\ huisnummertoevoeging"
required: true
style: form
explode: true
schema:
maxLength: 255
minLength: 1
type: string
- name: page
in: query
description: Pagina nummer
required: false
style: form
explode: true
schema:
minimum: 1
type: integer
default: 1
- name: pageSize
in: query
description: Aantal resultaten per pagina
required: false
style: form
explode: true
schema:
maximum: 100
minimum: 10
type: integer
default: 20
responses:
"200":
description: Zoek adres geslaagd
headers:
api-version:
$ref: '#/components/headers/api_version'
warning:
$ref: '#/components/headers/warning'
X-Pagination-Page:
$ref: '#/components/headers/X_Pagination_Page'
X-Pagination-Limit:
$ref: '#/components/headers/X_Pagination_Limit'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ZoekResultaatHalCollection'
"400":
description: Bad request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 400
title: Ten minste één parameter moet worden opgegeven.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1
400 Bad Request
detail: The request could not be understood by the server due to malformed
syntax. The client SHOULD NOT repeat the request without modification.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: paramsRequired
invalid-params:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats_huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key`
header meegestuurd.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 401
title: Niet correct geauthenticeerd.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2
401 Unauthorized
detail: The request requires user authentication. The response MUST
include a WWW-Authenticate header field (section 14.47) containing
a challenge applicable to the requested resource.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: authentication
"403":
description: Forbidden. Je hebt geen rechten om deze URL te benaderen.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 403
title: U bent niet geautoriseerd voor deze operatie.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4
403 Forbidden
detail: "The server understood the request, but is refusing to fulfill\
\ it."
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: autorisation
"500":
description: Internal server error.
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
status: 500
title: Interne server fout.
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1
500 Internal server error
detail: The server encountered an unexpected condition which prevented
it from fulfilling the request.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: serverError
"503":
description: Service Unavailable. Er vindt mogelijk (gepland) onderhoud
of een storing plaats.
headers:
api-version:
$ref: '#/components/headers/api_version'
Retry-After:
description: Tijdstip waarop verwacht wordt dat de service weer beschikbaar
zal zijn.
style: simple
explode: false
schema:
type: string
format: date-time
x-example: "Sun, 28 Nov 2017 16:41:41 GMT"