-
Notifications
You must be signed in to change notification settings - Fork 15
/
openapi.yaml
4861 lines (4829 loc) · 203 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: Kadaster - BRK-Bevragen API
description: |
D.m.v. deze toepassing worden meerdere, korte bevragingen op de Basis Registratie Kadaster beschikbaar gesteld.
Deze toepassing betreft het verstrekken van Kadastrale Onroerende Zaak informatie.
contact:
name: Kadaster Haal Centraal BRK-Bevragen
url: https://github.com/VNG-Realisatie/Haal-Centraal-BRK-Bevragen
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.brk.kadaster.nl/esd-eto-apikey/bevragen/v2
description: |
BRK-Bevragen API - TEST (via API-key)
- url: https://api.brk.kadaster.nl/esd-eto/bevragen/v2
description: |
BRK-Bevragen API - TEST (via API-key & mTLS)
- url: https://api.brk.kadaster.nl/esd/bevragen/v2
description: |
BRK-Bevragen API - PRODUCTIE
security:
- apiKeyAuth: []
tags:
- name: Kadastraal Onroerende Zaken
- name: Zakelijke Gerechtigden
- name: Beslagen
- name: Hypotheken
- name: Privaatrechtelijke Beperkingen
- name: Publiekrechtelijke Beperkingen
- name: Kadaster (niet)Natuurlijk Personen
- name: Stukken
paths:
/kadastraalonroerendezaken:
get:
tags:
- Kadastraal Onroerende Zaken
description: "Het zoeken van kadastraal onroerende zaken door exact één van\
\ de volgende categorieën parameters op te geven.\nHet combineren van parameters\
\ uit verschillende categorieën is niet toegestaan.\n1. Kadastrale aanduiding\n\
\ - kadastraleAanduiding\n - inclusiefKadastraalOnroerendeZakenUitSplitsing\
\ (optioneel)\n2. Niet ingeschreven persoon of niet natuurlijk persoon als\
\ zakelijk gerechtigde\n - persoon__identificatie (verplicht)<br/><br/>\n\
\ \n LET OP: dit endpoint geeft geen informatie over Zakelijk Gerechtigden\
\ (zakelijkGerechtigdeIdentificaties) terug bij een KadastraalOnroerendeZaak.\
\ \n Voor het raadplegen van de Zakelijk Gerechtigden van een KadastraalOnroerendeZaak\
\ kan het endpoint /kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/zakelijkgerechtigden\
\ gebruikt worden. \n\n3. Adres\n - postcode (verplicht)\n\
\ - huisnummer (optioneel)\n - huisletter (optioneel)\n - huisnummertoevoeging\
\ (optioneel)\n4. Nummeraanduiding\n - nummeraanduidingIdentificatie\n\
5. Kadastrale aanduiding met gemeentecode\n - kadastraleAanduidingMetGemeentecode\n\
\ - inclusiefKadastraalOnroerendeZakenUitSplitsing (optioneel)\n\nMet gebruik\
\ van de parameter expand kunnen zakelijkGerechtigden (niet voor categorie\
\ 2.) en privaatrechtelijkeBeperkingen direct worden meegeladen.\n\nHet maximale\
\ aantal zoekresultaten dat geretourneerd wordt is aan de provider om te bepalen.\n\
Als het resultaat van de de request dit aantal overtreft worden er geen resultaten\
\ geretourneerd en volgt er een foutmelding.\n"
operationId: GetKadastraalOnroerendeZaken
parameters:
- name: Accept-Crs
in: header
description: Gewenste CRS van de coördinaten in de response.
required: false
schema:
type: string
description: CRS van de coördinaten in de response. epsg:28992 mapt op het
RD New Nederlands coordinatenstelsel.
enum:
- epsg:28992
- name: expand
in: query
description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
enkele properties geef je in de expand parameter kommagescheiden op. Properties
die je wil ontvangen geef je op met de resource-naam gevolgd door de property
naam, met daartussen een punt. In de definitie van het antwoord kun je bij
_embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
[functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
required: false
schema:
type: string
- name: fields
in: query
description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
door een door komma's gescheiden lijst van property namen op te geven. Bij
opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
Wanneer de fields parameter niet is opgegeven, worden alle properties met
een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
required: false
schema:
type: string
- name: kadastraleAanduiding
in: query
description: |
Kadastrale aanduiding is een unieke aanduiding van een onroerende zaak. De volgorde waarin deze string wordt opgebouwd is
- [Kadastrale gemeente](http://www.kadaster.nl/schemas/waardelijsten/KadastraleGemeente/).
- sectie, 1 of 2 hoofdletters
- perceelnummer, 1 tot 5 cijfers
- appartementsrechtVolgnummer, Hoofdletter A gevolgd door 1 tot 4 cijfers (optioneel)
gescheiden door een spatie"
schema:
pattern: ^([a-zA-Z0-9'][a-zA-Z0-9' ,-]*[a-zA-Z0-9]) ([A-IK-Z]{1,2}) ([1-9][0-9]{0,4})(
A[1-9][0-9]{0,3})?$
type: string
example: '''s Gravenhage C 1277 A3'
- name: persoon__identificatie
in: query
description: |
De identificatie van de Kadasterpersoon, een niet-ingeschreven persoon of een rechtspersoon waarvan de gegevens door het kadaster zijn geregistreerd. Deze persoon is zakelijk gerechtigde van de Kadastraal Onroerende Zaak. Door deze query-parameter te gebruiken worden Kadastraal Onroerende Zaken geretourneerd waar deze persoon een zakelijk recht op heeft.
required: false
schema:
type: string
- name: postcode
in: query
description: |
De postcode van het adres van de objectlocatie van de kadastraal onroerende zaak.
required: false
schema:
pattern: ^[1-9][0-9][0-9][0-9][A-Z][A-Z]$
type: string
- name: huisnummer
in: query
description: |
Het huisnummer van het adres van de objectlocatie van de kadastraal onroerende zaak.
required: false
schema:
maximum: 99999
minimum: 1
type: integer
- name: huisletter
in: query
description: |
De huisletter van het adres van de objectlocatie van de kadastraal onroerende zaak.
required: false
schema:
pattern: ^[a-zA-Z]$
type: string
- name: huisnummertoevoeging
in: query
description: |
De huisnummertoevoeging van het adres van de objectlocatie van de kadastraal onroerende zaak.
required: false
schema:
pattern: ^([a-z,A-Z,0-9]){1,4}$
type: string
- name: nummeraanduidingIdentificatie
in: query
description: |
De nummeraanduidingIdentificatie van een adres dat is geregistreerd als de locatie van deze kadastraal onroerende zaak.
required: false
schema:
pattern: ^[0-9]{16}$
type: string
- name: kadastraleAanduidingMetGemeentecode
in: query
description: |
Kadastrale aanduiding is in sommige domeinen opgeslagen met de gemeentecode in plaats van de gemeentenaam.
Dit is een unieke aanduiding van een onroerende zaak. De volgorde waarin deze string wordt opgebouwd is
- [Gemeentecode van de kadastrale gemeente](http://www.kadaster.nl/schemas/waardelijsten/KadastraleGemeente/).
- sectie, 1 of 2 hoofdletters
- perceelnummer, 1 tot 5 cijfers
- appartementsrechtVolgnummer, Hoofdletter A gevolgd door 1 tot 4 cijfers (optioneel)
gescheiden door een spatie"
schema:
pattern: ^([A-Z]{3}[0-9]{2}) ([A-IK-Z]{1,2}) ([1-9][0-9]{0,4})( A[1-9][0-9]{0,3})?$
type: string
example: GVH00 C 1277 A3
- name: inclusiefKadastraalOnroerendeZakenUitSplitsing
in: query
description: |
Bepaalt of ook de Kadastraal onroerende zaken worden geleverd die zijn ontstaan uit splitsing van de gevonden Kadastraal onroerende zaak.
schema:
type: boolean
responses:
"200":
description: |
Zoekactie geslaagd
headers:
api-version:
$ref: '#/components/headers/api_version'
Content-Crs:
$ref: '#/components/headers/contentCrs'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/KadastraalOnroerendeZaakHalCollectie'
"400":
description: Bad Request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestFoutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
title: Ten minste één parameter moet worden opgegeven.
status: 400
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
invalidParams:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats__huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
title: Niet correct geauthenticeerd.
status: 401
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
title: U bent niet geautoriseerd voor deze operatie.
status: 403
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
title: Gevraagde contenttype wordt niet ondersteund.
status: 406
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to thr accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"500":
description: Internal Server Error
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
title: Interne server fout.
status: 500
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
title: Bronservice {bron} is tijdelijk niet beschikbaar.
status: 503
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
post:
tags:
- Kadastraal Onroerende Zaken
description: "Het zoeken van kadastraal onroerende zaken op basis van een burgerservicenummer.\n\
\ 1. Ingeschreven persoon als zakelijk gerechtigde\n - burgerservicenummer\
\ (verplicht)\n\nMet gebruik van de parameter expand kunnen privaatrechtelijkeBeperkingen\
\ direct worden meegeladen.\n\nLET OP: dit endpoint geeft geen informatie\
\ over Zakelijk Gerechtigden (zakelijkGerechtigdeIdentificaties) terug bij\
\ een KadastraalOnroerendeZaak. \nVoor het raadplegen van de Zakelijk Gerechtigden\
\ van een KadastraalOnroerendeZaak kan het endpoint /kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/zakelijkgerechtigden\
\ gebruikt worden. \n\nHet maximale aantal zoekresultaten\
\ dat geretourneerd wordt is aan de provider om te bepalen.\nAls het resultaat\
\ van de de request dit aantal overtreft worden er geen resultaten geretourneerd\
\ en volgt er een foutmelding.\n"
operationId: ZoekKadastraalOnroerendeZakenMetBsn
parameters:
- name: Accept-Crs
in: header
description: Gewenste CRS van de coördinaten in de response.
required: false
schema:
type: string
description: CRS van de coördinaten in de response. epsg:28992 mapt op het
RD New Nederlands coordinatenstelsel.
enum:
- epsg:28992
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BsnBody'
required: true
responses:
"200":
description: |
Zoekactie geslaagd
headers:
api-version:
$ref: '#/components/headers/api_version'
Content-Crs:
$ref: '#/components/headers/contentCrs'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/KadastraalOnroerendeZaakHalCollectie'
"400":
description: Bad Request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestFoutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
title: Ten minste één parameter moet worden opgegeven.
status: 400
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
invalidParams:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats__huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
title: Niet correct geauthenticeerd.
status: 401
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
title: U bent niet geautoriseerd voor deze operatie.
status: 403
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
title: Gevraagde contenttype wordt niet ondersteund.
status: 406
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to thr accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"500":
description: Internal Server Error
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
title: Interne server fout.
status: 500
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
title: Bronservice {bron} is tijdelijk niet beschikbaar.
status: 503
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
/kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}:
get:
tags:
- Kadastraal Onroerende Zaken
description: |
Raadpleeg een kadastraal onroerende zaak.
Als je de expand parameter gebruikt kun je zakelijkgerechtigden en privaatrechtelijkebeperkingen direct meeladen.
operationId: GetKadastraalOnroerendeZaak
parameters:
- name: kadastraalOnroerendeZaakIdentificatie
in: path
description: |
De unieke identificatie van een kadastraal onroerende zaak.
required: true
schema:
type: string
- name: Accept-Crs
in: header
description: Gewenste CRS van de coördinaten in de response.
required: false
schema:
type: string
description: CRS van de coördinaten in de response. epsg:28992 mapt op het
RD New Nederlands coordinatenstelsel.
enum:
- epsg:28992
- name: expand
in: query
description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
enkele properties geef je in de expand parameter kommagescheiden op. Properties
die je wil ontvangen geef je op met de resource-naam gevolgd door de property
naam, met daartussen een punt. In de definitie van het antwoord kun je bij
_embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
[functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
required: false
schema:
type: string
- name: fields
in: query
description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
door een door komma's gescheiden lijst van property namen op te geven. Bij
opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
Wanneer de fields parameter niet is opgegeven, worden alle properties met
een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
required: false
schema:
type: string
responses:
"200":
description: |
Zoekactie geslaagd
headers:
api-version:
$ref: '#/components/headers/api_version'
Content-Crs:
$ref: '#/components/headers/contentCrs'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/KadastraalOnroerendeZaakHal'
"400":
description: Bad Request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestFoutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
title: Ten minste één parameter moet worden opgegeven.
status: 400
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
invalidParams:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats__huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
title: Niet correct geauthenticeerd.
status: 401
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
title: U bent niet geautoriseerd voor deze operatie.
status: 403
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/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
title: Opgevraagde resource bestaat niet.
status: 404
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
title: Gevraagde contenttype wordt niet ondersteund.
status: 406
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to thr accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"500":
description: Internal Server Error
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
title: Interne server fout.
status: 500
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
title: Bronservice {bron} is tijdelijk niet beschikbaar.
status: 503
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
/kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/zakelijkgerechtigden/{zakelijkGerechtigdeIdentificatie}:
get:
tags:
- Zakelijke Gerechtigden
description: |
Het raadplegen van een specifieke zakelijk gerechtigde van een kadastraal onroerende zaak. Het aandeel van de zakelijk gerechtigde wordt altijd geleverd in combinatie met het gezamenlijk aandeel (wanneer twee of meer personen een gezamenlijk aandeel hebben in een zakelijk recht, en ieders afzonderlijke aandeel in het gezamenlijk aandeel niet bekend is)
operationId: GetZakelijkGerechtigde
parameters:
- name: fields
in: query
description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
door een door komma's gescheiden lijst van property namen op te geven. Bij
opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
Wanneer de fields parameter niet is opgegeven, worden alle properties met
een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
required: false
schema:
type: string
- name: kadastraalOnroerendeZaakIdentificatie
in: path
description: |
De unieke identificatie van een kadastraal onroerende zaak.
required: true
schema:
type: string
- name: zakelijkGerechtigdeIdentificatie
in: path
description: |
De identificatie van de zakelijk gerechtigde
required: true
schema:
type: string
- name: Accept-Crs
in: header
description: Gewenste CRS van de coördinaten in de response.
required: false
schema:
type: string
description: CRS van de coördinaten in de response. epsg:28992 mapt op het
RD New Nederlands coordinatenstelsel.
enum:
- epsg:28992
responses:
"200":
description: |
Zoekactie geslaagd
headers:
api-version:
$ref: '#/components/headers/api_version'
Content-Crs:
$ref: '#/components/headers/contentCrs'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ZakelijkGerechtigdeHal'
"400":
description: Bad Request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestFoutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
title: Ten minste één parameter moet worden opgegeven.
status: 400
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
invalidParams:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats__huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
title: Niet correct geauthenticeerd.
status: 401
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
title: U bent niet geautoriseerd voor deze operatie.
status: 403
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/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
title: Opgevraagde resource bestaat niet.
status: 404
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
title: Gevraagde contenttype wordt niet ondersteund.
status: 406
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to thr accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"500":
description: Internal Server Error
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
title: Interne server fout.
status: 500
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
title: Bronservice {bron} is tijdelijk niet beschikbaar.
status: 503
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
/kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/zakelijkgerechtigden:
get:
tags:
- Zakelijke Gerechtigden
description: |
Zoek zakelijk gerechtigden van een kadastraal onroerende zaak. Het aandeel van de zakelijk gerechtigde wordt altijd geleverd in combinatie met het gezamenlijk aandeel. Er is een gezamenlijk aandeel als twee of meer personen een gezamenlijk aandeel hebben in een zakelijk recht, en ieders afzonderlijke aandeel in het gezamenlijk aandeel niet bekend is.
operationId: GetZakelijkGerechtigden
parameters:
- name: fields
in: query
description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
door een door komma's gescheiden lijst van property namen op te geven. Bij
opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
Wanneer de fields parameter niet is opgegeven, worden alle properties met
een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
required: false
schema:
type: string
- name: kadastraalOnroerendeZaakIdentificatie
in: path
description: |
De unieke identificatie van een kadastraal onroerende zaak.
required: true
schema:
type: string
- name: type
in: query
description: |
Het type recht dat de zakelijk gerechtigde heeft op de kadastraal onroerende zaak. De waarden van de typering staan in een waardelijst.
required: false
schema:
$ref: '#/components/schemas/TypeGerechtigdeEnum'
- name: Accept-Crs
in: header
description: Gewenste CRS van de coördinaten in de response.
required: false
schema:
type: string
description: CRS van de coördinaten in de response. epsg:28992 mapt op het
RD New Nederlands coordinatenstelsel.
enum:
- epsg:28992
responses:
"200":
description: |
Zoekactie geslaagd
headers:
api-version:
$ref: '#/components/headers/api_version'
Content-Crs:
$ref: '#/components/headers/contentCrs'
warning:
$ref: '#/components/headers/warning'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ZakelijkGerechtigdeHalCollectie'
"400":
description: Bad Request
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestFoutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
title: Ten minste één parameter moet worden opgegeven.
status: 400
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
invalidParams:
- type: https://www.vng.nl/realisatie/api/validaties/integer
name: verblijfplaats__huisnummer
code: integer
reason: Waarde is geen geldige integer.
"401":
description: Unauthorized
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
title: Niet correct geauthenticeerd.
status: 401
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
title: U bent niet geautoriseerd voor deze operatie.
status: 403
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/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
title: Opgevraagde resource bestaat niet.
status: 404
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
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
title: Gevraagde contenttype wordt niet ondersteund.
status: 406
detail: The resource identified by the request is only capable of
generating response entities which have content characteristics
not acceptable according to thr accept headers sent in the request
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: notAcceptable
"500":
description: Internal Server Error
headers:
api-version:
$ref: '#/components/headers/api_version'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
title: Interne server fout.
status: 500
detail: The server encountered an unexpected condition which prevented
it from fulfilling the request.