-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenapi.yaml
990 lines (988 loc) · 35.8 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
openapi: 3.0.3
info:
title: BRP historie bevragen
description: |
API voor het zoeken en raadplegen van historische verblijfplaatsen, partners, nationaliteiten en verblijfstitels uit de BRP (inclusief de RNI).
Zie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-historie-bevragen/tree/v1.0.0/features) voor nadere toelichting.
contact:
url: https://github.com/VNG-Realisatie/Haal-Centraal-BRP-historie-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://apigw.npr.idm.diginetwerk.net/lap/api/brp
description: RvIG Proefomgeving
tags:
- name: BRP historie bevragen
description: Zoeken historische gegevens
paths:
/verblijfplaatshistorie:
post:
tags:
- BRP historie bevragen
description: |
Raadpleeg de verblijfplaatshistorie van een persoon op de opgegeven peildatum of binnen de opgegeven periode.
Het meest actuele adres staat bovenaan.
Zoek met burgerservicenummer
operationId: Verblijfplaatshistorie
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HistorieQuery'
responses:
"200":
description: |
Zoekactie geslaagd
headers:
warning:
$ref: '#/components/headers/warning'
X-Rate-Limit-Limit:
$ref: '#/components/headers/X_Rate_Limit_Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X_Rate_Limit_Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X_Rate_Limit_Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/VerblijfplaatshistorieQueryResponse'
"400":
description: Bad Request
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: huisnummer
code: integer
reason: Waarde is geen geldig getal.
"401":
description: Unauthorized
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
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
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
"415":
description: Unsupported Media Type
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
title: Unsupported Media Type
status: 415
detail: The server is refusing the request because the entity of the
request is in a format not supported by the requested resource for
the requested method.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: unsupported
"429":
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
title: Too many request
status: 429
detail: The user has sent too many requests in a given amount of time
(rate limiting).
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: tooManyRequests
"500":
description: Internal Server Error
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
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 BRP 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
default:
description: Er is een onverwachte fout opgetreden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
components:
schemas:
HistorieQuery:
required:
- burgerservicenummer
- type
type: object
properties:
type:
type: string
burgerservicenummer:
$ref: '#/components/schemas/Burgerservicenummer'
discriminator:
propertyName: type
mapping:
RaadpleegMetPeildatum: '#/components/schemas/RaadpleegMetPeildatum'
RaadpleegMetPeriode: '#/components/schemas/RaadpleegMetPeriode'
RaadpleegMetPeildatum:
required:
- peildatum
allOf:
- $ref: '#/components/schemas/HistorieQuery'
- type: object
properties:
peildatum:
type: string
description: |
De datum waarop de resource wordt opgevraagd.
format: date
example: 1964-09-24
RaadpleegMetPeriode:
required:
- datumTot
- datumVan
allOf:
- $ref: '#/components/schemas/HistorieQuery'
- type: object
properties:
datumVan:
type: string
description: |
De begindatum van de periode waarover de resource wordt opgevraagd.
format: date
example: 1964-09-24
datumTot:
type: string
description: |
De einddatum van de periode waarover de resource wordt opgevraagd.
format: date
example: 1964-09-24
VerblijfplaatshistorieQueryResponse:
type: object
properties:
verblijfplaatsen:
type: array
items:
$ref: '#/components/schemas/AbstractVerblijfplaatsVoorkomen'
opschortingBijhouding:
$ref: '#/components/schemas/OpschortingBijhouding'
geheimhoudingPersoonsgegevens:
$ref: '#/components/schemas/GeheimhoudingPersoonsgegevens'
BadRequestFoutbericht:
allOf:
- $ref: '#/components/schemas/Foutbericht'
- type: object
properties:
invalidParams:
type: array
description: Foutmelding per fout in een parameter. Alle gevonden fouten
worden één keer teruggemeld.
items:
$ref: '#/components/schemas/InvalidParams'
Foutbericht:
type: object
properties:
type:
type: string
description: Link naar meer informatie over deze fout
format: uri
title:
pattern: "^[a-zA-Z0-9À-ž \\.\\-]{1,80}$"
type: string
description: Beschrijving van de fout
status:
maximum: 600
minimum: 100
type: integer
description: Http status code
detail:
pattern: "^[a-zA-Z0-9À-ž \\.\\-\\(\\)\\,]{1,200}$"
type: string
description: Details over de fout
instance:
type: string
description: Uri van de aanroep die de fout heeft veroorzaakt
format: uri
code:
minLength: 1
pattern: "^[a-zA-Z0-9]{1,25}$"
type: string
description: Systeemcode die het type fout aangeeft
description: "Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807)."
InvalidParams:
type: object
properties:
type:
type: string
format: uri
example: "https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer"
name:
pattern: "^[a-zA-Z0-9\\.,_]{1,30}$"
type: string
description: Naam van de parameter
example: huisnummer
code:
minLength: 1
pattern: "^[a-zA-Z0-9\\.,_]{1,25}$"
type: string
description: Systeemcode die het type fout aangeeft
example: integer
reason:
pattern: "^[a-zA-Z0-9\\.,_ ]{1,80}$"
type: string
description: Beschrijving van de fout op de parameterwaarde
example: Waarde is geen geldig getal.
description: Details over fouten in opgegeven parameters
Burgerservicenummer:
pattern: "^[0-9]{9}$"
type: string
example: "555555021"
AbstractVerblijfplaatsVoorkomen:
required:
- type
type: object
properties:
type:
type: string
description: |
Gegevens over het verblijfplaats voorkomen van een persoon.
discriminator:
propertyName: type
mapping:
VerblijfplaatsBuitenland: '#/components/schemas/VerblijfplaatsBuitenlandVoorkomen'
Adres: '#/components/schemas/AdresVoorkomen'
VerblijfplaatsOnbekend: '#/components/schemas/VerblijfplaatsOnbekendVoorkomen'
Locatie: '#/components/schemas/LocatieVoorkomen'
VerblijfplaatsBuitenlandVoorkomen:
description: |
* **land** - land waar de persoon is overleden. Wordt gevuld met waarden uit de landelijke tabel 'Landen'.
allOf:
- $ref: '#/components/schemas/AbstractVerblijfplaatsVoorkomen'
- type: object
properties:
verblijfadres:
$ref: '#/components/schemas/VerblijfadresBuitenland'
datumVan:
$ref: '#/components/schemas/AbstractDatum'
datumTot:
$ref: '#/components/schemas/AbstractDatum'
gemeenteVanInschrijving:
$ref: '#/components/schemas/Waardetabel'
inOnderzoek:
$ref: '#/components/schemas/VerblijfplaatsBuitenlandVoorkomenInOnderzoek'
rni:
$ref: '#/components/schemas/RniDeelnemer'
adressering:
$ref: '#/components/schemas/AdresseringBuitenland'
VerblijfplaatsBuitenlandVoorkomenInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
type:
type: boolean
datumVan:
type: boolean
datumTot:
type: boolean
gemeenteVanInschrijving:
type: boolean
AdresVoorkomen:
description: |
Gegevens over het adres voorkomen van een persoon.
* **gemeenteVanInschrijving** - wordt gevuld met waarden uit de landelijke tabel 'Gemeenten'.
* **functieAdres** - wordt gevuld met waarden voor 'Functie_Adres' in 'tabelwaarden.csv'.
* **aanduidingBijHuisnummer** - wordt gevuld met waarden voor 'Aanduiding_Bij_Huisnummer' in 'tabelwaarden.csv'.
* **datumVan** : de datum van aangifte of ambtshalve melding van verblijf en adres.
* **datumTot** : de datum van aangifte of ambtshalve melding van volgende verblijf en adres.
* **verblijftNietOpAdresVanaf** : geeft aan op welke datum is vastgesteld dat de persoon niet langer op dit adres of deze locatie woont.
allOf:
- $ref: '#/components/schemas/AbstractVerblijfplaatsVoorkomen'
- type: object
properties:
verblijfadres:
$ref: '#/components/schemas/VerblijfadresBinnenland'
functieAdres:
$ref: '#/components/schemas/Waardetabel'
adresseerbaarObjectIdentificatie:
$ref: '#/components/schemas/AdresseerbaarObjectIdentificatie'
nummeraanduidingIdentificatie:
$ref: '#/components/schemas/NummeraanduidingIdentificatie'
gemeenteVanInschrijving:
$ref: '#/components/schemas/Waardetabel'
datumVan:
$ref: '#/components/schemas/AbstractDatum'
datumTot:
$ref: '#/components/schemas/AbstractDatum'
verblijftNietOpAdresVanaf:
$ref: '#/components/schemas/AbstractDatum'
inOnderzoek:
$ref: '#/components/schemas/AdresVoorkomenInOnderzoek'
adressering:
$ref: '#/components/schemas/AdresseringBinnenland'
AdresVoorkomenInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
type:
type: boolean
gemeenteVanInschrijving:
type: boolean
datumVan:
type: boolean
datumTot:
type: boolean
nummeraanduidingIdentificatie:
type: boolean
adresseerbaarObjectIdentificatie:
type: boolean
functieAdres:
type: boolean
VerblijfplaatsOnbekendVoorkomen:
allOf:
- $ref: '#/components/schemas/AbstractVerblijfplaatsVoorkomen'
- type: object
properties:
datumVan:
$ref: '#/components/schemas/AbstractDatum'
datumTot:
$ref: '#/components/schemas/AbstractDatum'
gemeenteVanInschrijving:
$ref: '#/components/schemas/Waardetabel'
inOnderzoek:
$ref: '#/components/schemas/VerblijfplaatsOnbekendVoorkomenInOnderzoek'
rni:
$ref: '#/components/schemas/RniDeelnemer'
VerblijfplaatsOnbekendVoorkomenInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
type:
type: boolean
datumVan:
type: boolean
datumTot:
type: boolean
gemeenteVanInschrijving:
type: boolean
LocatieVoorkomen:
description: |
* **functieAdres** - wordt gevuld met waarden voor 'Functie_Adres' in 'tabelwaarden.csv'.
* **gemeenteVanInschrijving** - wordt gevuld met waarden uit de landelijke tabel 'Gemeenten'.
* **verblijftNietOpAdresVanaf** : geeft aan op welke datum is vastgesteld dat de persoon niet langer op dit adres of deze locatie verblijft.
allOf:
- $ref: '#/components/schemas/AbstractVerblijfplaatsVoorkomen'
- type: object
properties:
datumVan:
$ref: '#/components/schemas/AbstractDatum'
datumTot:
$ref: '#/components/schemas/AbstractDatum'
functieAdres:
$ref: '#/components/schemas/Waardetabel'
verblijfadres:
$ref: '#/components/schemas/VerblijfadresLocatie'
gemeenteVanInschrijving:
$ref: '#/components/schemas/Waardetabel'
verblijftNietOpAdresVanaf:
$ref: '#/components/schemas/AbstractDatum'
inOnderzoek:
$ref: '#/components/schemas/LocatieVoorkomenInOnderzoek'
adressering:
$ref: '#/components/schemas/AdresseringBinnenland'
LocatieVoorkomenInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
type:
type: boolean
gemeenteVanInschrijving:
type: boolean
datumVan:
type: boolean
datumTot:
type: boolean
functieAdres:
type: boolean
OpschortingBijhouding:
allOf:
- $ref: '#/components/schemas/OpschortingBijhoudingBasis'
- type: object
properties:
datum:
$ref: '#/components/schemas/AbstractDatum'
description: |
* **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt.
OpschortingBijhoudingBasis:
type: object
properties:
reden:
$ref: '#/components/schemas/Waardetabel'
description: |
* **reden** - wordt gevuld met waarden voor 'Reden_Opschorting_Bijhouding' in 'tabelwaarden.csv'.
GeheimhoudingPersoonsgegevens:
type: boolean
description: |
Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen.
VerblijfadresBuitenland:
type: object
properties:
regel1:
$ref: '#/components/schemas/Regel1'
regel2:
$ref: '#/components/schemas/Regel2'
regel3:
$ref: '#/components/schemas/Regel3'
land:
$ref: '#/components/schemas/Waardetabel'
inOnderzoek:
$ref: '#/components/schemas/VerblijfadresBuitenlandInOnderzoek'
Regel1:
maxLength: 40
type: string
description: |
Het eerste deel van een buitenlands adres. Vaak is dit een combinatie van de straat en huisnummer.
example: 1600 Pennsylvania Avenue NW
Regel2:
maxLength: 50
type: string
description: |
Het tweede deel van een buitenlands adres. Vaak is dit een combinatie van woonplaats eventueel in combinatie met de postcode.
example: "Washington, DC 20500"
Regel3:
maxLength: 35
type: string
description: |
Het derde deel van een buitenlands adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland.
example: Selangor
VerblijfadresBuitenlandInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
regel1:
type: boolean
regel2:
type: boolean
regel3:
type: boolean
land:
type: boolean
AbstractDatum:
required:
- langFormaat
- type
type: object
properties:
type:
type: string
langFormaat:
pattern: "^[a-z0-9 ]{1,17}$"
type: string
discriminator:
propertyName: type
mapping:
Datum: '#/components/schemas/VolledigeDatum'
DatumOnbekend: '#/components/schemas/DatumOnbekend'
JaarDatum: '#/components/schemas/JaarDatum'
JaarMaandDatum: '#/components/schemas/JaarMaandDatum'
VolledigeDatum:
required:
- datum
description: Datum conform iso8601
example:
value:
type: Datum
datum: 2018-07-01
langFormaat: 1 juli 2018
allOf:
- $ref: '#/components/schemas/AbstractDatum'
- type: object
properties:
datum:
type: string
format: date
DatumOnbekend:
required:
- onbekend
description: representatie voor een volledig onbekend datum
example:
value:
type: DatumOnbekend
onbekend: true
langFormaat: onbekend
allOf:
- $ref: '#/components/schemas/AbstractDatum'
- type: object
properties:
onbekend:
type: boolean
default: true
JaarDatum:
required:
- jaar
description: representatie voor een datum waarvan maand en dag onbekend zijn
example:
value:
type: JaarDatum
jaar: 2018
langFormaat: 2018
allOf:
- $ref: '#/components/schemas/AbstractDatum'
- type: object
properties:
jaar:
$ref: '#/components/schemas/Jaar'
Jaar:
maximum: 9999
minimum: 1
type: integer
format: int32
JaarMaandDatum:
required:
- jaar
- maand
description: representatie voor een datum waarvan de dag onbekend is
example:
value:
type: JaarMaandDatum
jaar: 2018
maand: 7
langFormaat: juli 2018
allOf:
- $ref: '#/components/schemas/AbstractDatum'
- type: object
properties:
jaar:
$ref: '#/components/schemas/Jaar'
maand:
$ref: '#/components/schemas/Maand'
Maand:
maximum: 12
minimum: 1
type: integer
format: int32
Waardetabel:
type: object
properties:
code:
pattern: "^[a-zA-Z0-9 \\.]+$"
type: string
example: "6030"
omschrijving:
pattern: "^[a-zA-Z0-9À-ž \\'\\,\\(\\)\\.\\-]{1,200}$"
type: string
example: Nederland
RniDeelnemer:
type: object
properties:
deelnemer:
$ref: '#/components/schemas/Waardetabel'
omschrijvingVerdrag:
$ref: '#/components/schemas/OmschrijvingVerdrag'
OmschrijvingVerdrag:
pattern: "^[a-zA-Z0-9À-ž \\.\\-\\']{1,50}$"
type: string
description: |
Omschrijving van het verdrag op basis waarvan een zusterorganisatie in het buitenland de gegevens bij de RNI-deelnemer heeft aangeleverd.
AdresseringBuitenland:
type: object
properties:
adresregel1:
$ref: '#/components/schemas/Adresregel1'
adresregel2:
$ref: '#/components/schemas/Adresregel2'
adresregel3:
$ref: '#/components/schemas/Adresregel3'
land:
$ref: '#/components/schemas/Waardetabel'
inOnderzoek:
$ref: '#/components/schemas/AdresseringBuitenlandInOnderzoek'
Adresregel1:
maxLength: 40
type: string
description: |
Het eerste deel van een adres is een combinatie van de straat en huisnummer.
example: Kappeyne v d Cappellostr 26A-3
Adresregel2:
maxLength: 50
type: string
description: |
Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode.
example: 1234AA Nootdorp
Adresregel3:
maxLength: 35
type: string
description: |
Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland.
example: Selangor
AdresseringBuitenlandInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
adresregel1:
type: boolean
adresregel2:
type: boolean
adresregel3:
type: boolean
land:
type: boolean
InOnderzoek:
type: object
properties:
datumIngangOnderzoek:
$ref: '#/components/schemas/AbstractDatum'
VerblijfadresBinnenland:
type: object
properties:
officieleStraatnaam:
$ref: '#/components/schemas/OfficieleStraatnaam'
korteStraatnaam:
$ref: '#/components/schemas/KorteStraatnaam'
huisnummer:
$ref: '#/components/schemas/Huisnummer'
huisletter:
$ref: '#/components/schemas/Huisletter'
huisnummertoevoeging:
$ref: '#/components/schemas/Huisnummertoevoeging'
aanduidingBijHuisnummer:
$ref: '#/components/schemas/Waardetabel'
postcode:
$ref: '#/components/schemas/Postcode'
woonplaats:
$ref: '#/components/schemas/Woonplaats'
inOnderzoek:
$ref: '#/components/schemas/VerblijfadresBinnenlandInOnderzoek'
OfficieleStraatnaam:
maxLength: 80
type: string
description: |
De officiële naam van een openbare ruimte uit de Basisregistratie Gebouwen en Adressen (BAG).
KorteStraatnaam:
maxLength: 24
type: string
description: |
De officiële naam van een openbare ruimte uit de Basisregistratie Gebouwen en Adressen (BAG), zo nodig verkort tot maximaal 24 tekens, of de straatnaam van een niet-BAG adres.
Huisnummer:
maximum: 99999
minimum: 1
type: integer
description: |
Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.
example: 14
Huisletter:
pattern: "^[a-zA-Z]{1}$"
type: string
description: |
Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.
example: a
Huisnummertoevoeging:
pattern: "^[a-zA-Z0-9 \\-]{1,4}$"
type: string
description: |
Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.
example: bis
Postcode:
pattern: "^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$"
type: string
description: |
De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.
example: 2341SX
Woonplaats:
title: woonplaats naam
pattern: "^[a-zA-Z0-9À-ž \\(\\)\\,\\.\\-\\']{1,80}$"
type: string
description: |
Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam.
example: Duiven
VerblijfadresBinnenlandInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
aanduidingBijHuisnummer:
type: boolean
huisletter:
type: boolean
huisnummer:
type: boolean
huisnummertoevoeging:
type: boolean
officieleStraatnaam:
type: boolean
postcode:
type: boolean
korteStraatnaam:
type: boolean
woonplaats:
type: boolean
AdresseerbaarObjectIdentificatie:
pattern: "^[0-9]{16}$"
type: string
description: |
De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn.
example: "0226010000038820"
NummeraanduidingIdentificatie:
pattern: "^[0-9]{16}$"
type: string
description: |
Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.
example: "0518200000366054"
AdresseringBinnenland:
type: object
properties:
adresregel1:
$ref: '#/components/schemas/Adresregel1'
adresregel2:
$ref: '#/components/schemas/Adresregel2'
inOnderzoek:
$ref: '#/components/schemas/AdresseringBinnenlandInOnderzoek'
AdresseringBinnenlandInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
adresregel1:
type: boolean
adresregel2:
type: boolean
VerblijfadresLocatie:
type: object
properties:
locatiebeschrijving:
$ref: '#/components/schemas/Locatiebeschrijving'
inOnderzoek:
$ref: '#/components/schemas/VerblijfadresLocatieInOnderzoek'
Locatiebeschrijving:
maxLength: 35
type: string
description: |
Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats.
example: Naast de derde brug
VerblijfadresLocatieInOnderzoek:
allOf:
- $ref: '#/components/schemas/InOnderzoek'
- type: object
properties:
locatiebeschrijving:
type: boolean
responses:
"400":
description: Bad Request
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: huisnummer
code: integer
reason: Waarde is geen geldig getal.
"401":
description: Unauthorized
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
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
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
"415":
description: Unsupported Media Type
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
title: Unsupported Media Type
status: 415
detail: The server is refusing the request because the entity of the request
is in a format not supported by the requested resource for the requested
method.
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: unsupported
"429":
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
example:
type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
title: Too many request
status: 429
detail: The user has sent too many requests in a given amount of time
(rate limiting).
instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
code: tooManyRequests
"500":
description: Internal Server Error
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
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 BRP 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
default:
description: Er is een onverwachte fout opgetreden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Foutbericht'
headers:
warning:
schema:
maxLength: 500
type: string
description: "zie RFC 7234. In het geval een major versie wordt uitgefaseerd,\
\ gebruiken we warn-code 299 (\"Miscellaneous Persistent Warning\") en het\
\ API end-point (inclusief versienummer) als de warn-agent van de warning,\
\ gevolgd door de warn-text met de human-readable waarschuwing"
example: "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd\
\ en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie\
\ hier de documentatie: https://omgevingswet.../api/.../v1\"."
X_Rate_Limit_Limit:
schema:
type: integer
X_Rate_Limit_Remaining:
schema:
type: integer
X_Rate_Limit_Reset:
schema:
type: integer