-
Notifications
You must be signed in to change notification settings - Fork 0
/
bevraging-ingeschreven-persoon.yaml
229 lines (229 loc) · 12.9 KB
/
bevraging-ingeschreven-persoon.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
openapi: 3.0.0
servers:
- description: "SwaggerHub API Auto Mocking"
url: https://virtserver.swaggerhub.com/VNGRealisatie/api/bevragingen_ingeschreven_personen/v1
- description: "Referentie-implementatie"
url: https://www.voorbeeldgemeente.nl/api/bevragingen_ingeschreven_personen/v1
info:
title: Bevragingen ingeschreven personen
description: "API voor het ontsluiten van gegevens van ingeschreven personen en aanverwante gegevens uit de GBA en RNI. Met deze API worden de actuele gegevens van ingeschreven personen, hun kinderen, partners en ouders ontsloten. Ook de gegevens over reisdocumenten worden via deze API ontsloten. Zie de [Functionele documentatie](https://github.com/VNG-Realisatie/Bevragingen-ingeschreven-personen/tree/master/features) voor nadere toelichting."
version: "1.0"
contact:
url: https://github.com/VNG-Realisatie/Bevragingen-ingeschreven-personen
license:
name: European Union Public License, version 1.2 (EUPL-1.2)
url: https://eupl.eu/1.2/nl/
paths:
/ingeschrevenpersonen:
get:
parameters:
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/ExpandQueryParameter'
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/FieldsQueryParameter'
responses:
'200':
$ref: "#/components/responses/ZoekIngeschrevenPersonenResponse"
'400':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/BadRequestResponse"
'401':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/UnauthorizedResponse"
'403':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/ForbiddenResponse"
/ingeschrevenpersonen/{burgerservicenummer}:
get:
parameters:
- $ref: "#/components/parameters/BurgerservicenummerPathParameter"
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/ExpandQueryParameter'
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/FieldsQueryParameter'
responses:
'200':
$ref: "#/components/responses/RaadpleegIngeschrevenPersoonResponse"
'401':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/UnauthorizedResponse"
'403':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/ForbiddenResponse"
/ingeschrevenpersonen/{burgerservicenummer}/kinderen:
get:
operationId: ingeschrevenpersonenBurgerservicenummerkinderen
description: "Het ophalen de kind-gegevens van een Ingeschreven Persoon zoals die op de persoonslijst voorkomen. Er vind geen sortering plaats."
parameters:
- $ref: "#/components/parameters/BurgerservicenummerPathParameter"
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/ExpandQueryParameter'
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/FieldsQueryParameter'
responses:
'200':
$ref: "#/components/responses/ZoekKinderenResponse"
'401':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/UnauthorizedResponse"
'403':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/ForbiddenResponse"
/ingeschrevenpersonen/{burgerservicenummer}/kinderen/{uuid}:
get:
operationId: ingeschrevenpersonenBurgerservicenummerkinderenUuid
description: "Het ophalen de kind-gegevens van een Ingeschreven Persoon zoals die op de persoonslijst voorkomen."
parameters:
- $ref: "#/components/parameters/BurgerservicenummerPathParameter"
- $ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/UUIDPathParameter"
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/ExpandQueryParameter'
- $ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/parameters.yaml#/components/parameters/FieldsQueryParameter'
responses:
'200':
$ref: "#/components/responses/RaadpleegKindResponse"
'401':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/UnauthorizedResponse"
'403':
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/responses.yaml#/components/responses/ForbiddenResponse"
components:
parameters:
BurgerservicenummerPathParameter:
name: burgerservicenummer
in: path
description: "Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene bepalingen burgerservicenummer. Alle nummers waarvoor geldt dat, indien aangeduid als (s0 s1 s2 s3 s4 s5 s6 s7 s8), het resultaat van (9*s0) + (8*s1) + (7*s2) +...+ (2*s7) - (1*s8) deelbaar is door elf. Er moeten dus 9 cijfers aanwezig zijn."
required: true
schema:
type: string
maxLength: 9
minLength: 9
responses:
ZoekIngeschrevenPersonenResponse:
description: "Zoekactie geslaagd"
headers:
api-version:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/api_version"
warning:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/warning"
X-RateLimit-Limit:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Limit"
X-RateLimit-Remaining:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Remaining"
X-RateLimit-Reset:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Reset"
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ZoekIngeschrevenPersonenResponseContent'
RaadpleegIngeschrevenPersoonResponse:
description: "Raadpleegactie geslaagd"
headers:
api-version:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/api_version"
warning:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/warning"
X-RateLimit-Limit:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Limit"
X-RateLimit-Remaining:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Remaining"
X-RateLimit-Reset:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Reset"
content:
application/hal+json:
schema:
$ref: '#/components/schemas/IngeschrevenPersoon'
ZoekKinderenResponse:
description: "Zoekactie geslaagd"
headers:
api-version:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/api_version"
warning:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/warning"
X-RateLimit-Limit:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Limit"
X-RateLimit-Remaining:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Remaining"
X-RateLimit-Reset:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Reset"
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ZoekKinderenResponseContent'
RaadpleegKindResponse:
description: "Raadpleegactie geslaagd"
headers:
api-version:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/api_version"
warning:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/warning"
X-RateLimit-Limit:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Limit"
X-RateLimit-Remaining:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Remaining"
X-RateLimit-Reset:
$ref: "https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/headers.yaml#/components/headers/X-RateLimit-Reset"
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Kind'
schemas:
ZoekIngeschrevenPersonenResponseContent:
type: object
properties:
_links:
$ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/components.yaml#/components/schemas/HalCollectionLinks'
_embedded:
type: object
properties:
ingeschrevenpersonen:
type: array
items:
$ref: '#/components/schemas/IngeschrevenPersoon'
ZoekKinderenResponseContent:
type: object
properties:
_links:
$ref: 'https://raw.githubusercontent.com/MelvLee/OpenAPI-Sandbox/master/components.yaml#/components/schemas/HalCollectionLinks'
_embedded:
type: object
properties:
kinderen:
type: array
items:
$ref: '#/components/schemas/Kind'
IngeschrevenPersoon:
type: "object"
description: "Categorie 01/51 Gegevens over de ingeschrevene."
properties:
aktenummer:
type: "string"
title: "aktenummer"
description: "Element 81.20 Een aanduiding van de akte die is opgenomen\
\ in de registers van de burgerlijke stand in Nederland. De eerste drie\
\ posities van het aktenummer dienen conform [Tabel 39,Tabel Akteaanduiding](https://publicaties.rvig.nl/dsresource?objectid=4796&type=org)\
\ te zijn. De laatste 4 posities bevatten een volgnummer van de akte."
maxLength: 7
burgerservicenummer:
type: "string"
title: "Burgerservicenummer"
description: "Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet\
\ algemene bepalingen burgerservicenummer. Element 01.20 Het burgerservicenummer,\
\ bedoeld in artikel 1.1 van de Wet algemene bepalingen burgerservicenummer.\
\ Alle nummers waarvoor geldt dat, indien aangeduid als (s0 s1 s2 s3 s4\
\ s5 s6 s7 s8), het resultaat van (9*s0) + (8*s1) + (7*s2) +...+ (2*s7)\
\ - (1*s8) deelbaar is door elf. Er moeten dus 9 cijfers aanwezig zijn."
pattern: "^[0-9]{9}$"
maxLength: 9
minLength: 9
example: "555555021"
Kind:
type: "object"
description: "09/59 Gegevens over een kind van de ingeschrevene."
properties:
aktenummer:
type: "string"
title: "aktenummer"
description: "Element 81.20 Een aanduiding van de akte die is opgenomen\
\ in de registers van de burgerlijke stand in Nederland. De eerste drie\
\ posities van het aktenummer dienen conform [Tabel 39,Tabel Akteaanduiding](https://publicaties.rvig.nl/dsresource?objectid=4796&type=org)\
\ te zijn. De laatste 4 posities bevatten een volgnummer van de akte."
maxLength: 7
burgerservicenummer:
type: "string"
title: "Burgerservicenummer"
description: "Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet\
\ algemene bepalingen burgerservicenummer. Element 01.20 Het burgerservicenummer,\
\ bedoeld in artikel 1.1 van de Wet algemene bepalingen burgerservicenummer.\
\ Alle nummers waarvoor geldt dat, indien aangeduid als (s0 s1 s2 s3 s4\
\ s5 s6 s7 s8), het resultaat van (9*s0) + (8*s1) + (7*s2) +...+ (2*s7)\
\ - (1*s8) deelbaar is door elf. Er moeten dus 9 cijfers aanwezig zijn."
pattern: "^[0-9]{9}$"
maxLength: 9
minLength: 9
example: "430422088"