forked from VNG-Realisatie/zaken-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
8310 lines (8008 loc) · 262 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: Zaken API
description: 'Een API om een zaakregistratiecomponent (ZRC) te benaderen.
De ZAAK is het kernobject in deze API, waaraan verschillende andere
resources gerelateerd zijn. De Zaken API werkt samen met andere API''s voor
Zaakgericht werken om tot volledige functionaliteit te komen.
**Afhankelijkheden**
Deze API is afhankelijk van:
* Catalogi API
* Notificaties API
* Documenten API *(optioneel)*
* Besluiten API *(optioneel)*
* Autorisaties API *(optioneel)*
**Autorisatie**
Deze API vereist autorisatie. Je kan de
[token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te
genereren.
### Notificaties
Deze API publiceert notificaties op het kanaal `zaken`.
**Main resource**
`zaak`
**Kenmerken**
* `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie
die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen
aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef
* `zaaktype`: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS
waar deze voorkomt
* `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier
van de ZAAK voor de openbaarheid bestemd is.
**Resources en acties**
- `zaak`: create, update, destroy
- `status`: create
- `zaakobject`: create, update, destroy
- `zaakinformatieobject`: create
- `zaakeigenschap`: create, update, destroy
- `klantcontact`: create
- `rol`: create, destroy
- `resultaat`: create, update, destroy
- `zaakbesluit`: create
- `zaakcontactmoment`: create
- `zaakverzoek`: create
**Handige links**
* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)
* [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)
'
contact:
url: https://vng-realisatie.github.io/gemma-zaken
email: [email protected]
license:
name: EUPL 1.2
url: https://opensource.org/licenses/EUPL-1.2
version: 1.3.0-alpha2
security:
- JWT-Claims: []
paths:
/klantcontacten:
get:
operationId: klantcontact_list
summary: Alle KLANTCONTACTen opvragen.
description: 'Alle KLANTCONTACTen opvragen.
**DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.'
parameters:
- name: zaak
in: query
description: URL-referentie naar de ZAAK.
required: false
schema:
type: string
format: uri
- name: page
in: query
description: Een pagina binnen de gepagineerde set resultaten.
required: false
schema:
type: integer
responses:
'200':
description: OK
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
Warning:
schema:
type: string
description: Geeft een endpoint-specifieke waarschuwing, zoals het uitfaseren
van functionaliteit.
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/KlantContact'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- klantcontacten
security:
- JWT-Claims:
- zaken.lezen
deprecated: true
post:
operationId: klantcontact_create
summary: Maak een KLANTCONTACT bij een ZAAK aan.
description: 'Indien geen identificatie gegeven is, dan wordt deze automatisch
gegenereerd.
**DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.'
parameters:
- name: Content-Type
in: header
description: Content type van de verzoekinhoud.
required: true
schema:
type: string
enum:
- application/json
- name: X-NLX-Logrecord-ID
in: header
description: Identifier of the request, traceable throughout the network
required: false
schema:
type: string
- name: X-Audit-Toelichting
in: header
description: Toelichting waarom een bepaald verzoek wordt gedaan
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KlantContact'
required: true
responses:
'201':
description: Created
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
Location:
schema:
type: string
format: uri
description: URL waar de resource leeft.
Warning:
schema:
type: string
description: Geeft een endpoint-specifieke waarschuwing, zoals het uitfaseren
van functionaliteit.
content:
application/json:
schema:
$ref: '#/components/schemas/KlantContact'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- klantcontacten
security:
- JWT-Claims:
- (zaken.bijwerken | zaken.geforceerd-bijwerken)
deprecated: true
parameters: []
/klantcontacten/{uuid}:
get:
operationId: klantcontact_read
summary: Een specifiek KLANTCONTACT bij een ZAAK opvragen.
description: 'Een specifiek KLANTCONTACT bij een ZAAK opvragen.
**DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.'
parameters:
- name: If-None-Match
in: header
description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
\ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
\ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
\ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
\ voor meer informatie."
required: false
examples:
oneValue:
summary: "E\xE9n ETag-waarde"
value: '"79054025255fb1a26e4bc422aef54eb4"'
multipleValues:
summary: Meerdere ETag-waardes
value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
schema:
type: string
responses:
'200':
description: OK
headers:
ETag:
description: De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
schema:
type: string
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
Warning:
schema:
type: string
description: Geeft een endpoint-specifieke waarschuwing, zoals het uitfaseren
van functionaliteit.
content:
application/json:
schema:
$ref: '#/components/schemas/KlantContact'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- klantcontacten
security:
- JWT-Claims:
- zaken.lezen
deprecated: true
parameters:
- name: uuid
in: path
description: Unieke resource identifier (UUID4)
required: true
schema:
type: string
format: uuid
/resultaten:
get:
operationId: resultaat_list
summary: Alle RESULTAATen van ZAAKen opvragen.
description: Deze lijst kan gefilterd wordt met query-string parameters.
parameters:
- name: zaak
in: query
description: URL-referentie naar de ZAAK.
required: false
schema:
type: string
format: uri
- name: resultaattype
in: query
description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API).
required: false
schema:
type: string
format: uri
- name: page
in: query
description: Een pagina binnen de gepagineerde set resultaten.
required: false
schema:
type: integer
responses:
'200':
description: OK
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Resultaat'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- resultaten
security:
- JWT-Claims:
- zaken.lezen
post:
operationId: resultaat_create
summary: Maak een RESULTAAT bij een ZAAK aan.
description: '**Er wordt gevalideerd op**
- geldigheid URL naar de ZAAK
- geldigheid URL naar het RESULTAATTYPE'
parameters:
- name: Content-Type
in: header
description: Content type van de verzoekinhoud.
required: true
schema:
type: string
enum:
- application/json
- name: X-NLX-Logrecord-ID
in: header
description: Identifier of the request, traceable throughout the network
required: false
schema:
type: string
- name: X-Audit-Toelichting
in: header
description: Toelichting waarom een bepaald verzoek wordt gedaan
required: false
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Resultaat'
responses:
'201':
description: Created
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
Location:
schema:
type: string
format: uri
description: URL waar de resource leeft.
content:
application/json:
schema:
$ref: '#/components/schemas/Resultaat'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- resultaten
security:
- JWT-Claims:
- (zaken.bijwerken | zaken.geforceerd-bijwerken)
parameters: []
/resultaten/{uuid}:
get:
operationId: resultaat_read
summary: Een specifiek RESULTAAT opvragen.
description: Een specifiek RESULTAAT opvragen.
parameters:
- name: If-None-Match
in: header
description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
\ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
\ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
\ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
\ voor meer informatie."
required: false
examples:
oneValue:
summary: "E\xE9n ETag-waarde"
value: '"79054025255fb1a26e4bc422aef54eb4"'
multipleValues:
summary: Meerdere ETag-waardes
value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
schema:
type: string
responses:
'200':
description: OK
headers:
ETag:
description: De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
schema:
type: string
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
schema:
$ref: '#/components/schemas/Resultaat'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- resultaten
security:
- JWT-Claims:
- zaken.lezen
head:
operationId: resultaat_headers
summary: De headers voor een specifiek(e) RESULTAAT opvragen
description: Vraag de headers op die je bij een GET request zou krijgen.
parameters:
- name: If-None-Match
in: header
description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
\ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
\ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
\ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
\ voor meer informatie."
required: false
examples:
oneValue:
summary: "E\xE9n ETag-waarde"
value: '"79054025255fb1a26e4bc422aef54eb4"'
multipleValues:
summary: Meerdere ETag-waardes
value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
schema:
type: string
responses:
'200':
description: OK
headers:
ETag:
description: De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
schema:
type: string
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
tags:
- resultaten
security:
- JWT-Claims:
- zaken.lezen
put:
operationId: resultaat_update
summary: Werk een RESULTAAT in zijn geheel bij.
description: '**Er wordt gevalideerd op**
- geldigheid URL naar de ZAAK
- het RESULTAATTYPE mag niet gewijzigd worden'
parameters:
- name: Content-Type
in: header
description: Content type van de verzoekinhoud.
required: true
schema:
type: string
enum:
- application/json
- name: X-NLX-Logrecord-ID
in: header
description: Identifier of the request, traceable throughout the network
required: false
schema:
type: string
- name: X-Audit-Toelichting
in: header
description: Toelichting waarom een bepaald verzoek wordt gedaan
required: false
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Resultaat'
responses:
'200':
description: OK
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
schema:
$ref: '#/components/schemas/Resultaat'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- resultaten
security:
- JWT-Claims:
- (zaken.bijwerken | zaken.geforceerd-bijwerken)
patch:
operationId: resultaat_partial_update
summary: Werk een RESULTAAT deels bij.
description: '**Er wordt gevalideerd op**
- geldigheid URL naar de ZAAK
- het RESULTAATTYPE mag niet gewijzigd worden'
parameters:
- name: Content-Type
in: header
description: Content type van de verzoekinhoud.
required: true
schema:
type: string
enum:
- application/json
- name: X-NLX-Logrecord-ID
in: header
description: Identifier of the request, traceable throughout the network
required: false
schema:
type: string
- name: X-Audit-Toelichting
in: header
description: Toelichting waarom een bepaald verzoek wordt gedaan
required: false
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/Resultaat'
responses:
'200':
description: OK
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
schema:
$ref: '#/components/schemas/Resultaat'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- resultaten
security:
- JWT-Claims:
- (zaken.bijwerken | zaken.geforceerd-bijwerken)
delete:
operationId: resultaat_delete
summary: Verwijder een RESULTAAT van een ZAAK.
description: Verwijder een RESULTAAT van een ZAAK.
parameters:
- name: X-NLX-Logrecord-ID
in: header
description: Identifier of the request, traceable throughout the network
required: false
schema:
type: string
- name: X-Audit-Toelichting
in: header
description: Toelichting waarom een bepaald verzoek wordt gedaan
required: false
schema:
type: string
responses:
'204':
description: No content
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- resultaten
security:
- JWT-Claims:
- (zaken.bijwerken | zaken.geforceerd-bijwerken)
parameters:
- name: uuid
in: path
description: Unieke resource identifier (UUID4)
required: true
schema:
type: string
format: uuid
/rollen:
get:
operationId: rol_list
summary: Alle ROLlen bij ZAAKen opvragen.
description: Deze lijst kan gefilterd wordt met query-string parameters.
parameters:
- name: zaak
in: query
description: URL-referentie naar de ZAAK.
required: false
schema:
type: string
format: uri
- name: betrokkene
in: query
description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK.
required: false
schema:
type: string
format: uri
- name: betrokkeneType
in: query
description: Type van de `betrokkene`.
required: false
schema:
type: string
enum:
- natuurlijk_persoon
- niet_natuurlijk_persoon
- vestiging
- organisatorische_eenheid
- medewerker
- name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn
in: query
description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene
bepalingen burgerservicenummer.
required: false
schema:
type: string
- name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie
in: query
description: Het door de gemeente uitgegeven unieke nummer voor een ANDER
NATUURLIJK PERSOON
required: false
schema:
type: string
- name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer
in: query
description: Het administratienummer van de persoon, bedoeld in de Wet BRP
required: false
schema:
type: string
- name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId
in: query
description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN
NIET-NATUURLIJK PERSOON
required: false
schema:
type: string
- name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie
in: query
description: Het door de gemeente uitgegeven unieke nummer voor een ANDER
NIET-NATUURLIJK PERSOON
required: false
schema:
type: string
- name: betrokkeneIdentificatie__vestiging__vestigingsNummer
in: query
description: Een korte unieke aanduiding van de Vestiging.
required: false
schema:
type: string
- name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie
in: query
description: Een korte identificatie van de organisatorische eenheid.
required: false
schema:
type: string
- name: betrokkeneIdentificatie__medewerker__identificatie
in: query
description: Een korte unieke aanduiding van de MEDEWERKER.
required: false
schema:
type: string
- name: roltype
in: query
description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK.
required: false
schema:
type: string
format: uri
- name: omschrijving
in: query
description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE.
required: false
schema:
type: string
- name: omschrijvingGeneriek
in: query
description: Algemeen gehanteerde benaming van de aard van de ROL, afgeleid
uit het ROLTYPE.
required: false
schema:
type: string
enum:
- adviseur
- behandelaar
- belanghebbende
- beslisser
- initiator
- klantcontacter
- zaakcoordinator
- mede_initiator
- name: page
in: query
description: Een pagina binnen de gepagineerde set resultaten.
required: false
schema:
type: integer
responses:
'200':
description: OK
headers:
API-version:
schema:
type: string
description: 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/Rol'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'406':
$ref: '#/components/responses/406'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
tags:
- rollen
security:
- JWT-Claims:
- zaken.lezen
post:
operationId: rol_create
summary: Maak een ROL aan bij een ZAAK.
description: Maak een ROL aan bij een ZAAK.
parameters:
- name: Content-Type
in: header
description: Content type van de verzoekinhoud.
required: true