@vng-api/openplan-plannen 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +11 -0
  2. package/openapi.json +7030 -0
  3. package/openapi.yaml +4791 -0
  4. package/package.json +31 -0
package/openapi.yaml ADDED
@@ -0,0 +1,4791 @@
1
+ openapi: 3.0.3
2
+ info:
3
+ title: Plannen API
4
+ version: 0.1.0
5
+ description: |
6
+
7
+ Een API voor Plannen.
8
+ contact:
9
+ url: https://github.com/maykinmedia/open-plan
10
+ name: Maykin Media
11
+ email: support@maykinmedia.nl
12
+ paths:
13
+ /contactmoment:
14
+ get:
15
+ operationId: contactmoment_list
16
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
17
+ summary: Alle contactmomenten opvragen.
18
+ parameters:
19
+ - in: query
20
+ name: datum
21
+ schema:
22
+ type: string
23
+ format: date-time
24
+ description: Startdatum van het contactmoment.
25
+ - in: query
26
+ name: datum__gte
27
+ schema:
28
+ type: string
29
+ format: date-time
30
+ description: Startdatum van het contactmoment.
31
+ - in: query
32
+ name: datum__lte
33
+ schema:
34
+ type: string
35
+ format: date-time
36
+ description: Startdatum van het contactmoment.
37
+ - name: page
38
+ required: false
39
+ in: query
40
+ description: Een pagina binnen de gepagineerde set resultaten.
41
+ schema:
42
+ type: integer
43
+ - name: pageSize
44
+ required: false
45
+ in: query
46
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
47
+ schema:
48
+ type: integer
49
+ - in: query
50
+ name: persoonsprofiel
51
+ schema:
52
+ type: string
53
+ description: URL naar het persoonsprofiel (alleen voor primaire personen verplicht).
54
+ - in: query
55
+ name: persoonsprofiel__icontains
56
+ schema:
57
+ type: string
58
+ description: URL naar het persoonsprofiel (alleen voor primaire personen verplicht).
59
+ - in: query
60
+ name: plan__uuid
61
+ schema:
62
+ type: string
63
+ format: uuid
64
+ description: Unieke resource identifier (UUID4).
65
+ - in: query
66
+ name: status
67
+ schema:
68
+ type: string
69
+ enum:
70
+ - actief
71
+ - afgerond
72
+ - geannuleerd
73
+ description: |-
74
+ Status van het contactmoment.
75
+
76
+ * `actief` - Actief
77
+ * `afgerond` - Afgerond
78
+ * `geannuleerd` - Geannuleerd
79
+ tags:
80
+ - Contactmoment
81
+ security:
82
+ - tokenAuth: []
83
+ responses:
84
+ '200':
85
+ headers:
86
+ API-version:
87
+ schema:
88
+ type: string
89
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
90
+ content:
91
+ application/json:
92
+ schema:
93
+ $ref: '#/components/schemas/PaginatedContactmomentList'
94
+ application/problem+json:
95
+ schema:
96
+ $ref: '#/components/schemas/PaginatedContactmomentList'
97
+ description: ''
98
+ post:
99
+ operationId: contactmoment_create
100
+ description: Voeg een nieuw contactmoment toe aan het systeem.
101
+ summary: Nieuw contactmoment aanmaken.
102
+ tags:
103
+ - Contactmoment
104
+ requestBody:
105
+ content:
106
+ application/json:
107
+ schema:
108
+ $ref: '#/components/schemas/Contactmoment'
109
+ required: true
110
+ security:
111
+ - tokenAuth: []
112
+ responses:
113
+ '201':
114
+ headers:
115
+ API-version:
116
+ schema:
117
+ type: string
118
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
119
+ content:
120
+ application/json:
121
+ schema:
122
+ $ref: '#/components/schemas/Contactmoment'
123
+ application/problem+json:
124
+ schema:
125
+ $ref: '#/components/schemas/Contactmoment'
126
+ description: ''
127
+ /contactmoment/{uuid}:
128
+ get:
129
+ operationId: contactmoment_retrieve
130
+ description: Een specifiek contactmoment opvragen via UUID.
131
+ summary: Een specifiek contactmoment opvragen.
132
+ parameters:
133
+ - in: path
134
+ name: uuid
135
+ schema:
136
+ type: string
137
+ format: uuid
138
+ description: Unieke resource identifier (UUID4).
139
+ required: true
140
+ tags:
141
+ - Contactmoment
142
+ security:
143
+ - tokenAuth: []
144
+ responses:
145
+ '200':
146
+ headers:
147
+ API-version:
148
+ schema:
149
+ type: string
150
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
151
+ content:
152
+ application/json:
153
+ schema:
154
+ $ref: '#/components/schemas/Contactmoment'
155
+ application/problem+json:
156
+ schema:
157
+ $ref: '#/components/schemas/Contactmoment'
158
+ description: ''
159
+ put:
160
+ operationId: contactmoment_update
161
+ description: Werk alle gegevens van een contactmoment bij.
162
+ summary: Contactmoment volledig bijwerken.
163
+ parameters:
164
+ - in: path
165
+ name: uuid
166
+ schema:
167
+ type: string
168
+ format: uuid
169
+ description: Unieke resource identifier (UUID4).
170
+ required: true
171
+ tags:
172
+ - Contactmoment
173
+ requestBody:
174
+ content:
175
+ application/json:
176
+ schema:
177
+ $ref: '#/components/schemas/Contactmoment'
178
+ required: true
179
+ security:
180
+ - tokenAuth: []
181
+ responses:
182
+ '200':
183
+ headers:
184
+ API-version:
185
+ schema:
186
+ type: string
187
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
188
+ content:
189
+ application/json:
190
+ schema:
191
+ $ref: '#/components/schemas/Contactmoment'
192
+ application/problem+json:
193
+ schema:
194
+ $ref: '#/components/schemas/Contactmoment'
195
+ description: ''
196
+ patch:
197
+ operationId: contactmoment_partial_update
198
+ description: Werk enkele gegevens van een contactmoment bij.
199
+ summary: Contactmoment gedeeltelijk bijwerken.
200
+ parameters:
201
+ - in: path
202
+ name: uuid
203
+ schema:
204
+ type: string
205
+ format: uuid
206
+ description: Unieke resource identifier (UUID4).
207
+ required: true
208
+ tags:
209
+ - Contactmoment
210
+ requestBody:
211
+ content:
212
+ application/json:
213
+ schema:
214
+ $ref: '#/components/schemas/PatchedContactmoment'
215
+ security:
216
+ - tokenAuth: []
217
+ responses:
218
+ '200':
219
+ headers:
220
+ API-version:
221
+ schema:
222
+ type: string
223
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
224
+ content:
225
+ application/json:
226
+ schema:
227
+ $ref: '#/components/schemas/Contactmoment'
228
+ application/problem+json:
229
+ schema:
230
+ $ref: '#/components/schemas/Contactmoment'
231
+ description: ''
232
+ delete:
233
+ operationId: contactmoment_destroy
234
+ description: Verwijder een specifiek contactmoment.
235
+ summary: Contactmoment verwijderen.
236
+ parameters:
237
+ - in: path
238
+ name: uuid
239
+ schema:
240
+ type: string
241
+ format: uuid
242
+ description: Unieke resource identifier (UUID4).
243
+ required: true
244
+ tags:
245
+ - Contactmoment
246
+ security:
247
+ - tokenAuth: []
248
+ responses:
249
+ '204':
250
+ headers:
251
+ API-version:
252
+ schema:
253
+ type: string
254
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
255
+ description: No response body
256
+ /doel:
257
+ get:
258
+ operationId: doel_list
259
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
260
+ summary: Alle doelen opvragen.
261
+ parameters:
262
+ - in: query
263
+ name: doeltype__uuid
264
+ schema:
265
+ type: string
266
+ format: uuid
267
+ description: Unieke resource identifier (UUID4).
268
+ - in: query
269
+ name: einddatum
270
+ schema:
271
+ type: string
272
+ format: date-time
273
+ description: Einddatum van het doel.
274
+ - in: query
275
+ name: einddatum__gte
276
+ schema:
277
+ type: string
278
+ format: date-time
279
+ description: Einddatum van het doel.
280
+ - in: query
281
+ name: einddatum__lte
282
+ schema:
283
+ type: string
284
+ format: date-time
285
+ description: Einddatum van het doel.
286
+ - in: query
287
+ name: hoofdDoel__uuid
288
+ schema:
289
+ type: string
290
+ format: uuid
291
+ description: Unieke resource identifier (UUID4).
292
+ - name: page
293
+ required: false
294
+ in: query
295
+ description: Een pagina binnen de gepagineerde set resultaten.
296
+ schema:
297
+ type: integer
298
+ - name: pageSize
299
+ required: false
300
+ in: query
301
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
302
+ schema:
303
+ type: integer
304
+ - in: query
305
+ name: persoon__uuid
306
+ schema:
307
+ type: string
308
+ format: uuid
309
+ description: Unieke resource identifier (UUID4).
310
+ - in: query
311
+ name: plannen__uuid
312
+ schema:
313
+ type: string
314
+ format: uuid
315
+ description: Unieke resource identifier (UUID4).
316
+ - in: query
317
+ name: plannen__uuid__in
318
+ schema:
319
+ type: array
320
+ items:
321
+ type: string
322
+ format: uuid
323
+ description: UUID's van de gekoppelde plannen.
324
+ explode: false
325
+ style: form
326
+ - in: query
327
+ name: resultaat
328
+ schema:
329
+ type: string
330
+ enum:
331
+ - behaald
332
+ - gefaald
333
+ description: |-
334
+ Resultaat van het doel.
335
+
336
+ * `behaald` - Behaald
337
+ * `gefaald` - Gefaald
338
+ - in: query
339
+ name: startdatum
340
+ schema:
341
+ type: string
342
+ format: date-time
343
+ description: Startdatum van het doel.
344
+ - in: query
345
+ name: startdatum__gte
346
+ schema:
347
+ type: string
348
+ format: date-time
349
+ description: Startdatum van het doel.
350
+ - in: query
351
+ name: startdatum__lte
352
+ schema:
353
+ type: string
354
+ format: date-time
355
+ description: Startdatum van het doel.
356
+ - in: query
357
+ name: status
358
+ schema:
359
+ type: string
360
+ enum:
361
+ - actief
362
+ - afgerond
363
+ - geannuleerd
364
+ description: |-
365
+ Status van het doel.
366
+
367
+ * `actief` - Actief
368
+ * `afgerond` - Afgerond
369
+ * `geannuleerd` - Geannuleerd
370
+ - in: query
371
+ name: status__in
372
+ schema:
373
+ type: array
374
+ items:
375
+ type: string
376
+ description: Meerdere waarden kunnen gescheiden worden door komma's.
377
+ explode: false
378
+ style: form
379
+ - in: query
380
+ name: titel
381
+ schema:
382
+ type: string
383
+ description: Titel van het doel.
384
+ - in: query
385
+ name: titel__icontains
386
+ schema:
387
+ type: string
388
+ description: Titel van het doel.
389
+ tags:
390
+ - Doel
391
+ security:
392
+ - tokenAuth: []
393
+ responses:
394
+ '200':
395
+ headers:
396
+ API-version:
397
+ schema:
398
+ type: string
399
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
400
+ content:
401
+ application/json:
402
+ schema:
403
+ $ref: '#/components/schemas/PaginatedDoelList'
404
+ application/problem+json:
405
+ schema:
406
+ $ref: '#/components/schemas/PaginatedDoelList'
407
+ description: ''
408
+ post:
409
+ operationId: doel_create
410
+ description: Voeg een nieuw doel toe aan het systeem.
411
+ summary: Nieuw doel aanmaken.
412
+ tags:
413
+ - Doel
414
+ requestBody:
415
+ content:
416
+ application/json:
417
+ schema:
418
+ $ref: '#/components/schemas/Doel'
419
+ required: true
420
+ security:
421
+ - tokenAuth: []
422
+ responses:
423
+ '201':
424
+ headers:
425
+ API-version:
426
+ schema:
427
+ type: string
428
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
429
+ content:
430
+ application/json:
431
+ schema:
432
+ $ref: '#/components/schemas/Doel'
433
+ application/problem+json:
434
+ schema:
435
+ $ref: '#/components/schemas/Doel'
436
+ description: ''
437
+ /doel/{uuid}:
438
+ get:
439
+ operationId: doel_retrieve
440
+ description: Een specifiek doel opvragen via UUID.
441
+ summary: Een specifiek doel opvragen.
442
+ parameters:
443
+ - in: path
444
+ name: uuid
445
+ schema:
446
+ type: string
447
+ format: uuid
448
+ description: Unieke resource identifier (UUID4).
449
+ required: true
450
+ tags:
451
+ - Doel
452
+ security:
453
+ - tokenAuth: []
454
+ responses:
455
+ '200':
456
+ headers:
457
+ API-version:
458
+ schema:
459
+ type: string
460
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
461
+ content:
462
+ application/json:
463
+ schema:
464
+ $ref: '#/components/schemas/Doel'
465
+ application/problem+json:
466
+ schema:
467
+ $ref: '#/components/schemas/Doel'
468
+ description: ''
469
+ put:
470
+ operationId: doel_update
471
+ description: Werk alle gegevens van een doel bij.
472
+ summary: Doel volledig bijwerken.
473
+ parameters:
474
+ - in: path
475
+ name: uuid
476
+ schema:
477
+ type: string
478
+ format: uuid
479
+ description: Unieke resource identifier (UUID4).
480
+ required: true
481
+ tags:
482
+ - Doel
483
+ requestBody:
484
+ content:
485
+ application/json:
486
+ schema:
487
+ $ref: '#/components/schemas/Doel'
488
+ required: true
489
+ security:
490
+ - tokenAuth: []
491
+ responses:
492
+ '200':
493
+ headers:
494
+ API-version:
495
+ schema:
496
+ type: string
497
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
498
+ content:
499
+ application/json:
500
+ schema:
501
+ $ref: '#/components/schemas/Doel'
502
+ application/problem+json:
503
+ schema:
504
+ $ref: '#/components/schemas/Doel'
505
+ description: ''
506
+ patch:
507
+ operationId: doel_partial_update
508
+ description: Werk enkele gegevens van een doel bij.
509
+ summary: Doel gedeeltelijk bijwerken.
510
+ parameters:
511
+ - in: path
512
+ name: uuid
513
+ schema:
514
+ type: string
515
+ format: uuid
516
+ description: Unieke resource identifier (UUID4).
517
+ required: true
518
+ tags:
519
+ - Doel
520
+ requestBody:
521
+ content:
522
+ application/json:
523
+ schema:
524
+ $ref: '#/components/schemas/PatchedDoel'
525
+ security:
526
+ - tokenAuth: []
527
+ responses:
528
+ '200':
529
+ headers:
530
+ API-version:
531
+ schema:
532
+ type: string
533
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
534
+ content:
535
+ application/json:
536
+ schema:
537
+ $ref: '#/components/schemas/Doel'
538
+ application/problem+json:
539
+ schema:
540
+ $ref: '#/components/schemas/Doel'
541
+ description: ''
542
+ delete:
543
+ operationId: doel_destroy
544
+ description: Verwijder een specifiek doel.
545
+ summary: Doel verwijderen.
546
+ parameters:
547
+ - in: path
548
+ name: uuid
549
+ schema:
550
+ type: string
551
+ format: uuid
552
+ description: Unieke resource identifier (UUID4).
553
+ required: true
554
+ tags:
555
+ - Doel
556
+ security:
557
+ - tokenAuth: []
558
+ responses:
559
+ '204':
560
+ headers:
561
+ API-version:
562
+ schema:
563
+ type: string
564
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
565
+ description: No response body
566
+ /doelcategorie:
567
+ get:
568
+ operationId: doelcategorie_list
569
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
570
+ summary: Alle doelcategorieën opvragen.
571
+ parameters:
572
+ - in: query
573
+ name: naam
574
+ schema:
575
+ type: string
576
+ description: Naam van de doelcategorie.
577
+ - name: page
578
+ required: false
579
+ in: query
580
+ description: Een pagina binnen de gepagineerde set resultaten.
581
+ schema:
582
+ type: integer
583
+ - name: pageSize
584
+ required: false
585
+ in: query
586
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
587
+ schema:
588
+ type: integer
589
+ tags:
590
+ - Doelcategorie
591
+ security:
592
+ - tokenAuth: []
593
+ responses:
594
+ '200':
595
+ headers:
596
+ API-version:
597
+ schema:
598
+ type: string
599
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
600
+ content:
601
+ application/json:
602
+ schema:
603
+ $ref: '#/components/schemas/PaginatedDoelCategorieList'
604
+ application/problem+json:
605
+ schema:
606
+ $ref: '#/components/schemas/PaginatedDoelCategorieList'
607
+ description: ''
608
+ post:
609
+ operationId: doelcategorie_create
610
+ description: Voeg een nieuw doelcategorie toe aan het systeem.
611
+ summary: Nieuw doelcategorie aanmaken.
612
+ tags:
613
+ - Doelcategorie
614
+ requestBody:
615
+ content:
616
+ application/json:
617
+ schema:
618
+ $ref: '#/components/schemas/DoelCategorie'
619
+ required: true
620
+ security:
621
+ - tokenAuth: []
622
+ responses:
623
+ '201':
624
+ headers:
625
+ API-version:
626
+ schema:
627
+ type: string
628
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
629
+ content:
630
+ application/json:
631
+ schema:
632
+ $ref: '#/components/schemas/DoelCategorie'
633
+ application/problem+json:
634
+ schema:
635
+ $ref: '#/components/schemas/DoelCategorie'
636
+ description: ''
637
+ /doelcategorie/{uuid}:
638
+ get:
639
+ operationId: doelcategorie_retrieve
640
+ description: Een specifiek doelcategorie opvragen via UUID.
641
+ summary: Een specifiek doelcategorie opvragen.
642
+ parameters:
643
+ - in: path
644
+ name: uuid
645
+ schema:
646
+ type: string
647
+ format: uuid
648
+ description: Unieke resource identifier (UUID4).
649
+ required: true
650
+ tags:
651
+ - Doelcategorie
652
+ security:
653
+ - tokenAuth: []
654
+ responses:
655
+ '200':
656
+ headers:
657
+ API-version:
658
+ schema:
659
+ type: string
660
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
661
+ content:
662
+ application/json:
663
+ schema:
664
+ $ref: '#/components/schemas/DoelCategorie'
665
+ application/problem+json:
666
+ schema:
667
+ $ref: '#/components/schemas/DoelCategorie'
668
+ description: ''
669
+ put:
670
+ operationId: doelcategorie_update
671
+ description: Werk alle gegevens van een doelcategorie bij.
672
+ summary: Doelcategorie volledig bijwerken.
673
+ parameters:
674
+ - in: path
675
+ name: uuid
676
+ schema:
677
+ type: string
678
+ format: uuid
679
+ description: Unieke resource identifier (UUID4).
680
+ required: true
681
+ tags:
682
+ - Doelcategorie
683
+ requestBody:
684
+ content:
685
+ application/json:
686
+ schema:
687
+ $ref: '#/components/schemas/DoelCategorie'
688
+ required: true
689
+ security:
690
+ - tokenAuth: []
691
+ responses:
692
+ '200':
693
+ headers:
694
+ API-version:
695
+ schema:
696
+ type: string
697
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
698
+ content:
699
+ application/json:
700
+ schema:
701
+ $ref: '#/components/schemas/DoelCategorie'
702
+ application/problem+json:
703
+ schema:
704
+ $ref: '#/components/schemas/DoelCategorie'
705
+ description: ''
706
+ patch:
707
+ operationId: doelcategorie_partial_update
708
+ description: Werk enkele gegevens van een doelcategorie bij.
709
+ summary: Doelcategorie gedeeltelijk bijwerken.
710
+ parameters:
711
+ - in: path
712
+ name: uuid
713
+ schema:
714
+ type: string
715
+ format: uuid
716
+ description: Unieke resource identifier (UUID4).
717
+ required: true
718
+ tags:
719
+ - Doelcategorie
720
+ requestBody:
721
+ content:
722
+ application/json:
723
+ schema:
724
+ $ref: '#/components/schemas/PatchedDoelCategorie'
725
+ security:
726
+ - tokenAuth: []
727
+ responses:
728
+ '200':
729
+ headers:
730
+ API-version:
731
+ schema:
732
+ type: string
733
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
734
+ content:
735
+ application/json:
736
+ schema:
737
+ $ref: '#/components/schemas/DoelCategorie'
738
+ application/problem+json:
739
+ schema:
740
+ $ref: '#/components/schemas/DoelCategorie'
741
+ description: ''
742
+ delete:
743
+ operationId: doelcategorie_destroy
744
+ description: Verwijder een specifiek doelcategorie.
745
+ summary: Doelcategorie verwijderen.
746
+ parameters:
747
+ - in: path
748
+ name: uuid
749
+ schema:
750
+ type: string
751
+ format: uuid
752
+ description: Unieke resource identifier (UUID4).
753
+ required: true
754
+ tags:
755
+ - Doelcategorie
756
+ security:
757
+ - tokenAuth: []
758
+ responses:
759
+ '204':
760
+ headers:
761
+ API-version:
762
+ schema:
763
+ type: string
764
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
765
+ description: No response body
766
+ /doeltype:
767
+ get:
768
+ operationId: doeltype_list
769
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
770
+ summary: Alle doeltypen opvragen.
771
+ parameters:
772
+ - in: query
773
+ name: doelType
774
+ schema:
775
+ type: string
776
+ enum:
777
+ - hoofddoel
778
+ - subdoel
779
+ description: |-
780
+ Het type doel.
781
+
782
+ * `hoofddoel` - Hoofddoel
783
+ * `subdoel` - Subdoel
784
+ - name: page
785
+ required: false
786
+ in: query
787
+ description: Een pagina binnen de gepagineerde set resultaten.
788
+ schema:
789
+ type: integer
790
+ - name: pageSize
791
+ required: false
792
+ in: query
793
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
794
+ schema:
795
+ type: integer
796
+ tags:
797
+ - Doeltype
798
+ security:
799
+ - tokenAuth: []
800
+ responses:
801
+ '200':
802
+ headers:
803
+ API-version:
804
+ schema:
805
+ type: string
806
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
807
+ content:
808
+ application/json:
809
+ schema:
810
+ $ref: '#/components/schemas/PaginatedDoelTypeList'
811
+ application/problem+json:
812
+ schema:
813
+ $ref: '#/components/schemas/PaginatedDoelTypeList'
814
+ description: ''
815
+ post:
816
+ operationId: doeltype_create
817
+ description: Voeg een nieuw doeltype toe aan het systeem.
818
+ summary: Nieuw doeltype aanmaken.
819
+ tags:
820
+ - Doeltype
821
+ requestBody:
822
+ content:
823
+ application/json:
824
+ schema:
825
+ $ref: '#/components/schemas/DoelType'
826
+ required: true
827
+ security:
828
+ - tokenAuth: []
829
+ responses:
830
+ '201':
831
+ headers:
832
+ API-version:
833
+ schema:
834
+ type: string
835
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
836
+ content:
837
+ application/json:
838
+ schema:
839
+ $ref: '#/components/schemas/DoelType'
840
+ application/problem+json:
841
+ schema:
842
+ $ref: '#/components/schemas/DoelType'
843
+ description: ''
844
+ /doeltype/{uuid}:
845
+ get:
846
+ operationId: doeltype_retrieve
847
+ description: Een specifiek doeltype opvragen via UUID.
848
+ summary: Een specifiek doeltype opvragen.
849
+ parameters:
850
+ - in: path
851
+ name: uuid
852
+ schema:
853
+ type: string
854
+ format: uuid
855
+ description: Unieke resource identifier (UUID4).
856
+ required: true
857
+ tags:
858
+ - Doeltype
859
+ security:
860
+ - tokenAuth: []
861
+ responses:
862
+ '200':
863
+ headers:
864
+ API-version:
865
+ schema:
866
+ type: string
867
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
868
+ content:
869
+ application/json:
870
+ schema:
871
+ $ref: '#/components/schemas/DoelType'
872
+ application/problem+json:
873
+ schema:
874
+ $ref: '#/components/schemas/DoelType'
875
+ description: ''
876
+ put:
877
+ operationId: doeltype_update
878
+ description: Werk alle gegevens van een doeltype bij.
879
+ summary: Doeltype volledig bijwerken.
880
+ parameters:
881
+ - in: path
882
+ name: uuid
883
+ schema:
884
+ type: string
885
+ format: uuid
886
+ description: Unieke resource identifier (UUID4).
887
+ required: true
888
+ tags:
889
+ - Doeltype
890
+ requestBody:
891
+ content:
892
+ application/json:
893
+ schema:
894
+ $ref: '#/components/schemas/DoelType'
895
+ required: true
896
+ security:
897
+ - tokenAuth: []
898
+ responses:
899
+ '200':
900
+ headers:
901
+ API-version:
902
+ schema:
903
+ type: string
904
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
905
+ content:
906
+ application/json:
907
+ schema:
908
+ $ref: '#/components/schemas/DoelType'
909
+ application/problem+json:
910
+ schema:
911
+ $ref: '#/components/schemas/DoelType'
912
+ description: ''
913
+ patch:
914
+ operationId: doeltype_partial_update
915
+ description: Werk enkele gegevens van een doeltype bij.
916
+ summary: Doeltype gedeeltelijk bijwerken.
917
+ parameters:
918
+ - in: path
919
+ name: uuid
920
+ schema:
921
+ type: string
922
+ format: uuid
923
+ description: Unieke resource identifier (UUID4).
924
+ required: true
925
+ tags:
926
+ - Doeltype
927
+ requestBody:
928
+ content:
929
+ application/json:
930
+ schema:
931
+ $ref: '#/components/schemas/PatchedDoelType'
932
+ security:
933
+ - tokenAuth: []
934
+ responses:
935
+ '200':
936
+ headers:
937
+ API-version:
938
+ schema:
939
+ type: string
940
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
941
+ content:
942
+ application/json:
943
+ schema:
944
+ $ref: '#/components/schemas/DoelType'
945
+ application/problem+json:
946
+ schema:
947
+ $ref: '#/components/schemas/DoelType'
948
+ description: ''
949
+ delete:
950
+ operationId: doeltype_destroy
951
+ description: Verwijder een specifiek doeltype.
952
+ summary: Doeltype verwijderen.
953
+ parameters:
954
+ - in: path
955
+ name: uuid
956
+ schema:
957
+ type: string
958
+ format: uuid
959
+ description: Unieke resource identifier (UUID4).
960
+ required: true
961
+ tags:
962
+ - Doeltype
963
+ security:
964
+ - tokenAuth: []
965
+ responses:
966
+ '204':
967
+ headers:
968
+ API-version:
969
+ schema:
970
+ type: string
971
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
972
+ description: No response body
973
+ /instrument:
974
+ get:
975
+ operationId: instrument_list
976
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
977
+ summary: Alle instrumenten opvragen.
978
+ parameters:
979
+ - in: query
980
+ name: doelen__uuid
981
+ schema:
982
+ type: string
983
+ format: uuid
984
+ description: Unieke resource identifier (UUID4).
985
+ - in: query
986
+ name: doelen__uuid__in
987
+ schema:
988
+ type: array
989
+ items:
990
+ type: string
991
+ format: uuid
992
+ description: UUID's van gekoppelde doelen.
993
+ explode: false
994
+ style: form
995
+ - in: query
996
+ name: einddatum
997
+ schema:
998
+ type: string
999
+ format: date-time
1000
+ description: Einddatum van het instrument.
1001
+ - in: query
1002
+ name: einddatum__gte
1003
+ schema:
1004
+ type: string
1005
+ format: date-time
1006
+ description: Einddatum van het instrument.
1007
+ - in: query
1008
+ name: einddatum__lte
1009
+ schema:
1010
+ type: string
1011
+ format: date-time
1012
+ description: Einddatum van het instrument.
1013
+ - in: query
1014
+ name: instrumentCategorieen__uuid
1015
+ schema:
1016
+ type: string
1017
+ format: uuid
1018
+ description: Unieke resource identifier (UUID4).
1019
+ - in: query
1020
+ name: instrumentCategorieen__uuid__in
1021
+ schema:
1022
+ type: array
1023
+ items:
1024
+ type: string
1025
+ format: uuid
1026
+ description: UUID's van gekoppelde instrumentcategorieën.
1027
+ explode: false
1028
+ style: form
1029
+ - in: query
1030
+ name: instrumenttype__uuid
1031
+ schema:
1032
+ type: string
1033
+ format: uuid
1034
+ description: Unieke resource identifier (UUID4).
1035
+ - in: query
1036
+ name: ontwikkelwensen__uuid
1037
+ schema:
1038
+ type: string
1039
+ format: uuid
1040
+ description: Unieke resource identifier (UUID4).
1041
+ - in: query
1042
+ name: ontwikkelwensen__uuid__in
1043
+ schema:
1044
+ type: array
1045
+ items:
1046
+ type: string
1047
+ format: uuid
1048
+ description: UUID's van gekoppelde ontwikkelwensen.
1049
+ explode: false
1050
+ style: form
1051
+ - name: page
1052
+ required: false
1053
+ in: query
1054
+ description: Een pagina binnen de gepagineerde set resultaten.
1055
+ schema:
1056
+ type: integer
1057
+ - name: pageSize
1058
+ required: false
1059
+ in: query
1060
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
1061
+ schema:
1062
+ type: integer
1063
+ - in: query
1064
+ name: product
1065
+ schema:
1066
+ type: string
1067
+ description: URN naar de bijbehorende product in het productsysteem.
1068
+ - in: query
1069
+ name: resultaat
1070
+ schema:
1071
+ type: string
1072
+ enum:
1073
+ - behaald
1074
+ - gefaald
1075
+ description: |-
1076
+ Resultaat van het instrument.
1077
+
1078
+ * `behaald` - Behaald
1079
+ * `gefaald` - Gefaald
1080
+ - in: query
1081
+ name: startdatum
1082
+ schema:
1083
+ type: string
1084
+ format: date-time
1085
+ description: Startdatum van het instrument.
1086
+ - in: query
1087
+ name: startdatum__gte
1088
+ schema:
1089
+ type: string
1090
+ format: date-time
1091
+ description: Startdatum van het instrument.
1092
+ - in: query
1093
+ name: startdatum__lte
1094
+ schema:
1095
+ type: string
1096
+ format: date-time
1097
+ description: Startdatum van het instrument.
1098
+ - in: query
1099
+ name: status
1100
+ schema:
1101
+ type: string
1102
+ enum:
1103
+ - actief
1104
+ - afgerond
1105
+ - geannuleerd
1106
+ description: |-
1107
+ Status van het instrument.
1108
+
1109
+ * `actief` - Actief
1110
+ * `afgerond` - Afgerond
1111
+ * `geannuleerd` - Geannuleerd
1112
+ - in: query
1113
+ name: titel
1114
+ schema:
1115
+ type: string
1116
+ description: Titel van het instrument.
1117
+ - in: query
1118
+ name: titel__icontains
1119
+ schema:
1120
+ type: string
1121
+ description: Titel van het instrument.
1122
+ - in: query
1123
+ name: zaak
1124
+ schema:
1125
+ type: string
1126
+ description: URN naar het bijbehorende zaak in het zaaksysteem.
1127
+ tags:
1128
+ - Instrument
1129
+ security:
1130
+ - tokenAuth: []
1131
+ responses:
1132
+ '200':
1133
+ headers:
1134
+ API-version:
1135
+ schema:
1136
+ type: string
1137
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1138
+ content:
1139
+ application/json:
1140
+ schema:
1141
+ $ref: '#/components/schemas/PaginatedInstrumentList'
1142
+ application/problem+json:
1143
+ schema:
1144
+ $ref: '#/components/schemas/PaginatedInstrumentList'
1145
+ description: ''
1146
+ post:
1147
+ operationId: instrument_create
1148
+ description: Voeg een nieuw instrument toe aan het systeem.
1149
+ summary: Nieuw instrument aanmaken.
1150
+ tags:
1151
+ - Instrument
1152
+ requestBody:
1153
+ content:
1154
+ application/json:
1155
+ schema:
1156
+ $ref: '#/components/schemas/Instrument'
1157
+ required: true
1158
+ security:
1159
+ - tokenAuth: []
1160
+ responses:
1161
+ '201':
1162
+ headers:
1163
+ API-version:
1164
+ schema:
1165
+ type: string
1166
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1167
+ content:
1168
+ application/json:
1169
+ schema:
1170
+ $ref: '#/components/schemas/Instrument'
1171
+ application/problem+json:
1172
+ schema:
1173
+ $ref: '#/components/schemas/Instrument'
1174
+ description: ''
1175
+ /instrument/{uuid}:
1176
+ get:
1177
+ operationId: instrument_retrieve
1178
+ description: Een specifiek instrument opvragen via UUID.
1179
+ summary: Een specifiek instrument opvragen.
1180
+ parameters:
1181
+ - in: path
1182
+ name: uuid
1183
+ schema:
1184
+ type: string
1185
+ format: uuid
1186
+ description: Unieke resource identifier (UUID4).
1187
+ required: true
1188
+ tags:
1189
+ - Instrument
1190
+ security:
1191
+ - tokenAuth: []
1192
+ responses:
1193
+ '200':
1194
+ headers:
1195
+ API-version:
1196
+ schema:
1197
+ type: string
1198
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1199
+ content:
1200
+ application/json:
1201
+ schema:
1202
+ $ref: '#/components/schemas/Instrument'
1203
+ application/problem+json:
1204
+ schema:
1205
+ $ref: '#/components/schemas/Instrument'
1206
+ description: ''
1207
+ put:
1208
+ operationId: instrument_update
1209
+ description: Werk alle gegevens van een instrument bij.
1210
+ summary: Instrument volledig bijwerken.
1211
+ parameters:
1212
+ - in: path
1213
+ name: uuid
1214
+ schema:
1215
+ type: string
1216
+ format: uuid
1217
+ description: Unieke resource identifier (UUID4).
1218
+ required: true
1219
+ tags:
1220
+ - Instrument
1221
+ requestBody:
1222
+ content:
1223
+ application/json:
1224
+ schema:
1225
+ $ref: '#/components/schemas/Instrument'
1226
+ required: true
1227
+ security:
1228
+ - tokenAuth: []
1229
+ responses:
1230
+ '200':
1231
+ headers:
1232
+ API-version:
1233
+ schema:
1234
+ type: string
1235
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1236
+ content:
1237
+ application/json:
1238
+ schema:
1239
+ $ref: '#/components/schemas/Instrument'
1240
+ application/problem+json:
1241
+ schema:
1242
+ $ref: '#/components/schemas/Instrument'
1243
+ description: ''
1244
+ patch:
1245
+ operationId: instrument_partial_update
1246
+ description: Werk enkele gegevens van een instrument bij.
1247
+ summary: Instrument gedeeltelijk bijwerken.
1248
+ parameters:
1249
+ - in: path
1250
+ name: uuid
1251
+ schema:
1252
+ type: string
1253
+ format: uuid
1254
+ description: Unieke resource identifier (UUID4).
1255
+ required: true
1256
+ tags:
1257
+ - Instrument
1258
+ requestBody:
1259
+ content:
1260
+ application/json:
1261
+ schema:
1262
+ $ref: '#/components/schemas/PatchedInstrument'
1263
+ security:
1264
+ - tokenAuth: []
1265
+ responses:
1266
+ '200':
1267
+ headers:
1268
+ API-version:
1269
+ schema:
1270
+ type: string
1271
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1272
+ content:
1273
+ application/json:
1274
+ schema:
1275
+ $ref: '#/components/schemas/Instrument'
1276
+ application/problem+json:
1277
+ schema:
1278
+ $ref: '#/components/schemas/Instrument'
1279
+ description: ''
1280
+ delete:
1281
+ operationId: instrument_destroy
1282
+ description: Verwijder een specifiek instrument.
1283
+ summary: Instrument verwijderen.
1284
+ parameters:
1285
+ - in: path
1286
+ name: uuid
1287
+ schema:
1288
+ type: string
1289
+ format: uuid
1290
+ description: Unieke resource identifier (UUID4).
1291
+ required: true
1292
+ tags:
1293
+ - Instrument
1294
+ security:
1295
+ - tokenAuth: []
1296
+ responses:
1297
+ '204':
1298
+ headers:
1299
+ API-version:
1300
+ schema:
1301
+ type: string
1302
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1303
+ description: No response body
1304
+ /instrumenttype:
1305
+ get:
1306
+ operationId: instrumenttype_list
1307
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
1308
+ summary: Alle instrumenttypen opvragen.
1309
+ parameters:
1310
+ - name: page
1311
+ required: false
1312
+ in: query
1313
+ description: Een pagina binnen de gepagineerde set resultaten.
1314
+ schema:
1315
+ type: integer
1316
+ - name: pageSize
1317
+ required: false
1318
+ in: query
1319
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
1320
+ schema:
1321
+ type: integer
1322
+ tags:
1323
+ - Instrumenttype
1324
+ security:
1325
+ - tokenAuth: []
1326
+ responses:
1327
+ '200':
1328
+ headers:
1329
+ API-version:
1330
+ schema:
1331
+ type: string
1332
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1333
+ content:
1334
+ application/json:
1335
+ schema:
1336
+ $ref: '#/components/schemas/PaginatedInstrumentTypeList'
1337
+ application/problem+json:
1338
+ schema:
1339
+ $ref: '#/components/schemas/PaginatedInstrumentTypeList'
1340
+ description: ''
1341
+ post:
1342
+ operationId: instrumenttype_create
1343
+ description: Voeg een nieuw instrumenttype toe aan het systeem.
1344
+ summary: Nieuw instrumenttype aanmaken.
1345
+ tags:
1346
+ - Instrumenttype
1347
+ requestBody:
1348
+ content:
1349
+ application/json:
1350
+ schema:
1351
+ $ref: '#/components/schemas/InstrumentType'
1352
+ required: true
1353
+ security:
1354
+ - tokenAuth: []
1355
+ responses:
1356
+ '201':
1357
+ headers:
1358
+ API-version:
1359
+ schema:
1360
+ type: string
1361
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1362
+ content:
1363
+ application/json:
1364
+ schema:
1365
+ $ref: '#/components/schemas/InstrumentType'
1366
+ application/problem+json:
1367
+ schema:
1368
+ $ref: '#/components/schemas/InstrumentType'
1369
+ description: ''
1370
+ /instrumenttype/{uuid}:
1371
+ get:
1372
+ operationId: instrumenttype_retrieve
1373
+ description: Een specifiek instrumenttype opvragen via UUID.
1374
+ summary: Een specifiek instrumenttype opvragen.
1375
+ parameters:
1376
+ - in: path
1377
+ name: uuid
1378
+ schema:
1379
+ type: string
1380
+ format: uuid
1381
+ description: Unieke resource identifier (UUID4).
1382
+ required: true
1383
+ tags:
1384
+ - Instrumenttype
1385
+ security:
1386
+ - tokenAuth: []
1387
+ responses:
1388
+ '200':
1389
+ headers:
1390
+ API-version:
1391
+ schema:
1392
+ type: string
1393
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1394
+ content:
1395
+ application/json:
1396
+ schema:
1397
+ $ref: '#/components/schemas/InstrumentType'
1398
+ application/problem+json:
1399
+ schema:
1400
+ $ref: '#/components/schemas/InstrumentType'
1401
+ description: ''
1402
+ put:
1403
+ operationId: instrumenttype_update
1404
+ description: Werk alle gegevens van een instrumenttype bij.
1405
+ summary: Instrumenttypen volledig bijwerken.
1406
+ parameters:
1407
+ - in: path
1408
+ name: uuid
1409
+ schema:
1410
+ type: string
1411
+ format: uuid
1412
+ description: Unieke resource identifier (UUID4).
1413
+ required: true
1414
+ tags:
1415
+ - Instrumenttype
1416
+ requestBody:
1417
+ content:
1418
+ application/json:
1419
+ schema:
1420
+ $ref: '#/components/schemas/InstrumentType'
1421
+ required: true
1422
+ security:
1423
+ - tokenAuth: []
1424
+ responses:
1425
+ '200':
1426
+ headers:
1427
+ API-version:
1428
+ schema:
1429
+ type: string
1430
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1431
+ content:
1432
+ application/json:
1433
+ schema:
1434
+ $ref: '#/components/schemas/InstrumentType'
1435
+ application/problem+json:
1436
+ schema:
1437
+ $ref: '#/components/schemas/InstrumentType'
1438
+ description: ''
1439
+ patch:
1440
+ operationId: instrumenttype_partial_update
1441
+ description: Werk enkele gegevens van een instrumenttype bij.
1442
+ summary: Instrumenttypen gedeeltelijk bijwerken.
1443
+ parameters:
1444
+ - in: path
1445
+ name: uuid
1446
+ schema:
1447
+ type: string
1448
+ format: uuid
1449
+ description: Unieke resource identifier (UUID4).
1450
+ required: true
1451
+ tags:
1452
+ - Instrumenttype
1453
+ requestBody:
1454
+ content:
1455
+ application/json:
1456
+ schema:
1457
+ $ref: '#/components/schemas/PatchedInstrumentType'
1458
+ security:
1459
+ - tokenAuth: []
1460
+ responses:
1461
+ '200':
1462
+ headers:
1463
+ API-version:
1464
+ schema:
1465
+ type: string
1466
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1467
+ content:
1468
+ application/json:
1469
+ schema:
1470
+ $ref: '#/components/schemas/InstrumentType'
1471
+ application/problem+json:
1472
+ schema:
1473
+ $ref: '#/components/schemas/InstrumentType'
1474
+ description: ''
1475
+ delete:
1476
+ operationId: instrumenttype_destroy
1477
+ description: Verwijder een specifiek instrumenttype.
1478
+ summary: Instrumenttypen verwijderen.
1479
+ parameters:
1480
+ - in: path
1481
+ name: uuid
1482
+ schema:
1483
+ type: string
1484
+ format: uuid
1485
+ description: Unieke resource identifier (UUID4).
1486
+ required: true
1487
+ tags:
1488
+ - Instrumenttype
1489
+ security:
1490
+ - tokenAuth: []
1491
+ responses:
1492
+ '204':
1493
+ headers:
1494
+ API-version:
1495
+ schema:
1496
+ type: string
1497
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1498
+ description: No response body
1499
+ /ontwikkelwens:
1500
+ get:
1501
+ operationId: ontwikkelwens_list
1502
+ description: Deze lijst kan gefilterd worden met query-string parameters.
1503
+ summary: Alle ontwikkelwensen opvragen.
1504
+ parameters:
1505
+ - in: query
1506
+ name: doelCategorieen__uuid
1507
+ schema:
1508
+ type: string
1509
+ format: uuid
1510
+ description: Unieke resource identifier (UUID4).
1511
+ - in: query
1512
+ name: doelCategorieen__uuid__in
1513
+ schema:
1514
+ type: array
1515
+ items:
1516
+ type: string
1517
+ format: uuid
1518
+ description: UUID's van gekoppelde doelcategorieën.
1519
+ explode: false
1520
+ style: form
1521
+ - in: query
1522
+ name: doel__uuid
1523
+ schema:
1524
+ type: string
1525
+ format: uuid
1526
+ description: Unieke resource identifier (UUID4).
1527
+ - in: query
1528
+ name: einddatum
1529
+ schema:
1530
+ type: string
1531
+ format: date-time
1532
+ description: Einddatum van het ontwikkelwens.
1533
+ - in: query
1534
+ name: einddatum__gte
1535
+ schema:
1536
+ type: string
1537
+ format: date-time
1538
+ description: Einddatum van het ontwikkelwens.
1539
+ - in: query
1540
+ name: einddatum__lte
1541
+ schema:
1542
+ type: string
1543
+ format: date-time
1544
+ description: Einddatum van het ontwikkelwens.
1545
+ - name: page
1546
+ required: false
1547
+ in: query
1548
+ description: Een pagina binnen de gepagineerde set resultaten.
1549
+ schema:
1550
+ type: integer
1551
+ - name: pageSize
1552
+ required: false
1553
+ in: query
1554
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
1555
+ schema:
1556
+ type: integer
1557
+ - in: query
1558
+ name: resultaat
1559
+ schema:
1560
+ type: string
1561
+ enum:
1562
+ - behaald
1563
+ - gefaald
1564
+ description: |-
1565
+ Resultaat van het ontwikkelwens.
1566
+
1567
+ * `behaald` - Behaald
1568
+ * `gefaald` - Gefaald
1569
+ - in: query
1570
+ name: startdatum
1571
+ schema:
1572
+ type: string
1573
+ format: date-time
1574
+ description: Startdatum van het ontwikkelwens.
1575
+ - in: query
1576
+ name: startdatum__gte
1577
+ schema:
1578
+ type: string
1579
+ format: date-time
1580
+ description: Startdatum van het ontwikkelwens.
1581
+ - in: query
1582
+ name: startdatum__lte
1583
+ schema:
1584
+ type: string
1585
+ format: date-time
1586
+ description: Startdatum van het ontwikkelwens.
1587
+ - in: query
1588
+ name: status
1589
+ schema:
1590
+ type: string
1591
+ enum:
1592
+ - actief
1593
+ - afgerond
1594
+ - geannuleerd
1595
+ description: |-
1596
+ Status van het ontwikkelwens.
1597
+
1598
+ * `actief` - Actief
1599
+ * `afgerond` - Afgerond
1600
+ * `geannuleerd` - Geannuleerd
1601
+ - in: query
1602
+ name: titel
1603
+ schema:
1604
+ type: string
1605
+ description: Titel van het ontwikkelwens.
1606
+ - in: query
1607
+ name: titel__icontains
1608
+ schema:
1609
+ type: string
1610
+ description: Titel van het ontwikkelwens.
1611
+ tags:
1612
+ - Ontwikkelwens
1613
+ security:
1614
+ - tokenAuth: []
1615
+ responses:
1616
+ '200':
1617
+ headers:
1618
+ API-version:
1619
+ schema:
1620
+ type: string
1621
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1622
+ content:
1623
+ application/json:
1624
+ schema:
1625
+ $ref: '#/components/schemas/PaginatedOntwikkelwensList'
1626
+ application/problem+json:
1627
+ schema:
1628
+ $ref: '#/components/schemas/PaginatedOntwikkelwensList'
1629
+ description: ''
1630
+ post:
1631
+ operationId: ontwikkelwens_create
1632
+ description: Voeg een nieuwe ontwikkelwens toe aan het systeem.
1633
+ summary: Nieuwe ontwikkelwens aanmaken.
1634
+ tags:
1635
+ - Ontwikkelwens
1636
+ requestBody:
1637
+ content:
1638
+ application/json:
1639
+ schema:
1640
+ $ref: '#/components/schemas/Ontwikkelwens'
1641
+ required: true
1642
+ security:
1643
+ - tokenAuth: []
1644
+ responses:
1645
+ '201':
1646
+ headers:
1647
+ API-version:
1648
+ schema:
1649
+ type: string
1650
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1651
+ content:
1652
+ application/json:
1653
+ schema:
1654
+ $ref: '#/components/schemas/Ontwikkelwens'
1655
+ application/problem+json:
1656
+ schema:
1657
+ $ref: '#/components/schemas/Ontwikkelwens'
1658
+ description: ''
1659
+ /ontwikkelwens/{uuid}:
1660
+ get:
1661
+ operationId: ontwikkelwens_retrieve
1662
+ description: Een specifieke ontwikkelwens opvragen via UUID.
1663
+ summary: Een specifieke ontwikkelwens opvragen.
1664
+ parameters:
1665
+ - in: path
1666
+ name: uuid
1667
+ schema:
1668
+ type: string
1669
+ format: uuid
1670
+ description: Unieke resource identifier (UUID4).
1671
+ required: true
1672
+ tags:
1673
+ - Ontwikkelwens
1674
+ security:
1675
+ - tokenAuth: []
1676
+ responses:
1677
+ '200':
1678
+ headers:
1679
+ API-version:
1680
+ schema:
1681
+ type: string
1682
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1683
+ content:
1684
+ application/json:
1685
+ schema:
1686
+ $ref: '#/components/schemas/Ontwikkelwens'
1687
+ application/problem+json:
1688
+ schema:
1689
+ $ref: '#/components/schemas/Ontwikkelwens'
1690
+ description: ''
1691
+ put:
1692
+ operationId: ontwikkelwens_update
1693
+ description: Werk alle gegevens van een ontwikkelwens bij.
1694
+ summary: Ontwikkelwens volledig bijwerken.
1695
+ parameters:
1696
+ - in: path
1697
+ name: uuid
1698
+ schema:
1699
+ type: string
1700
+ format: uuid
1701
+ description: Unieke resource identifier (UUID4).
1702
+ required: true
1703
+ tags:
1704
+ - Ontwikkelwens
1705
+ requestBody:
1706
+ content:
1707
+ application/json:
1708
+ schema:
1709
+ $ref: '#/components/schemas/Ontwikkelwens'
1710
+ required: true
1711
+ security:
1712
+ - tokenAuth: []
1713
+ responses:
1714
+ '200':
1715
+ headers:
1716
+ API-version:
1717
+ schema:
1718
+ type: string
1719
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1720
+ content:
1721
+ application/json:
1722
+ schema:
1723
+ $ref: '#/components/schemas/Ontwikkelwens'
1724
+ application/problem+json:
1725
+ schema:
1726
+ $ref: '#/components/schemas/Ontwikkelwens'
1727
+ description: ''
1728
+ patch:
1729
+ operationId: ontwikkelwens_partial_update
1730
+ description: Werk enkele gegevens van een ontwikkelwens bij.
1731
+ summary: Ontwikkelwens gedeeltelijk bijwerken.
1732
+ parameters:
1733
+ - in: path
1734
+ name: uuid
1735
+ schema:
1736
+ type: string
1737
+ format: uuid
1738
+ description: Unieke resource identifier (UUID4).
1739
+ required: true
1740
+ tags:
1741
+ - Ontwikkelwens
1742
+ requestBody:
1743
+ content:
1744
+ application/json:
1745
+ schema:
1746
+ $ref: '#/components/schemas/PatchedOntwikkelwens'
1747
+ security:
1748
+ - tokenAuth: []
1749
+ responses:
1750
+ '200':
1751
+ headers:
1752
+ API-version:
1753
+ schema:
1754
+ type: string
1755
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1756
+ content:
1757
+ application/json:
1758
+ schema:
1759
+ $ref: '#/components/schemas/Ontwikkelwens'
1760
+ application/problem+json:
1761
+ schema:
1762
+ $ref: '#/components/schemas/Ontwikkelwens'
1763
+ description: ''
1764
+ delete:
1765
+ operationId: ontwikkelwens_destroy
1766
+ description: Verwijder een specifieke ontwikkelwens.
1767
+ summary: Ontwikkelwens verwijderen.
1768
+ parameters:
1769
+ - in: path
1770
+ name: uuid
1771
+ schema:
1772
+ type: string
1773
+ format: uuid
1774
+ description: Unieke resource identifier (UUID4).
1775
+ required: true
1776
+ tags:
1777
+ - Ontwikkelwens
1778
+ security:
1779
+ - tokenAuth: []
1780
+ responses:
1781
+ '204':
1782
+ headers:
1783
+ API-version:
1784
+ schema:
1785
+ type: string
1786
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1787
+ description: No response body
1788
+ /overkoepelendplan:
1789
+ get:
1790
+ operationId: overkoepelendplan_list
1791
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
1792
+ summary: Alle overkoepelende plannen opvragen.
1793
+ parameters:
1794
+ - name: page
1795
+ required: false
1796
+ in: query
1797
+ description: Een pagina binnen de gepagineerde set resultaten.
1798
+ schema:
1799
+ type: integer
1800
+ - name: pageSize
1801
+ required: false
1802
+ in: query
1803
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
1804
+ schema:
1805
+ type: integer
1806
+ tags:
1807
+ - Overkoepelend Plan
1808
+ security:
1809
+ - tokenAuth: []
1810
+ responses:
1811
+ '200':
1812
+ headers:
1813
+ API-version:
1814
+ schema:
1815
+ type: string
1816
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1817
+ content:
1818
+ application/json:
1819
+ schema:
1820
+ $ref: '#/components/schemas/PaginatedOverkoepelendPlanList'
1821
+ application/problem+json:
1822
+ schema:
1823
+ $ref: '#/components/schemas/PaginatedOverkoepelendPlanList'
1824
+ description: ''
1825
+ post:
1826
+ operationId: overkoepelendplan_create
1827
+ description: Voeg een nieuw overkoepelend plan toe aan het systeem.
1828
+ summary: Nieuw overkoepelend plan aanmaken.
1829
+ tags:
1830
+ - Overkoepelend Plan
1831
+ requestBody:
1832
+ content:
1833
+ application/json:
1834
+ schema:
1835
+ $ref: '#/components/schemas/OverkoepelendPlan'
1836
+ required: true
1837
+ security:
1838
+ - tokenAuth: []
1839
+ responses:
1840
+ '201':
1841
+ headers:
1842
+ API-version:
1843
+ schema:
1844
+ type: string
1845
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1846
+ content:
1847
+ application/json:
1848
+ schema:
1849
+ $ref: '#/components/schemas/OverkoepelendPlan'
1850
+ application/problem+json:
1851
+ schema:
1852
+ $ref: '#/components/schemas/OverkoepelendPlan'
1853
+ description: ''
1854
+ /overkoepelendplan/{uuid}:
1855
+ get:
1856
+ operationId: overkoepelendplan_retrieve
1857
+ description: Een specifiek overkoepelend plan opvragen via UUID.
1858
+ summary: Een specifiek overkoepelend plan opvragen.
1859
+ parameters:
1860
+ - in: path
1861
+ name: uuid
1862
+ schema:
1863
+ type: string
1864
+ format: uuid
1865
+ description: Unieke resource identifier (UUID4).
1866
+ required: true
1867
+ tags:
1868
+ - Overkoepelend Plan
1869
+ security:
1870
+ - tokenAuth: []
1871
+ responses:
1872
+ '200':
1873
+ headers:
1874
+ API-version:
1875
+ schema:
1876
+ type: string
1877
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1878
+ content:
1879
+ application/json:
1880
+ schema:
1881
+ $ref: '#/components/schemas/OverkoepelendPlan'
1882
+ application/problem+json:
1883
+ schema:
1884
+ $ref: '#/components/schemas/OverkoepelendPlan'
1885
+ description: ''
1886
+ put:
1887
+ operationId: overkoepelendplan_update
1888
+ description: Werk alle gegevens van een overkoepelend plan bij.
1889
+ summary: Overkoepelend plan volledig bijwerken.
1890
+ parameters:
1891
+ - in: path
1892
+ name: uuid
1893
+ schema:
1894
+ type: string
1895
+ format: uuid
1896
+ description: Unieke resource identifier (UUID4).
1897
+ required: true
1898
+ tags:
1899
+ - Overkoepelend Plan
1900
+ requestBody:
1901
+ content:
1902
+ application/json:
1903
+ schema:
1904
+ $ref: '#/components/schemas/OverkoepelendPlan'
1905
+ required: true
1906
+ security:
1907
+ - tokenAuth: []
1908
+ responses:
1909
+ '200':
1910
+ headers:
1911
+ API-version:
1912
+ schema:
1913
+ type: string
1914
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1915
+ content:
1916
+ application/json:
1917
+ schema:
1918
+ $ref: '#/components/schemas/OverkoepelendPlan'
1919
+ application/problem+json:
1920
+ schema:
1921
+ $ref: '#/components/schemas/OverkoepelendPlan'
1922
+ description: ''
1923
+ patch:
1924
+ operationId: overkoepelendplan_partial_update
1925
+ description: Werk enkele gegevens van een overkoepelend plan bij.
1926
+ summary: Overkoepelend plan gedeeltelijk bijwerken.
1927
+ parameters:
1928
+ - in: path
1929
+ name: uuid
1930
+ schema:
1931
+ type: string
1932
+ format: uuid
1933
+ description: Unieke resource identifier (UUID4).
1934
+ required: true
1935
+ tags:
1936
+ - Overkoepelend Plan
1937
+ requestBody:
1938
+ content:
1939
+ application/json:
1940
+ schema:
1941
+ $ref: '#/components/schemas/PatchedOverkoepelendPlan'
1942
+ security:
1943
+ - tokenAuth: []
1944
+ responses:
1945
+ '200':
1946
+ headers:
1947
+ API-version:
1948
+ schema:
1949
+ type: string
1950
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1951
+ content:
1952
+ application/json:
1953
+ schema:
1954
+ $ref: '#/components/schemas/OverkoepelendPlan'
1955
+ application/problem+json:
1956
+ schema:
1957
+ $ref: '#/components/schemas/OverkoepelendPlan'
1958
+ description: ''
1959
+ delete:
1960
+ operationId: overkoepelendplan_destroy
1961
+ description: Verwijder een specifiek overkoepelend plan.
1962
+ summary: Overkoepelend plan verwijderen.
1963
+ parameters:
1964
+ - in: path
1965
+ name: uuid
1966
+ schema:
1967
+ type: string
1968
+ format: uuid
1969
+ description: Unieke resource identifier (UUID4).
1970
+ required: true
1971
+ tags:
1972
+ - Overkoepelend Plan
1973
+ security:
1974
+ - tokenAuth: []
1975
+ responses:
1976
+ '204':
1977
+ headers:
1978
+ API-version:
1979
+ schema:
1980
+ type: string
1981
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
1982
+ description: No response body
1983
+ /persoon:
1984
+ get:
1985
+ operationId: persoon_list
1986
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
1987
+ summary: Alle personen opvragen.
1988
+ parameters:
1989
+ - name: page
1990
+ required: false
1991
+ in: query
1992
+ description: Een pagina binnen de gepagineerde set resultaten.
1993
+ schema:
1994
+ type: integer
1995
+ - name: pageSize
1996
+ required: false
1997
+ in: query
1998
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
1999
+ schema:
2000
+ type: integer
2001
+ tags:
2002
+ - Persoon
2003
+ security:
2004
+ - tokenAuth: []
2005
+ responses:
2006
+ '200':
2007
+ headers:
2008
+ API-version:
2009
+ schema:
2010
+ type: string
2011
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2012
+ content:
2013
+ application/json:
2014
+ schema:
2015
+ $ref: '#/components/schemas/PaginatedPersoonList'
2016
+ application/problem+json:
2017
+ schema:
2018
+ $ref: '#/components/schemas/PaginatedPersoonList'
2019
+ description: ''
2020
+ post:
2021
+ operationId: persoon_create
2022
+ description: Voeg een nieuw persoon toe aan het systeem.
2023
+ summary: Nieuw persoon aanmaken.
2024
+ tags:
2025
+ - Persoon
2026
+ requestBody:
2027
+ content:
2028
+ application/json:
2029
+ schema:
2030
+ $ref: '#/components/schemas/Persoon'
2031
+ security:
2032
+ - tokenAuth: []
2033
+ responses:
2034
+ '201':
2035
+ headers:
2036
+ API-version:
2037
+ schema:
2038
+ type: string
2039
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2040
+ content:
2041
+ application/json:
2042
+ schema:
2043
+ $ref: '#/components/schemas/Persoon'
2044
+ application/problem+json:
2045
+ schema:
2046
+ $ref: '#/components/schemas/Persoon'
2047
+ description: ''
2048
+ /persoon/{uuid}:
2049
+ get:
2050
+ operationId: persoon_retrieve
2051
+ description: Een specifiek persoon opvragen via UUID.
2052
+ summary: Een specifiek persoon opvragen.
2053
+ parameters:
2054
+ - in: path
2055
+ name: uuid
2056
+ schema:
2057
+ type: string
2058
+ format: uuid
2059
+ description: Unieke resource identifier (UUID4).
2060
+ required: true
2061
+ tags:
2062
+ - Persoon
2063
+ security:
2064
+ - tokenAuth: []
2065
+ responses:
2066
+ '200':
2067
+ headers:
2068
+ API-version:
2069
+ schema:
2070
+ type: string
2071
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2072
+ content:
2073
+ application/json:
2074
+ schema:
2075
+ $ref: '#/components/schemas/Persoon'
2076
+ application/problem+json:
2077
+ schema:
2078
+ $ref: '#/components/schemas/Persoon'
2079
+ description: ''
2080
+ put:
2081
+ operationId: persoon_update
2082
+ description: Werk alle gegevens van een persoon bij.
2083
+ summary: Persoon volledig bijwerken.
2084
+ parameters:
2085
+ - in: path
2086
+ name: uuid
2087
+ schema:
2088
+ type: string
2089
+ format: uuid
2090
+ description: Unieke resource identifier (UUID4).
2091
+ required: true
2092
+ tags:
2093
+ - Persoon
2094
+ requestBody:
2095
+ content:
2096
+ application/json:
2097
+ schema:
2098
+ $ref: '#/components/schemas/Persoon'
2099
+ security:
2100
+ - tokenAuth: []
2101
+ responses:
2102
+ '200':
2103
+ headers:
2104
+ API-version:
2105
+ schema:
2106
+ type: string
2107
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2108
+ content:
2109
+ application/json:
2110
+ schema:
2111
+ $ref: '#/components/schemas/Persoon'
2112
+ application/problem+json:
2113
+ schema:
2114
+ $ref: '#/components/schemas/Persoon'
2115
+ description: ''
2116
+ patch:
2117
+ operationId: persoon_partial_update
2118
+ description: Werk enkele gegevens van een persoon bij.
2119
+ summary: Persoon gedeeltelijk bijwerken.
2120
+ parameters:
2121
+ - in: path
2122
+ name: uuid
2123
+ schema:
2124
+ type: string
2125
+ format: uuid
2126
+ description: Unieke resource identifier (UUID4).
2127
+ required: true
2128
+ tags:
2129
+ - Persoon
2130
+ requestBody:
2131
+ content:
2132
+ application/json:
2133
+ schema:
2134
+ $ref: '#/components/schemas/PatchedPersoon'
2135
+ security:
2136
+ - tokenAuth: []
2137
+ responses:
2138
+ '200':
2139
+ headers:
2140
+ API-version:
2141
+ schema:
2142
+ type: string
2143
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2144
+ content:
2145
+ application/json:
2146
+ schema:
2147
+ $ref: '#/components/schemas/Persoon'
2148
+ application/problem+json:
2149
+ schema:
2150
+ $ref: '#/components/schemas/Persoon'
2151
+ description: ''
2152
+ delete:
2153
+ operationId: persoon_destroy
2154
+ description: Verwijder een specifiek persoon.
2155
+ summary: Persoon verwijderen.
2156
+ parameters:
2157
+ - in: path
2158
+ name: uuid
2159
+ schema:
2160
+ type: string
2161
+ format: uuid
2162
+ description: Unieke resource identifier (UUID4).
2163
+ required: true
2164
+ tags:
2165
+ - Persoon
2166
+ security:
2167
+ - tokenAuth: []
2168
+ responses:
2169
+ '204':
2170
+ headers:
2171
+ API-version:
2172
+ schema:
2173
+ type: string
2174
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2175
+ description: No response body
2176
+ /plan:
2177
+ get:
2178
+ operationId: plan_list
2179
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
2180
+ summary: Alle plannen opvragen.
2181
+ parameters:
2182
+ - in: query
2183
+ name: domeinregister
2184
+ schema:
2185
+ type: string
2186
+ description: URN naar het domeinregister voor dit plan.
2187
+ - in: query
2188
+ name: einddatum
2189
+ schema:
2190
+ type: string
2191
+ format: date-time
2192
+ description: Einddatum van het plan.
2193
+ - in: query
2194
+ name: einddatum__gte
2195
+ schema:
2196
+ type: string
2197
+ format: date-time
2198
+ description: Einddatum van het plan.
2199
+ - in: query
2200
+ name: einddatum__lte
2201
+ schema:
2202
+ type: string
2203
+ format: date-time
2204
+ description: Einddatum van het plan.
2205
+ - in: query
2206
+ name: fase
2207
+ schema:
2208
+ type: string
2209
+ enum:
2210
+ - actief
2211
+ - afgerond
2212
+ - geannuleerd
2213
+ description: |-
2214
+ Fase van het plan.
2215
+
2216
+ * `actief` - Actief
2217
+ * `afgerond` - Afgerond
2218
+ * `geannuleerd` - Geannuleerd
2219
+ - in: query
2220
+ name: medewerker
2221
+ schema:
2222
+ type: string
2223
+ description: URN naar de medewerker in het HR-systeem.
2224
+ - in: query
2225
+ name: overkoepelendPlan__uuid
2226
+ schema:
2227
+ type: string
2228
+ format: uuid
2229
+ description: Unieke resource identifier (UUID4).
2230
+ - name: page
2231
+ required: false
2232
+ in: query
2233
+ description: Een pagina binnen de gepagineerde set resultaten.
2234
+ schema:
2235
+ type: integer
2236
+ - name: pageSize
2237
+ required: false
2238
+ in: query
2239
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
2240
+ schema:
2241
+ type: integer
2242
+ - in: query
2243
+ name: plantype__uuid
2244
+ schema:
2245
+ type: string
2246
+ format: uuid
2247
+ description: Unieke resource identifier (UUID4).
2248
+ - in: query
2249
+ name: startdatum
2250
+ schema:
2251
+ type: string
2252
+ format: date-time
2253
+ description: Startdatum van het plan.
2254
+ - in: query
2255
+ name: startdatum__gte
2256
+ schema:
2257
+ type: string
2258
+ format: date-time
2259
+ description: Startdatum van het plan.
2260
+ - in: query
2261
+ name: startdatum__lte
2262
+ schema:
2263
+ type: string
2264
+ format: date-time
2265
+ description: Startdatum van het plan.
2266
+ - in: query
2267
+ name: status
2268
+ schema:
2269
+ type: string
2270
+ enum:
2271
+ - actief
2272
+ - afgerond
2273
+ - geannuleerd
2274
+ description: |-
2275
+ Status van het plan.
2276
+
2277
+ * `actief` - Actief
2278
+ * `afgerond` - Afgerond
2279
+ * `geannuleerd` - Geannuleerd
2280
+ - in: query
2281
+ name: titel
2282
+ schema:
2283
+ type: string
2284
+ description: Titel van het plan.
2285
+ - in: query
2286
+ name: titel__icontains
2287
+ schema:
2288
+ type: string
2289
+ description: Titel van het plan.
2290
+ - in: query
2291
+ name: zaak
2292
+ schema:
2293
+ type: string
2294
+ description: URN naar de bijbehorende zaak in het zaaksysteem.
2295
+ tags:
2296
+ - Plan
2297
+ security:
2298
+ - tokenAuth: []
2299
+ responses:
2300
+ '200':
2301
+ headers:
2302
+ API-version:
2303
+ schema:
2304
+ type: string
2305
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2306
+ content:
2307
+ application/json:
2308
+ schema:
2309
+ $ref: '#/components/schemas/PaginatedPlanList'
2310
+ application/problem+json:
2311
+ schema:
2312
+ $ref: '#/components/schemas/PaginatedPlanList'
2313
+ description: ''
2314
+ post:
2315
+ operationId: plan_create
2316
+ description: Voeg een nieuw plan toe aan het systeem.
2317
+ summary: Nieuw plan aanmaken.
2318
+ tags:
2319
+ - Plan
2320
+ requestBody:
2321
+ content:
2322
+ application/json:
2323
+ schema:
2324
+ $ref: '#/components/schemas/Plan'
2325
+ required: true
2326
+ security:
2327
+ - tokenAuth: []
2328
+ responses:
2329
+ '201':
2330
+ headers:
2331
+ API-version:
2332
+ schema:
2333
+ type: string
2334
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2335
+ content:
2336
+ application/json:
2337
+ schema:
2338
+ $ref: '#/components/schemas/Plan'
2339
+ application/problem+json:
2340
+ schema:
2341
+ $ref: '#/components/schemas/Plan'
2342
+ description: ''
2343
+ /plan/{uuid}:
2344
+ get:
2345
+ operationId: plan_retrieve
2346
+ description: Een specifiek plan opvragen via UUID.
2347
+ summary: Een specifiek plan opvragen.
2348
+ parameters:
2349
+ - in: path
2350
+ name: uuid
2351
+ schema:
2352
+ type: string
2353
+ format: uuid
2354
+ description: Unieke resource identifier (UUID4).
2355
+ required: true
2356
+ tags:
2357
+ - Plan
2358
+ security:
2359
+ - tokenAuth: []
2360
+ responses:
2361
+ '200':
2362
+ headers:
2363
+ API-version:
2364
+ schema:
2365
+ type: string
2366
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2367
+ content:
2368
+ application/json:
2369
+ schema:
2370
+ $ref: '#/components/schemas/Plan'
2371
+ application/problem+json:
2372
+ schema:
2373
+ $ref: '#/components/schemas/Plan'
2374
+ description: ''
2375
+ put:
2376
+ operationId: plan_update
2377
+ description: Werk alle gegevens van een plan bij.
2378
+ summary: Plan volledig bijwerken.
2379
+ parameters:
2380
+ - in: path
2381
+ name: uuid
2382
+ schema:
2383
+ type: string
2384
+ format: uuid
2385
+ description: Unieke resource identifier (UUID4).
2386
+ required: true
2387
+ tags:
2388
+ - Plan
2389
+ requestBody:
2390
+ content:
2391
+ application/json:
2392
+ schema:
2393
+ $ref: '#/components/schemas/Plan'
2394
+ required: true
2395
+ security:
2396
+ - tokenAuth: []
2397
+ responses:
2398
+ '200':
2399
+ headers:
2400
+ API-version:
2401
+ schema:
2402
+ type: string
2403
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2404
+ content:
2405
+ application/json:
2406
+ schema:
2407
+ $ref: '#/components/schemas/Plan'
2408
+ application/problem+json:
2409
+ schema:
2410
+ $ref: '#/components/schemas/Plan'
2411
+ description: ''
2412
+ patch:
2413
+ operationId: plan_partial_update
2414
+ description: Werk enkele gegevens van een plan bij.
2415
+ summary: Plan gedeeltelijk bijwerken.
2416
+ parameters:
2417
+ - in: path
2418
+ name: uuid
2419
+ schema:
2420
+ type: string
2421
+ format: uuid
2422
+ description: Unieke resource identifier (UUID4).
2423
+ required: true
2424
+ tags:
2425
+ - Plan
2426
+ requestBody:
2427
+ content:
2428
+ application/json:
2429
+ schema:
2430
+ $ref: '#/components/schemas/PatchedPlan'
2431
+ security:
2432
+ - tokenAuth: []
2433
+ responses:
2434
+ '200':
2435
+ headers:
2436
+ API-version:
2437
+ schema:
2438
+ type: string
2439
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2440
+ content:
2441
+ application/json:
2442
+ schema:
2443
+ $ref: '#/components/schemas/Plan'
2444
+ application/problem+json:
2445
+ schema:
2446
+ $ref: '#/components/schemas/Plan'
2447
+ description: ''
2448
+ delete:
2449
+ operationId: plan_destroy
2450
+ description: Verwijder een specifiek plan.
2451
+ summary: Plan verwijderen.
2452
+ parameters:
2453
+ - in: path
2454
+ name: uuid
2455
+ schema:
2456
+ type: string
2457
+ format: uuid
2458
+ description: Unieke resource identifier (UUID4).
2459
+ required: true
2460
+ tags:
2461
+ - Plan
2462
+ security:
2463
+ - tokenAuth: []
2464
+ responses:
2465
+ '204':
2466
+ headers:
2467
+ API-version:
2468
+ schema:
2469
+ type: string
2470
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2471
+ description: No response body
2472
+ /plantype:
2473
+ get:
2474
+ operationId: plantype_list
2475
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
2476
+ summary: Alle plantypes opvragen.
2477
+ parameters:
2478
+ - name: page
2479
+ required: false
2480
+ in: query
2481
+ description: Een pagina binnen de gepagineerde set resultaten.
2482
+ schema:
2483
+ type: integer
2484
+ - name: pageSize
2485
+ required: false
2486
+ in: query
2487
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
2488
+ schema:
2489
+ type: integer
2490
+ - in: query
2491
+ name: type
2492
+ schema:
2493
+ type: string
2494
+ enum:
2495
+ - inkomen
2496
+ - pip
2497
+ - werk
2498
+ description: |-
2499
+ Het type plan.
2500
+
2501
+ * `pip` - Persoonlijk plan inburgering en perticipatie
2502
+ * `werk` - Werk
2503
+ * `inkomen` - Inkomen
2504
+ tags:
2505
+ - Plantype
2506
+ security:
2507
+ - tokenAuth: []
2508
+ responses:
2509
+ '200':
2510
+ headers:
2511
+ API-version:
2512
+ schema:
2513
+ type: string
2514
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2515
+ content:
2516
+ application/json:
2517
+ schema:
2518
+ $ref: '#/components/schemas/PaginatedPlanTypeList'
2519
+ application/problem+json:
2520
+ schema:
2521
+ $ref: '#/components/schemas/PaginatedPlanTypeList'
2522
+ description: ''
2523
+ post:
2524
+ operationId: plantype_create
2525
+ description: Voeg een nieuw plantype toe aan het systeem.
2526
+ summary: Nieuw plantype aanmaken.
2527
+ tags:
2528
+ - Plantype
2529
+ requestBody:
2530
+ content:
2531
+ application/json:
2532
+ schema:
2533
+ $ref: '#/components/schemas/PlanType'
2534
+ required: true
2535
+ security:
2536
+ - tokenAuth: []
2537
+ responses:
2538
+ '201':
2539
+ headers:
2540
+ API-version:
2541
+ schema:
2542
+ type: string
2543
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2544
+ content:
2545
+ application/json:
2546
+ schema:
2547
+ $ref: '#/components/schemas/PlanType'
2548
+ application/problem+json:
2549
+ schema:
2550
+ $ref: '#/components/schemas/PlanType'
2551
+ description: ''
2552
+ /plantype/{uuid}:
2553
+ get:
2554
+ operationId: plantype_retrieve
2555
+ description: Een specifiek plantype opvragen via UUID.
2556
+ summary: Een specifiek plantype opvragen.
2557
+ parameters:
2558
+ - in: path
2559
+ name: uuid
2560
+ schema:
2561
+ type: string
2562
+ format: uuid
2563
+ description: Unieke resource identifier (UUID4).
2564
+ required: true
2565
+ tags:
2566
+ - Plantype
2567
+ security:
2568
+ - tokenAuth: []
2569
+ responses:
2570
+ '200':
2571
+ headers:
2572
+ API-version:
2573
+ schema:
2574
+ type: string
2575
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2576
+ content:
2577
+ application/json:
2578
+ schema:
2579
+ $ref: '#/components/schemas/PlanType'
2580
+ application/problem+json:
2581
+ schema:
2582
+ $ref: '#/components/schemas/PlanType'
2583
+ description: ''
2584
+ put:
2585
+ operationId: plantype_update
2586
+ description: Werk alle gegevens van een plantype bij.
2587
+ summary: Plantype volledig bijwerken.
2588
+ parameters:
2589
+ - in: path
2590
+ name: uuid
2591
+ schema:
2592
+ type: string
2593
+ format: uuid
2594
+ description: Unieke resource identifier (UUID4).
2595
+ required: true
2596
+ tags:
2597
+ - Plantype
2598
+ requestBody:
2599
+ content:
2600
+ application/json:
2601
+ schema:
2602
+ $ref: '#/components/schemas/PlanType'
2603
+ required: true
2604
+ security:
2605
+ - tokenAuth: []
2606
+ responses:
2607
+ '200':
2608
+ headers:
2609
+ API-version:
2610
+ schema:
2611
+ type: string
2612
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2613
+ content:
2614
+ application/json:
2615
+ schema:
2616
+ $ref: '#/components/schemas/PlanType'
2617
+ application/problem+json:
2618
+ schema:
2619
+ $ref: '#/components/schemas/PlanType'
2620
+ description: ''
2621
+ patch:
2622
+ operationId: plantype_partial_update
2623
+ description: Werk enkele gegevens van een plantype bij.
2624
+ summary: Plantype gedeeltelijk bijwerken.
2625
+ parameters:
2626
+ - in: path
2627
+ name: uuid
2628
+ schema:
2629
+ type: string
2630
+ format: uuid
2631
+ description: Unieke resource identifier (UUID4).
2632
+ required: true
2633
+ tags:
2634
+ - Plantype
2635
+ requestBody:
2636
+ content:
2637
+ application/json:
2638
+ schema:
2639
+ $ref: '#/components/schemas/PatchedPlanType'
2640
+ security:
2641
+ - tokenAuth: []
2642
+ responses:
2643
+ '200':
2644
+ headers:
2645
+ API-version:
2646
+ schema:
2647
+ type: string
2648
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2649
+ content:
2650
+ application/json:
2651
+ schema:
2652
+ $ref: '#/components/schemas/PlanType'
2653
+ application/problem+json:
2654
+ schema:
2655
+ $ref: '#/components/schemas/PlanType'
2656
+ description: ''
2657
+ delete:
2658
+ operationId: plantype_destroy
2659
+ description: Verwijder een specifiek plantype.
2660
+ summary: Plantype verwijderen.
2661
+ parameters:
2662
+ - in: path
2663
+ name: uuid
2664
+ schema:
2665
+ type: string
2666
+ format: uuid
2667
+ description: Unieke resource identifier (UUID4).
2668
+ required: true
2669
+ tags:
2670
+ - Plantype
2671
+ security:
2672
+ - tokenAuth: []
2673
+ responses:
2674
+ '204':
2675
+ headers:
2676
+ API-version:
2677
+ schema:
2678
+ type: string
2679
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2680
+ description: No response body
2681
+ /relatie:
2682
+ get:
2683
+ operationId: relatie_list
2684
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
2685
+ summary: Alle relaties opvragen.
2686
+ parameters:
2687
+ - in: query
2688
+ name: gerelateerdePersoon__uuid
2689
+ schema:
2690
+ type: string
2691
+ format: uuid
2692
+ description: Unieke resource identifier (UUID4).
2693
+ - name: page
2694
+ required: false
2695
+ in: query
2696
+ description: Een pagina binnen de gepagineerde set resultaten.
2697
+ schema:
2698
+ type: integer
2699
+ - name: pageSize
2700
+ required: false
2701
+ in: query
2702
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
2703
+ schema:
2704
+ type: integer
2705
+ - in: query
2706
+ name: persoon__uuid
2707
+ schema:
2708
+ type: string
2709
+ format: uuid
2710
+ description: Unieke resource identifier (UUID4).
2711
+ - in: query
2712
+ name: relatietype__uuid
2713
+ schema:
2714
+ type: string
2715
+ format: uuid
2716
+ description: Unieke resource identifier (UUID4).
2717
+ tags:
2718
+ - Relatie
2719
+ security:
2720
+ - tokenAuth: []
2721
+ responses:
2722
+ '200':
2723
+ headers:
2724
+ API-version:
2725
+ schema:
2726
+ type: string
2727
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2728
+ content:
2729
+ application/json:
2730
+ schema:
2731
+ $ref: '#/components/schemas/PaginatedRelatieList'
2732
+ application/problem+json:
2733
+ schema:
2734
+ $ref: '#/components/schemas/PaginatedRelatieList'
2735
+ description: ''
2736
+ post:
2737
+ operationId: relatie_create
2738
+ description: Voeg een nieuw relatie toe aan het systeem.
2739
+ summary: Nieuw relatie aanmaken.
2740
+ tags:
2741
+ - Relatie
2742
+ requestBody:
2743
+ content:
2744
+ application/json:
2745
+ schema:
2746
+ $ref: '#/components/schemas/Relatie'
2747
+ required: true
2748
+ security:
2749
+ - tokenAuth: []
2750
+ responses:
2751
+ '201':
2752
+ headers:
2753
+ API-version:
2754
+ schema:
2755
+ type: string
2756
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2757
+ content:
2758
+ application/json:
2759
+ schema:
2760
+ $ref: '#/components/schemas/Relatie'
2761
+ application/problem+json:
2762
+ schema:
2763
+ $ref: '#/components/schemas/Relatie'
2764
+ description: ''
2765
+ /relatie/{uuid}:
2766
+ get:
2767
+ operationId: relatie_retrieve
2768
+ description: Een specifiek relatie opvragen via UUID.
2769
+ summary: Een specifiek relatie opvragen.
2770
+ parameters:
2771
+ - in: path
2772
+ name: uuid
2773
+ schema:
2774
+ type: string
2775
+ format: uuid
2776
+ description: Unieke resource identifier (UUID4).
2777
+ required: true
2778
+ tags:
2779
+ - Relatie
2780
+ security:
2781
+ - tokenAuth: []
2782
+ responses:
2783
+ '200':
2784
+ headers:
2785
+ API-version:
2786
+ schema:
2787
+ type: string
2788
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2789
+ content:
2790
+ application/json:
2791
+ schema:
2792
+ $ref: '#/components/schemas/Relatie'
2793
+ application/problem+json:
2794
+ schema:
2795
+ $ref: '#/components/schemas/Relatie'
2796
+ description: ''
2797
+ put:
2798
+ operationId: relatie_update
2799
+ description: Werk alle gegevens van een relatie bij.
2800
+ summary: Relatie volledig bijwerken.
2801
+ parameters:
2802
+ - in: path
2803
+ name: uuid
2804
+ schema:
2805
+ type: string
2806
+ format: uuid
2807
+ description: Unieke resource identifier (UUID4).
2808
+ required: true
2809
+ tags:
2810
+ - Relatie
2811
+ requestBody:
2812
+ content:
2813
+ application/json:
2814
+ schema:
2815
+ $ref: '#/components/schemas/Relatie'
2816
+ required: true
2817
+ security:
2818
+ - tokenAuth: []
2819
+ responses:
2820
+ '200':
2821
+ headers:
2822
+ API-version:
2823
+ schema:
2824
+ type: string
2825
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2826
+ content:
2827
+ application/json:
2828
+ schema:
2829
+ $ref: '#/components/schemas/Relatie'
2830
+ application/problem+json:
2831
+ schema:
2832
+ $ref: '#/components/schemas/Relatie'
2833
+ description: ''
2834
+ patch:
2835
+ operationId: relatie_partial_update
2836
+ description: Werk enkele gegevens van een relatie bij.
2837
+ summary: Relatie gedeeltelijk bijwerken.
2838
+ parameters:
2839
+ - in: path
2840
+ name: uuid
2841
+ schema:
2842
+ type: string
2843
+ format: uuid
2844
+ description: Unieke resource identifier (UUID4).
2845
+ required: true
2846
+ tags:
2847
+ - Relatie
2848
+ requestBody:
2849
+ content:
2850
+ application/json:
2851
+ schema:
2852
+ $ref: '#/components/schemas/PatchedRelatie'
2853
+ security:
2854
+ - tokenAuth: []
2855
+ responses:
2856
+ '200':
2857
+ headers:
2858
+ API-version:
2859
+ schema:
2860
+ type: string
2861
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2862
+ content:
2863
+ application/json:
2864
+ schema:
2865
+ $ref: '#/components/schemas/Relatie'
2866
+ application/problem+json:
2867
+ schema:
2868
+ $ref: '#/components/schemas/Relatie'
2869
+ description: ''
2870
+ delete:
2871
+ operationId: relatie_destroy
2872
+ description: Verwijder een specifiek relatie.
2873
+ summary: Relatie verwijderen.
2874
+ parameters:
2875
+ - in: path
2876
+ name: uuid
2877
+ schema:
2878
+ type: string
2879
+ format: uuid
2880
+ description: Unieke resource identifier (UUID4).
2881
+ required: true
2882
+ tags:
2883
+ - Relatie
2884
+ security:
2885
+ - tokenAuth: []
2886
+ responses:
2887
+ '204':
2888
+ headers:
2889
+ API-version:
2890
+ schema:
2891
+ type: string
2892
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2893
+ description: No response body
2894
+ /relatietype:
2895
+ get:
2896
+ operationId: relatietype_list
2897
+ description: Deze lijst kan gefilterd wordt met query-string parameters.
2898
+ summary: Alle relatietypes opvragen.
2899
+ parameters:
2900
+ - in: query
2901
+ name: naam
2902
+ schema:
2903
+ type: string
2904
+ description: Naam van het relatietype
2905
+ - name: page
2906
+ required: false
2907
+ in: query
2908
+ description: Een pagina binnen de gepagineerde set resultaten.
2909
+ schema:
2910
+ type: integer
2911
+ - name: pageSize
2912
+ required: false
2913
+ in: query
2914
+ description: 'Het aantal resultaten terug te geven per pagina. (default: 100).'
2915
+ schema:
2916
+ type: integer
2917
+ tags:
2918
+ - Relatietype
2919
+ security:
2920
+ - tokenAuth: []
2921
+ responses:
2922
+ '200':
2923
+ headers:
2924
+ API-version:
2925
+ schema:
2926
+ type: string
2927
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2928
+ content:
2929
+ application/json:
2930
+ schema:
2931
+ $ref: '#/components/schemas/PaginatedRelatieTypeList'
2932
+ application/problem+json:
2933
+ schema:
2934
+ $ref: '#/components/schemas/PaginatedRelatieTypeList'
2935
+ description: ''
2936
+ post:
2937
+ operationId: relatietype_create
2938
+ description: Voeg een nieuw relatietype toe aan het systeem.
2939
+ summary: Nieuw relatietype aanmaken.
2940
+ tags:
2941
+ - Relatietype
2942
+ requestBody:
2943
+ content:
2944
+ application/json:
2945
+ schema:
2946
+ $ref: '#/components/schemas/RelatieType'
2947
+ required: true
2948
+ security:
2949
+ - tokenAuth: []
2950
+ responses:
2951
+ '201':
2952
+ headers:
2953
+ API-version:
2954
+ schema:
2955
+ type: string
2956
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2957
+ content:
2958
+ application/json:
2959
+ schema:
2960
+ $ref: '#/components/schemas/RelatieType'
2961
+ application/problem+json:
2962
+ schema:
2963
+ $ref: '#/components/schemas/RelatieType'
2964
+ description: ''
2965
+ /relatietype/{uuid}:
2966
+ get:
2967
+ operationId: relatietype_retrieve
2968
+ description: Een specifiek relatietype opvragen via UUID.
2969
+ summary: Een specifiek relatietype opvragen.
2970
+ parameters:
2971
+ - in: path
2972
+ name: uuid
2973
+ schema:
2974
+ type: string
2975
+ format: uuid
2976
+ description: Unieke resource identifier (UUID4).
2977
+ required: true
2978
+ tags:
2979
+ - Relatietype
2980
+ security:
2981
+ - tokenAuth: []
2982
+ responses:
2983
+ '200':
2984
+ headers:
2985
+ API-version:
2986
+ schema:
2987
+ type: string
2988
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
2989
+ content:
2990
+ application/json:
2991
+ schema:
2992
+ $ref: '#/components/schemas/RelatieType'
2993
+ application/problem+json:
2994
+ schema:
2995
+ $ref: '#/components/schemas/RelatieType'
2996
+ description: ''
2997
+ put:
2998
+ operationId: relatietype_update
2999
+ description: Werk alle gegevens van een relatietype bij.
3000
+ summary: Relatietype volledig bijwerken.
3001
+ parameters:
3002
+ - in: path
3003
+ name: uuid
3004
+ schema:
3005
+ type: string
3006
+ format: uuid
3007
+ description: Unieke resource identifier (UUID4).
3008
+ required: true
3009
+ tags:
3010
+ - Relatietype
3011
+ requestBody:
3012
+ content:
3013
+ application/json:
3014
+ schema:
3015
+ $ref: '#/components/schemas/RelatieType'
3016
+ required: true
3017
+ security:
3018
+ - tokenAuth: []
3019
+ responses:
3020
+ '200':
3021
+ headers:
3022
+ API-version:
3023
+ schema:
3024
+ type: string
3025
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
3026
+ content:
3027
+ application/json:
3028
+ schema:
3029
+ $ref: '#/components/schemas/RelatieType'
3030
+ application/problem+json:
3031
+ schema:
3032
+ $ref: '#/components/schemas/RelatieType'
3033
+ description: ''
3034
+ patch:
3035
+ operationId: relatietype_partial_update
3036
+ description: Werk enkele gegevens van een relatietype bij.
3037
+ summary: Relatietype gedeeltelijk bijwerken.
3038
+ parameters:
3039
+ - in: path
3040
+ name: uuid
3041
+ schema:
3042
+ type: string
3043
+ format: uuid
3044
+ description: Unieke resource identifier (UUID4).
3045
+ required: true
3046
+ tags:
3047
+ - Relatietype
3048
+ requestBody:
3049
+ content:
3050
+ application/json:
3051
+ schema:
3052
+ $ref: '#/components/schemas/PatchedRelatieType'
3053
+ security:
3054
+ - tokenAuth: []
3055
+ responses:
3056
+ '200':
3057
+ headers:
3058
+ API-version:
3059
+ schema:
3060
+ type: string
3061
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
3062
+ content:
3063
+ application/json:
3064
+ schema:
3065
+ $ref: '#/components/schemas/RelatieType'
3066
+ application/problem+json:
3067
+ schema:
3068
+ $ref: '#/components/schemas/RelatieType'
3069
+ description: ''
3070
+ delete:
3071
+ operationId: relatietype_destroy
3072
+ description: Verwijder een specifiek relatietype.
3073
+ summary: Relatietype verwijderen.
3074
+ parameters:
3075
+ - in: path
3076
+ name: uuid
3077
+ schema:
3078
+ type: string
3079
+ format: uuid
3080
+ description: Unieke resource identifier (UUID4).
3081
+ required: true
3082
+ tags:
3083
+ - Relatietype
3084
+ security:
3085
+ - tokenAuth: []
3086
+ responses:
3087
+ '204':
3088
+ headers:
3089
+ API-version:
3090
+ schema:
3091
+ type: string
3092
+ description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
3093
+ description: No response body
3094
+ components:
3095
+ schemas:
3096
+ BlankEnum:
3097
+ enum:
3098
+ - ''
3099
+ Contactmoment:
3100
+ type: object
3101
+ properties:
3102
+ uuid:
3103
+ type: string
3104
+ format: uuid
3105
+ readOnly: true
3106
+ description: Unieke resource identifier (UUID4).
3107
+ status:
3108
+ allOf:
3109
+ - $ref: '#/components/schemas/StatusEnum'
3110
+ description: |-
3111
+ Status van het contactmoment.
3112
+
3113
+ * `actief` - Actief
3114
+ * `afgerond` - Afgerond
3115
+ * `geannuleerd` - Geannuleerd
3116
+ datum:
3117
+ type: string
3118
+ format: date-time
3119
+ description: Startdatum van het contactmoment.
3120
+ toelichtingStatus:
3121
+ type: string
3122
+ description: Toelichting bij de status van het contactmoment.
3123
+ maxLength: 1000
3124
+ notitie:
3125
+ type: string
3126
+ description: Notitie bij het contactmoment.
3127
+ maxLength: 1000
3128
+ plan:
3129
+ allOf:
3130
+ - $ref: '#/components/schemas/NestedPlan'
3131
+ readOnly: true
3132
+ planUuid:
3133
+ type: string
3134
+ format: uuid
3135
+ writeOnly: true
3136
+ description: UUID van het plan waarbij dit contactmoment hoort.
3137
+ required:
3138
+ - datum
3139
+ - plan
3140
+ - planUuid
3141
+ - uuid
3142
+ Doel:
3143
+ type: object
3144
+ properties:
3145
+ uuid:
3146
+ type: string
3147
+ format: uuid
3148
+ readOnly: true
3149
+ description: Unieke resource identifier (UUID4).
3150
+ plannen:
3151
+ type: array
3152
+ items:
3153
+ $ref: '#/components/schemas/NestedPlan'
3154
+ readOnly: true
3155
+ plannenUuids:
3156
+ type: array
3157
+ items:
3158
+ type: string
3159
+ format: uuid
3160
+ writeOnly: true
3161
+ writeOnly: true
3162
+ description: UUID van de plannen waaraan dit doel gekoppelt is.
3163
+ doeltype:
3164
+ allOf:
3165
+ - $ref: '#/components/schemas/NestedDoelType'
3166
+ readOnly: true
3167
+ doeltypeUuid:
3168
+ type: string
3169
+ format: uuid
3170
+ writeOnly: true
3171
+ description: UUID van de gekoppelde doeltype.
3172
+ persoon:
3173
+ allOf:
3174
+ - $ref: '#/components/schemas/Persoon'
3175
+ readOnly: true
3176
+ persoonUuid:
3177
+ type: string
3178
+ format: uuid
3179
+ writeOnly: true
3180
+ description: UUID van de gekoppelde persoon.
3181
+ status:
3182
+ allOf:
3183
+ - $ref: '#/components/schemas/StatusEnum'
3184
+ description: |-
3185
+ Status van het doel.
3186
+
3187
+ * `actief` - Actief
3188
+ * `afgerond` - Afgerond
3189
+ * `geannuleerd` - Geannuleerd
3190
+ titel:
3191
+ type: string
3192
+ description: Titel van het doel.
3193
+ maxLength: 255
3194
+ beschrijving:
3195
+ type: string
3196
+ description: Beschrijving van het doel.
3197
+ maxLength: 1000
3198
+ startdatum:
3199
+ type: string
3200
+ format: date-time
3201
+ description: Startdatum van het doel.
3202
+ einddatum:
3203
+ type: string
3204
+ format: date-time
3205
+ nullable: true
3206
+ description: Einddatum van het doel.
3207
+ resultaat:
3208
+ description: |-
3209
+ Resultaat van het doel.
3210
+
3211
+ * `behaald` - Behaald
3212
+ * `gefaald` - Gefaald
3213
+ oneOf:
3214
+ - $ref: '#/components/schemas/ResultaatEnum'
3215
+ - $ref: '#/components/schemas/BlankEnum'
3216
+ toelichtingResultaat:
3217
+ type: string
3218
+ description: Toelichting bij het resultaat van het doel.
3219
+ maxLength: 1000
3220
+ hoofdDoel:
3221
+ type: string
3222
+ format: uuid
3223
+ nullable: true
3224
+ description: UUID van de bovenliggende doel (optioneel).
3225
+ required:
3226
+ - doeltype
3227
+ - doeltypeUuid
3228
+ - persoon
3229
+ - persoonUuid
3230
+ - plannen
3231
+ - plannenUuids
3232
+ - startdatum
3233
+ - titel
3234
+ - uuid
3235
+ DoelCategorie:
3236
+ type: object
3237
+ properties:
3238
+ uuid:
3239
+ type: string
3240
+ format: uuid
3241
+ readOnly: true
3242
+ description: Unieke resource identifier (UUID4).
3243
+ naam:
3244
+ type: string
3245
+ description: Naam van de doelcategorie.
3246
+ maxLength: 200
3247
+ required:
3248
+ - naam
3249
+ - uuid
3250
+ DoelType:
3251
+ type: object
3252
+ properties:
3253
+ uuid:
3254
+ type: string
3255
+ format: uuid
3256
+ readOnly: true
3257
+ description: Unieke resource identifier (UUID4).
3258
+ doelType:
3259
+ allOf:
3260
+ - $ref: '#/components/schemas/DoelTypeEnum'
3261
+ description: |-
3262
+ Het type doel.
3263
+
3264
+ * `hoofddoel` - Hoofddoel
3265
+ * `subdoel` - Subdoel
3266
+ categorieen:
3267
+ type: array
3268
+ items:
3269
+ $ref: '#/components/schemas/DoelCategorie'
3270
+ readOnly: true
3271
+ categorieenUuids:
3272
+ type: array
3273
+ items:
3274
+ type: string
3275
+ format: uuid
3276
+ writeOnly: true
3277
+ writeOnly: true
3278
+ description: UUID's van de doelcategorieen waaraan dit doeltype gekoppeld is.
3279
+ required:
3280
+ - categorieen
3281
+ - categorieenUuids
3282
+ - doelType
3283
+ - uuid
3284
+ DoelTypeEnum:
3285
+ enum:
3286
+ - hoofddoel
3287
+ - subdoel
3288
+ type: string
3289
+ description: |-
3290
+ * `hoofddoel` - Hoofddoel
3291
+ * `subdoel` - Subdoel
3292
+ Instrument:
3293
+ type: object
3294
+ properties:
3295
+ uuid:
3296
+ type: string
3297
+ format: uuid
3298
+ readOnly: true
3299
+ description: Unieke resource identifier (UUID4).
3300
+ titel:
3301
+ type: string
3302
+ description: Titel van het instrument.
3303
+ maxLength: 255
3304
+ startdatum:
3305
+ type: string
3306
+ format: date-time
3307
+ description: Startdatum van het instrument.
3308
+ einddatum:
3309
+ type: string
3310
+ format: date-time
3311
+ nullable: true
3312
+ description: Einddatum van het instrument.
3313
+ status:
3314
+ allOf:
3315
+ - $ref: '#/components/schemas/StatusEnum'
3316
+ description: |-
3317
+ Status van het instrument.
3318
+
3319
+ * `actief` - Actief
3320
+ * `afgerond` - Afgerond
3321
+ * `geannuleerd` - Geannuleerd
3322
+ product:
3323
+ type: string
3324
+ example: urn:namespace:component:resource:uuid
3325
+ description: URN naar de bijbehorende product in het productsysteem.
3326
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
3327
+ maxLength: 255
3328
+ zaak:
3329
+ type: string
3330
+ example: urn:namespace:component:resource:uuid
3331
+ description: URN naar het bijbehorende zaak in het zaaksysteem.
3332
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
3333
+ maxLength: 255
3334
+ resultaat:
3335
+ description: |-
3336
+ Resultaat van het instrument.
3337
+
3338
+ * `behaald` - Behaald
3339
+ * `gefaald` - Gefaald
3340
+ oneOf:
3341
+ - $ref: '#/components/schemas/ResultaatEnum'
3342
+ - $ref: '#/components/schemas/BlankEnum'
3343
+ doelen:
3344
+ type: array
3345
+ items:
3346
+ $ref: '#/components/schemas/NestedDoel'
3347
+ readOnly: true
3348
+ doelenUuids:
3349
+ type: array
3350
+ items:
3351
+ type: string
3352
+ format: uuid
3353
+ writeOnly: true
3354
+ writeOnly: true
3355
+ description: UUID's van het doel waaraan dit instrument gekoppeld is.
3356
+ ontwikkelwensen:
3357
+ type: array
3358
+ items:
3359
+ $ref: '#/components/schemas/NestedDoel'
3360
+ readOnly: true
3361
+ ontwikkelwensenUuids:
3362
+ type: array
3363
+ items:
3364
+ type: string
3365
+ format: uuid
3366
+ writeOnly: true
3367
+ writeOnly: true
3368
+ description: UUID's van het ontwikkelwens waaraan dit instrument gekoppeld is.
3369
+ instrumenttype:
3370
+ allOf:
3371
+ - $ref: '#/components/schemas/NestedInstrumentType'
3372
+ readOnly: true
3373
+ instrumenttypeUuid:
3374
+ type: string
3375
+ format: uuid
3376
+ writeOnly: true
3377
+ description: UUID van het type instrument dat hier wordt toegepast.
3378
+ instrumentCategorieen:
3379
+ type: array
3380
+ items:
3381
+ $ref: '#/components/schemas/InstrumentCategorie'
3382
+ readOnly: true
3383
+ required:
3384
+ - doelen
3385
+ - doelenUuids
3386
+ - instrumentCategorieen
3387
+ - instrumenttype
3388
+ - instrumenttypeUuid
3389
+ - ontwikkelwensen
3390
+ - ontwikkelwensenUuids
3391
+ - startdatum
3392
+ - titel
3393
+ - uuid
3394
+ InstrumentCategorie:
3395
+ type: object
3396
+ properties:
3397
+ uuid:
3398
+ type: string
3399
+ format: uuid
3400
+ readOnly: true
3401
+ description: Unieke resource identifier (UUID4).
3402
+ naam:
3403
+ type: string
3404
+ description: Naam van de instrumentcategorie.
3405
+ maxLength: 200
3406
+ required:
3407
+ - naam
3408
+ - uuid
3409
+ InstrumentType:
3410
+ type: object
3411
+ properties:
3412
+ uuid:
3413
+ type: string
3414
+ format: uuid
3415
+ readOnly: true
3416
+ description: Unieke resource identifier (UUID4).
3417
+ instrumentType:
3418
+ allOf:
3419
+ - $ref: '#/components/schemas/InstrumentTypeEnum'
3420
+ description: |-
3421
+ Het type instrument.
3422
+
3423
+ * `training` - Training
3424
+ * `coaching` - Coaching
3425
+ * `financiele_ondersteuning` - Financiele ondersteuning
3426
+ categorieen:
3427
+ type: array
3428
+ items:
3429
+ $ref: '#/components/schemas/InstrumentCategorie'
3430
+ readOnly: true
3431
+ categorieenUuids:
3432
+ type: array
3433
+ items:
3434
+ type: string
3435
+ format: uuid
3436
+ writeOnly: true
3437
+ writeOnly: true
3438
+ description: UUID's van de instrumentcategorieen waaraan dit instrument gekoppeld is.
3439
+ required:
3440
+ - categorieen
3441
+ - categorieenUuids
3442
+ - instrumentType
3443
+ - uuid
3444
+ InstrumentTypeEnum:
3445
+ enum:
3446
+ - training
3447
+ - coaching
3448
+ - financiele_ondersteuning
3449
+ type: string
3450
+ description: |-
3451
+ * `training` - Training
3452
+ * `coaching` - Coaching
3453
+ * `financiele_ondersteuning` - Financiele ondersteuning
3454
+ NestedDoel:
3455
+ type: object
3456
+ properties:
3457
+ uuid:
3458
+ type: string
3459
+ format: uuid
3460
+ readOnly: true
3461
+ description: Unieke resource identifier (UUID4).
3462
+ status:
3463
+ allOf:
3464
+ - $ref: '#/components/schemas/StatusEnum'
3465
+ description: |-
3466
+ Status van het doel.
3467
+
3468
+ * `actief` - Actief
3469
+ * `afgerond` - Afgerond
3470
+ * `geannuleerd` - Geannuleerd
3471
+ titel:
3472
+ type: string
3473
+ description: Titel van het doel.
3474
+ maxLength: 255
3475
+ beschrijving:
3476
+ type: string
3477
+ description: Beschrijving van het doel.
3478
+ maxLength: 1000
3479
+ startdatum:
3480
+ type: string
3481
+ format: date-time
3482
+ description: Startdatum van het doel.
3483
+ einddatum:
3484
+ type: string
3485
+ format: date-time
3486
+ nullable: true
3487
+ description: Einddatum van het doel.
3488
+ resultaat:
3489
+ description: |-
3490
+ Resultaat van het doel.
3491
+
3492
+ * `behaald` - Behaald
3493
+ * `gefaald` - Gefaald
3494
+ oneOf:
3495
+ - $ref: '#/components/schemas/ResultaatEnum'
3496
+ - $ref: '#/components/schemas/BlankEnum'
3497
+ toelichtingResultaat:
3498
+ type: string
3499
+ description: Toelichting bij het resultaat van het doel.
3500
+ maxLength: 1000
3501
+ hoofdDoel:
3502
+ type: string
3503
+ format: uuid
3504
+ nullable: true
3505
+ description: UUID van de bovenliggende doel (optioneel).
3506
+ required:
3507
+ - startdatum
3508
+ - titel
3509
+ - uuid
3510
+ NestedDoelType:
3511
+ type: object
3512
+ properties:
3513
+ uuid:
3514
+ type: string
3515
+ format: uuid
3516
+ readOnly: true
3517
+ description: Unieke resource identifier (UUID4).
3518
+ doelType:
3519
+ allOf:
3520
+ - $ref: '#/components/schemas/DoelTypeEnum'
3521
+ description: |-
3522
+ Het type doel.
3523
+
3524
+ * `hoofddoel` - Hoofddoel
3525
+ * `subdoel` - Subdoel
3526
+ required:
3527
+ - doelType
3528
+ - uuid
3529
+ NestedInstrumentType:
3530
+ type: object
3531
+ properties:
3532
+ uuid:
3533
+ type: string
3534
+ format: uuid
3535
+ readOnly: true
3536
+ description: Unieke resource identifier (UUID4).
3537
+ instrumentType:
3538
+ allOf:
3539
+ - $ref: '#/components/schemas/InstrumentTypeEnum'
3540
+ description: |-
3541
+ Het type instrument.
3542
+
3543
+ * `training` - Training
3544
+ * `coaching` - Coaching
3545
+ * `financiele_ondersteuning` - Financiele ondersteuning
3546
+ required:
3547
+ - instrumentType
3548
+ - uuid
3549
+ NestedPlan:
3550
+ type: object
3551
+ properties:
3552
+ uuid:
3553
+ type: string
3554
+ format: uuid
3555
+ readOnly: true
3556
+ description: Unieke resource identifier (UUID4).
3557
+ status:
3558
+ allOf:
3559
+ - $ref: '#/components/schemas/StatusEnum'
3560
+ description: |-
3561
+ Status van het plan.
3562
+
3563
+ * `actief` - Actief
3564
+ * `afgerond` - Afgerond
3565
+ * `geannuleerd` - Geannuleerd
3566
+ titel:
3567
+ type: string
3568
+ description: Titel van het plan.
3569
+ maxLength: 255
3570
+ notitie:
3571
+ type: string
3572
+ description: Notitie bij het plan.
3573
+ maxLength: 1000
3574
+ startdatum:
3575
+ type: string
3576
+ format: date-time
3577
+ description: Startdatum van het plan.
3578
+ einddatum:
3579
+ type: string
3580
+ format: date-time
3581
+ nullable: true
3582
+ description: Einddatum van het plan.
3583
+ redenEinde:
3584
+ type: string
3585
+ description: Reden waarom het plan is beëindigd.
3586
+ maxLength: 1000
3587
+ zaak:
3588
+ type: string
3589
+ example: urn:namespace:component:resource:uuid
3590
+ description: URN naar de bijbehorende zaak in het zaaksysteem.
3591
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
3592
+ maxLength: 255
3593
+ domeinregister:
3594
+ type: string
3595
+ example: urn:namespace:component:resource:uuid
3596
+ description: URN naar het domeinregister voor dit plan.
3597
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
3598
+ maxLength: 255
3599
+ medewerker:
3600
+ type: string
3601
+ example: urn:namespace:component:resource:uuid
3602
+ description: URN naar de medewerker in het HR-systeem.
3603
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
3604
+ maxLength: 255
3605
+ required:
3606
+ - startdatum
3607
+ - titel
3608
+ - uuid
3609
+ Ontwikkelwens:
3610
+ type: object
3611
+ properties:
3612
+ uuid:
3613
+ type: string
3614
+ format: uuid
3615
+ readOnly: true
3616
+ description: Unieke resource identifier (UUID4).
3617
+ titel:
3618
+ type: string
3619
+ description: Titel van het ontwikkelwens.
3620
+ maxLength: 255
3621
+ beschrijving:
3622
+ type: string
3623
+ description: Beschrijving van het ontwikkelwens.
3624
+ maxLength: 1000
3625
+ status:
3626
+ allOf:
3627
+ - $ref: '#/components/schemas/StatusEnum'
3628
+ description: |-
3629
+ Status van het ontwikkelwens.
3630
+
3631
+ * `actief` - Actief
3632
+ * `afgerond` - Afgerond
3633
+ * `geannuleerd` - Geannuleerd
3634
+ startdatum:
3635
+ type: string
3636
+ format: date-time
3637
+ description: Startdatum van het ontwikkelwens.
3638
+ einddatum:
3639
+ type: string
3640
+ format: date-time
3641
+ nullable: true
3642
+ description: Einddatum van het ontwikkelwens.
3643
+ resultaat:
3644
+ description: |-
3645
+ Resultaat van het ontwikkelwens.
3646
+
3647
+ * `behaald` - Behaald
3648
+ * `gefaald` - Gefaald
3649
+ oneOf:
3650
+ - $ref: '#/components/schemas/ResultaatEnum'
3651
+ - $ref: '#/components/schemas/BlankEnum'
3652
+ doel:
3653
+ allOf:
3654
+ - $ref: '#/components/schemas/NestedDoel'
3655
+ readOnly: true
3656
+ doelUuid:
3657
+ type: string
3658
+ format: uuid
3659
+ writeOnly: true
3660
+ description: UUID van het doel waaraan deze ontwikkelwens gekoppeld is.
3661
+ doelCategorieen:
3662
+ type: array
3663
+ items:
3664
+ $ref: '#/components/schemas/DoelCategorie'
3665
+ readOnly: true
3666
+ doelCategorieenUuids:
3667
+ type: array
3668
+ items:
3669
+ type: string
3670
+ format: uuid
3671
+ writeOnly: true
3672
+ writeOnly: true
3673
+ description: UUIDs van de doelcategorieën waaraan deze ontwikkelwens gekoppeld is.
3674
+ required:
3675
+ - doel
3676
+ - doelCategorieen
3677
+ - doelCategorieenUuids
3678
+ - doelUuid
3679
+ - startdatum
3680
+ - titel
3681
+ - uuid
3682
+ OverkoepelendPlan:
3683
+ type: object
3684
+ properties:
3685
+ urn:
3686
+ type: string
3687
+ example: urn:namespace:component:resource:uuid
3688
+ readOnly: true
3689
+ uuid:
3690
+ type: string
3691
+ format: uuid
3692
+ readOnly: true
3693
+ description: Unieke resource identifier (UUID4).
3694
+ titel:
3695
+ type: string
3696
+ description: Titel van het overkoepelende plan.
3697
+ maxLength: 255
3698
+ status:
3699
+ allOf:
3700
+ - $ref: '#/components/schemas/StatusEnum'
3701
+ description: |-
3702
+ Status van het overkoepelende plan.
3703
+
3704
+ * `actief` - Actief
3705
+ * `afgerond` - Afgerond
3706
+ * `geannuleerd` - Geannuleerd
3707
+ medewerker:
3708
+ type: string
3709
+ example: urn:namespace:component:resource:uuid
3710
+ description: URN naar de medewerker in het HR-systeem.
3711
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
3712
+ maxLength: 255
3713
+ required:
3714
+ - titel
3715
+ - urn
3716
+ - uuid
3717
+ PaginatedContactmomentList:
3718
+ type: object
3719
+ required:
3720
+ - count
3721
+ - results
3722
+ properties:
3723
+ count:
3724
+ type: integer
3725
+ example: 123
3726
+ next:
3727
+ type: string
3728
+ nullable: true
3729
+ format: uri
3730
+ example: http://api.example.org/accounts/?page=4
3731
+ previous:
3732
+ type: string
3733
+ nullable: true
3734
+ format: uri
3735
+ example: http://api.example.org/accounts/?page=2
3736
+ results:
3737
+ type: array
3738
+ items:
3739
+ $ref: '#/components/schemas/Contactmoment'
3740
+ PaginatedDoelCategorieList:
3741
+ type: object
3742
+ required:
3743
+ - count
3744
+ - results
3745
+ properties:
3746
+ count:
3747
+ type: integer
3748
+ example: 123
3749
+ next:
3750
+ type: string
3751
+ nullable: true
3752
+ format: uri
3753
+ example: http://api.example.org/accounts/?page=4
3754
+ previous:
3755
+ type: string
3756
+ nullable: true
3757
+ format: uri
3758
+ example: http://api.example.org/accounts/?page=2
3759
+ results:
3760
+ type: array
3761
+ items:
3762
+ $ref: '#/components/schemas/DoelCategorie'
3763
+ PaginatedDoelList:
3764
+ type: object
3765
+ required:
3766
+ - count
3767
+ - results
3768
+ properties:
3769
+ count:
3770
+ type: integer
3771
+ example: 123
3772
+ next:
3773
+ type: string
3774
+ nullable: true
3775
+ format: uri
3776
+ example: http://api.example.org/accounts/?page=4
3777
+ previous:
3778
+ type: string
3779
+ nullable: true
3780
+ format: uri
3781
+ example: http://api.example.org/accounts/?page=2
3782
+ results:
3783
+ type: array
3784
+ items:
3785
+ $ref: '#/components/schemas/Doel'
3786
+ PaginatedDoelTypeList:
3787
+ type: object
3788
+ required:
3789
+ - count
3790
+ - results
3791
+ properties:
3792
+ count:
3793
+ type: integer
3794
+ example: 123
3795
+ next:
3796
+ type: string
3797
+ nullable: true
3798
+ format: uri
3799
+ example: http://api.example.org/accounts/?page=4
3800
+ previous:
3801
+ type: string
3802
+ nullable: true
3803
+ format: uri
3804
+ example: http://api.example.org/accounts/?page=2
3805
+ results:
3806
+ type: array
3807
+ items:
3808
+ $ref: '#/components/schemas/DoelType'
3809
+ PaginatedInstrumentList:
3810
+ type: object
3811
+ required:
3812
+ - count
3813
+ - results
3814
+ properties:
3815
+ count:
3816
+ type: integer
3817
+ example: 123
3818
+ next:
3819
+ type: string
3820
+ nullable: true
3821
+ format: uri
3822
+ example: http://api.example.org/accounts/?page=4
3823
+ previous:
3824
+ type: string
3825
+ nullable: true
3826
+ format: uri
3827
+ example: http://api.example.org/accounts/?page=2
3828
+ results:
3829
+ type: array
3830
+ items:
3831
+ $ref: '#/components/schemas/Instrument'
3832
+ PaginatedInstrumentTypeList:
3833
+ type: object
3834
+ required:
3835
+ - count
3836
+ - results
3837
+ properties:
3838
+ count:
3839
+ type: integer
3840
+ example: 123
3841
+ next:
3842
+ type: string
3843
+ nullable: true
3844
+ format: uri
3845
+ example: http://api.example.org/accounts/?page=4
3846
+ previous:
3847
+ type: string
3848
+ nullable: true
3849
+ format: uri
3850
+ example: http://api.example.org/accounts/?page=2
3851
+ results:
3852
+ type: array
3853
+ items:
3854
+ $ref: '#/components/schemas/InstrumentType'
3855
+ PaginatedOntwikkelwensList:
3856
+ type: object
3857
+ required:
3858
+ - count
3859
+ - results
3860
+ properties:
3861
+ count:
3862
+ type: integer
3863
+ example: 123
3864
+ next:
3865
+ type: string
3866
+ nullable: true
3867
+ format: uri
3868
+ example: http://api.example.org/accounts/?page=4
3869
+ previous:
3870
+ type: string
3871
+ nullable: true
3872
+ format: uri
3873
+ example: http://api.example.org/accounts/?page=2
3874
+ results:
3875
+ type: array
3876
+ items:
3877
+ $ref: '#/components/schemas/Ontwikkelwens'
3878
+ PaginatedOverkoepelendPlanList:
3879
+ type: object
3880
+ required:
3881
+ - count
3882
+ - results
3883
+ properties:
3884
+ count:
3885
+ type: integer
3886
+ example: 123
3887
+ next:
3888
+ type: string
3889
+ nullable: true
3890
+ format: uri
3891
+ example: http://api.example.org/accounts/?page=4
3892
+ previous:
3893
+ type: string
3894
+ nullable: true
3895
+ format: uri
3896
+ example: http://api.example.org/accounts/?page=2
3897
+ results:
3898
+ type: array
3899
+ items:
3900
+ $ref: '#/components/schemas/OverkoepelendPlan'
3901
+ PaginatedPersoonList:
3902
+ type: object
3903
+ required:
3904
+ - count
3905
+ - results
3906
+ properties:
3907
+ count:
3908
+ type: integer
3909
+ example: 123
3910
+ next:
3911
+ type: string
3912
+ nullable: true
3913
+ format: uri
3914
+ example: http://api.example.org/accounts/?page=4
3915
+ previous:
3916
+ type: string
3917
+ nullable: true
3918
+ format: uri
3919
+ example: http://api.example.org/accounts/?page=2
3920
+ results:
3921
+ type: array
3922
+ items:
3923
+ $ref: '#/components/schemas/Persoon'
3924
+ PaginatedPlanList:
3925
+ type: object
3926
+ required:
3927
+ - count
3928
+ - results
3929
+ properties:
3930
+ count:
3931
+ type: integer
3932
+ example: 123
3933
+ next:
3934
+ type: string
3935
+ nullable: true
3936
+ format: uri
3937
+ example: http://api.example.org/accounts/?page=4
3938
+ previous:
3939
+ type: string
3940
+ nullable: true
3941
+ format: uri
3942
+ example: http://api.example.org/accounts/?page=2
3943
+ results:
3944
+ type: array
3945
+ items:
3946
+ $ref: '#/components/schemas/Plan'
3947
+ PaginatedPlanTypeList:
3948
+ type: object
3949
+ required:
3950
+ - count
3951
+ - results
3952
+ properties:
3953
+ count:
3954
+ type: integer
3955
+ example: 123
3956
+ next:
3957
+ type: string
3958
+ nullable: true
3959
+ format: uri
3960
+ example: http://api.example.org/accounts/?page=4
3961
+ previous:
3962
+ type: string
3963
+ nullable: true
3964
+ format: uri
3965
+ example: http://api.example.org/accounts/?page=2
3966
+ results:
3967
+ type: array
3968
+ items:
3969
+ $ref: '#/components/schemas/PlanType'
3970
+ PaginatedRelatieList:
3971
+ type: object
3972
+ required:
3973
+ - count
3974
+ - results
3975
+ properties:
3976
+ count:
3977
+ type: integer
3978
+ example: 123
3979
+ next:
3980
+ type: string
3981
+ nullable: true
3982
+ format: uri
3983
+ example: http://api.example.org/accounts/?page=4
3984
+ previous:
3985
+ type: string
3986
+ nullable: true
3987
+ format: uri
3988
+ example: http://api.example.org/accounts/?page=2
3989
+ results:
3990
+ type: array
3991
+ items:
3992
+ $ref: '#/components/schemas/Relatie'
3993
+ PaginatedRelatieTypeList:
3994
+ type: object
3995
+ required:
3996
+ - count
3997
+ - results
3998
+ properties:
3999
+ count:
4000
+ type: integer
4001
+ example: 123
4002
+ next:
4003
+ type: string
4004
+ nullable: true
4005
+ format: uri
4006
+ example: http://api.example.org/accounts/?page=4
4007
+ previous:
4008
+ type: string
4009
+ nullable: true
4010
+ format: uri
4011
+ example: http://api.example.org/accounts/?page=2
4012
+ results:
4013
+ type: array
4014
+ items:
4015
+ $ref: '#/components/schemas/RelatieType'
4016
+ PatchedContactmoment:
4017
+ type: object
4018
+ properties:
4019
+ uuid:
4020
+ type: string
4021
+ format: uuid
4022
+ readOnly: true
4023
+ description: Unieke resource identifier (UUID4).
4024
+ status:
4025
+ allOf:
4026
+ - $ref: '#/components/schemas/StatusEnum'
4027
+ description: |-
4028
+ Status van het contactmoment.
4029
+
4030
+ * `actief` - Actief
4031
+ * `afgerond` - Afgerond
4032
+ * `geannuleerd` - Geannuleerd
4033
+ datum:
4034
+ type: string
4035
+ format: date-time
4036
+ description: Startdatum van het contactmoment.
4037
+ toelichtingStatus:
4038
+ type: string
4039
+ description: Toelichting bij de status van het contactmoment.
4040
+ maxLength: 1000
4041
+ notitie:
4042
+ type: string
4043
+ description: Notitie bij het contactmoment.
4044
+ maxLength: 1000
4045
+ plan:
4046
+ allOf:
4047
+ - $ref: '#/components/schemas/NestedPlan'
4048
+ readOnly: true
4049
+ planUuid:
4050
+ type: string
4051
+ format: uuid
4052
+ writeOnly: true
4053
+ description: UUID van het plan waarbij dit contactmoment hoort.
4054
+ PatchedDoel:
4055
+ type: object
4056
+ properties:
4057
+ uuid:
4058
+ type: string
4059
+ format: uuid
4060
+ readOnly: true
4061
+ description: Unieke resource identifier (UUID4).
4062
+ plannen:
4063
+ type: array
4064
+ items:
4065
+ $ref: '#/components/schemas/NestedPlan'
4066
+ readOnly: true
4067
+ plannenUuids:
4068
+ type: array
4069
+ items:
4070
+ type: string
4071
+ format: uuid
4072
+ writeOnly: true
4073
+ writeOnly: true
4074
+ description: UUID van de plannen waaraan dit doel gekoppelt is.
4075
+ doeltype:
4076
+ allOf:
4077
+ - $ref: '#/components/schemas/NestedDoelType'
4078
+ readOnly: true
4079
+ doeltypeUuid:
4080
+ type: string
4081
+ format: uuid
4082
+ writeOnly: true
4083
+ description: UUID van de gekoppelde doeltype.
4084
+ persoon:
4085
+ allOf:
4086
+ - $ref: '#/components/schemas/Persoon'
4087
+ readOnly: true
4088
+ persoonUuid:
4089
+ type: string
4090
+ format: uuid
4091
+ writeOnly: true
4092
+ description: UUID van de gekoppelde persoon.
4093
+ status:
4094
+ allOf:
4095
+ - $ref: '#/components/schemas/StatusEnum'
4096
+ description: |-
4097
+ Status van het doel.
4098
+
4099
+ * `actief` - Actief
4100
+ * `afgerond` - Afgerond
4101
+ * `geannuleerd` - Geannuleerd
4102
+ titel:
4103
+ type: string
4104
+ description: Titel van het doel.
4105
+ maxLength: 255
4106
+ beschrijving:
4107
+ type: string
4108
+ description: Beschrijving van het doel.
4109
+ maxLength: 1000
4110
+ startdatum:
4111
+ type: string
4112
+ format: date-time
4113
+ description: Startdatum van het doel.
4114
+ einddatum:
4115
+ type: string
4116
+ format: date-time
4117
+ nullable: true
4118
+ description: Einddatum van het doel.
4119
+ resultaat:
4120
+ description: |-
4121
+ Resultaat van het doel.
4122
+
4123
+ * `behaald` - Behaald
4124
+ * `gefaald` - Gefaald
4125
+ oneOf:
4126
+ - $ref: '#/components/schemas/ResultaatEnum'
4127
+ - $ref: '#/components/schemas/BlankEnum'
4128
+ toelichtingResultaat:
4129
+ type: string
4130
+ description: Toelichting bij het resultaat van het doel.
4131
+ maxLength: 1000
4132
+ hoofdDoel:
4133
+ type: string
4134
+ format: uuid
4135
+ nullable: true
4136
+ description: UUID van de bovenliggende doel (optioneel).
4137
+ PatchedDoelCategorie:
4138
+ type: object
4139
+ properties:
4140
+ uuid:
4141
+ type: string
4142
+ format: uuid
4143
+ readOnly: true
4144
+ description: Unieke resource identifier (UUID4).
4145
+ naam:
4146
+ type: string
4147
+ description: Naam van de doelcategorie.
4148
+ maxLength: 200
4149
+ PatchedDoelType:
4150
+ type: object
4151
+ properties:
4152
+ uuid:
4153
+ type: string
4154
+ format: uuid
4155
+ readOnly: true
4156
+ description: Unieke resource identifier (UUID4).
4157
+ doelType:
4158
+ allOf:
4159
+ - $ref: '#/components/schemas/DoelTypeEnum'
4160
+ description: |-
4161
+ Het type doel.
4162
+
4163
+ * `hoofddoel` - Hoofddoel
4164
+ * `subdoel` - Subdoel
4165
+ categorieen:
4166
+ type: array
4167
+ items:
4168
+ $ref: '#/components/schemas/DoelCategorie'
4169
+ readOnly: true
4170
+ categorieenUuids:
4171
+ type: array
4172
+ items:
4173
+ type: string
4174
+ format: uuid
4175
+ writeOnly: true
4176
+ writeOnly: true
4177
+ description: UUID's van de doelcategorieen waaraan dit doeltype gekoppeld is.
4178
+ PatchedInstrument:
4179
+ type: object
4180
+ properties:
4181
+ uuid:
4182
+ type: string
4183
+ format: uuid
4184
+ readOnly: true
4185
+ description: Unieke resource identifier (UUID4).
4186
+ titel:
4187
+ type: string
4188
+ description: Titel van het instrument.
4189
+ maxLength: 255
4190
+ startdatum:
4191
+ type: string
4192
+ format: date-time
4193
+ description: Startdatum van het instrument.
4194
+ einddatum:
4195
+ type: string
4196
+ format: date-time
4197
+ nullable: true
4198
+ description: Einddatum van het instrument.
4199
+ status:
4200
+ allOf:
4201
+ - $ref: '#/components/schemas/StatusEnum'
4202
+ description: |-
4203
+ Status van het instrument.
4204
+
4205
+ * `actief` - Actief
4206
+ * `afgerond` - Afgerond
4207
+ * `geannuleerd` - Geannuleerd
4208
+ product:
4209
+ type: string
4210
+ example: urn:namespace:component:resource:uuid
4211
+ description: URN naar de bijbehorende product in het productsysteem.
4212
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4213
+ maxLength: 255
4214
+ zaak:
4215
+ type: string
4216
+ example: urn:namespace:component:resource:uuid
4217
+ description: URN naar het bijbehorende zaak in het zaaksysteem.
4218
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4219
+ maxLength: 255
4220
+ resultaat:
4221
+ description: |-
4222
+ Resultaat van het instrument.
4223
+
4224
+ * `behaald` - Behaald
4225
+ * `gefaald` - Gefaald
4226
+ oneOf:
4227
+ - $ref: '#/components/schemas/ResultaatEnum'
4228
+ - $ref: '#/components/schemas/BlankEnum'
4229
+ doelen:
4230
+ type: array
4231
+ items:
4232
+ $ref: '#/components/schemas/NestedDoel'
4233
+ readOnly: true
4234
+ doelenUuids:
4235
+ type: array
4236
+ items:
4237
+ type: string
4238
+ format: uuid
4239
+ writeOnly: true
4240
+ writeOnly: true
4241
+ description: UUID's van het doel waaraan dit instrument gekoppeld is.
4242
+ ontwikkelwensen:
4243
+ type: array
4244
+ items:
4245
+ $ref: '#/components/schemas/NestedDoel'
4246
+ readOnly: true
4247
+ ontwikkelwensenUuids:
4248
+ type: array
4249
+ items:
4250
+ type: string
4251
+ format: uuid
4252
+ writeOnly: true
4253
+ writeOnly: true
4254
+ description: UUID's van het ontwikkelwens waaraan dit instrument gekoppeld is.
4255
+ instrumenttype:
4256
+ allOf:
4257
+ - $ref: '#/components/schemas/NestedInstrumentType'
4258
+ readOnly: true
4259
+ instrumenttypeUuid:
4260
+ type: string
4261
+ format: uuid
4262
+ writeOnly: true
4263
+ description: UUID van het type instrument dat hier wordt toegepast.
4264
+ instrumentCategorieen:
4265
+ type: array
4266
+ items:
4267
+ $ref: '#/components/schemas/InstrumentCategorie'
4268
+ readOnly: true
4269
+ PatchedInstrumentType:
4270
+ type: object
4271
+ properties:
4272
+ uuid:
4273
+ type: string
4274
+ format: uuid
4275
+ readOnly: true
4276
+ description: Unieke resource identifier (UUID4).
4277
+ instrumentType:
4278
+ allOf:
4279
+ - $ref: '#/components/schemas/InstrumentTypeEnum'
4280
+ description: |-
4281
+ Het type instrument.
4282
+
4283
+ * `training` - Training
4284
+ * `coaching` - Coaching
4285
+ * `financiele_ondersteuning` - Financiele ondersteuning
4286
+ categorieen:
4287
+ type: array
4288
+ items:
4289
+ $ref: '#/components/schemas/InstrumentCategorie'
4290
+ readOnly: true
4291
+ categorieenUuids:
4292
+ type: array
4293
+ items:
4294
+ type: string
4295
+ format: uuid
4296
+ writeOnly: true
4297
+ writeOnly: true
4298
+ description: UUID's van de instrumentcategorieen waaraan dit instrument gekoppeld is.
4299
+ PatchedOntwikkelwens:
4300
+ type: object
4301
+ properties:
4302
+ uuid:
4303
+ type: string
4304
+ format: uuid
4305
+ readOnly: true
4306
+ description: Unieke resource identifier (UUID4).
4307
+ titel:
4308
+ type: string
4309
+ description: Titel van het ontwikkelwens.
4310
+ maxLength: 255
4311
+ beschrijving:
4312
+ type: string
4313
+ description: Beschrijving van het ontwikkelwens.
4314
+ maxLength: 1000
4315
+ status:
4316
+ allOf:
4317
+ - $ref: '#/components/schemas/StatusEnum'
4318
+ description: |-
4319
+ Status van het ontwikkelwens.
4320
+
4321
+ * `actief` - Actief
4322
+ * `afgerond` - Afgerond
4323
+ * `geannuleerd` - Geannuleerd
4324
+ startdatum:
4325
+ type: string
4326
+ format: date-time
4327
+ description: Startdatum van het ontwikkelwens.
4328
+ einddatum:
4329
+ type: string
4330
+ format: date-time
4331
+ nullable: true
4332
+ description: Einddatum van het ontwikkelwens.
4333
+ resultaat:
4334
+ description: |-
4335
+ Resultaat van het ontwikkelwens.
4336
+
4337
+ * `behaald` - Behaald
4338
+ * `gefaald` - Gefaald
4339
+ oneOf:
4340
+ - $ref: '#/components/schemas/ResultaatEnum'
4341
+ - $ref: '#/components/schemas/BlankEnum'
4342
+ doel:
4343
+ allOf:
4344
+ - $ref: '#/components/schemas/NestedDoel'
4345
+ readOnly: true
4346
+ doelUuid:
4347
+ type: string
4348
+ format: uuid
4349
+ writeOnly: true
4350
+ description: UUID van het doel waaraan deze ontwikkelwens gekoppeld is.
4351
+ doelCategorieen:
4352
+ type: array
4353
+ items:
4354
+ $ref: '#/components/schemas/DoelCategorie'
4355
+ readOnly: true
4356
+ doelCategorieenUuids:
4357
+ type: array
4358
+ items:
4359
+ type: string
4360
+ format: uuid
4361
+ writeOnly: true
4362
+ writeOnly: true
4363
+ description: UUIDs van de doelcategorieën waaraan deze ontwikkelwens gekoppeld is.
4364
+ PatchedOverkoepelendPlan:
4365
+ type: object
4366
+ properties:
4367
+ urn:
4368
+ type: string
4369
+ example: urn:namespace:component:resource:uuid
4370
+ readOnly: true
4371
+ uuid:
4372
+ type: string
4373
+ format: uuid
4374
+ readOnly: true
4375
+ description: Unieke resource identifier (UUID4).
4376
+ titel:
4377
+ type: string
4378
+ description: Titel van het overkoepelende plan.
4379
+ maxLength: 255
4380
+ status:
4381
+ allOf:
4382
+ - $ref: '#/components/schemas/StatusEnum'
4383
+ description: |-
4384
+ Status van het overkoepelende plan.
4385
+
4386
+ * `actief` - Actief
4387
+ * `afgerond` - Afgerond
4388
+ * `geannuleerd` - Geannuleerd
4389
+ medewerker:
4390
+ type: string
4391
+ example: urn:namespace:component:resource:uuid
4392
+ description: URN naar de medewerker in het HR-systeem.
4393
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4394
+ maxLength: 255
4395
+ PatchedPersoon:
4396
+ type: object
4397
+ properties:
4398
+ uuid:
4399
+ type: string
4400
+ format: uuid
4401
+ readOnly: true
4402
+ description: Unieke resource identifier (UUID4).
4403
+ persoonsprofiel:
4404
+ type: string
4405
+ example: urn:namespace:component:resource:uuid
4406
+ description: URN naar het persoonsprofiel (alleen voor primaire personen verplicht).
4407
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4408
+ maxLength: 255
4409
+ klant:
4410
+ type: string
4411
+ example: urn:namespace:component:resource:uuid
4412
+ description: URN naar de Klant (verplicht voor primaire personen, optioneel voor secundaire).
4413
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4414
+ maxLength: 255
4415
+ bsn:
4416
+ type: string
4417
+ description: BSN voor BRP-koppeling (verplicht voor primaire personen, optioneel voor secundaire).
4418
+ maxLength: 9
4419
+ minLength: 9
4420
+ PatchedPlan:
4421
+ type: object
4422
+ properties:
4423
+ urn:
4424
+ type: string
4425
+ example: urn:namespace:component:resource:uuid
4426
+ readOnly: true
4427
+ description: De Uniform Resource Name van de plan.
4428
+ uuid:
4429
+ type: string
4430
+ format: uuid
4431
+ readOnly: true
4432
+ description: Unieke resource identifier (UUID4).
4433
+ status:
4434
+ allOf:
4435
+ - $ref: '#/components/schemas/StatusEnum'
4436
+ description: |-
4437
+ Status van het plan.
4438
+
4439
+ * `actief` - Actief
4440
+ * `afgerond` - Afgerond
4441
+ * `geannuleerd` - Geannuleerd
4442
+ titel:
4443
+ type: string
4444
+ description: Titel van het plan.
4445
+ maxLength: 255
4446
+ notitie:
4447
+ type: string
4448
+ description: Notitie bij het plan.
4449
+ maxLength: 1000
4450
+ startdatum:
4451
+ type: string
4452
+ format: date-time
4453
+ description: Startdatum van het plan.
4454
+ einddatum:
4455
+ type: string
4456
+ format: date-time
4457
+ nullable: true
4458
+ description: Einddatum van het plan.
4459
+ redenEinde:
4460
+ type: string
4461
+ description: Reden waarom het plan is beëindigd.
4462
+ maxLength: 1000
4463
+ plantype:
4464
+ allOf:
4465
+ - $ref: '#/components/schemas/PlanType'
4466
+ readOnly: true
4467
+ plantypeUuid:
4468
+ type: string
4469
+ format: uuid
4470
+ writeOnly: true
4471
+ description: UUID van de gekoppelde plantype.
4472
+ overkoepelendPlan:
4473
+ allOf:
4474
+ - $ref: '#/components/schemas/OverkoepelendPlan'
4475
+ readOnly: true
4476
+ overkoepelendPlanUuid:
4477
+ type: string
4478
+ format: uuid
4479
+ writeOnly: true
4480
+ description: UUID van het overkoepelend plan.
4481
+ zaak:
4482
+ type: string
4483
+ example: urn:namespace:component:resource:uuid
4484
+ description: URN naar de bijbehorende zaak in het zaaksysteem.
4485
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4486
+ maxLength: 255
4487
+ domeinregister:
4488
+ type: string
4489
+ example: urn:namespace:component:resource:uuid
4490
+ description: URN naar het domeinregister voor dit plan.
4491
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4492
+ maxLength: 255
4493
+ medewerker:
4494
+ type: string
4495
+ example: urn:namespace:component:resource:uuid
4496
+ description: URN naar de medewerker in het HR-systeem.
4497
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4498
+ maxLength: 255
4499
+ PatchedPlanType:
4500
+ type: object
4501
+ properties:
4502
+ uuid:
4503
+ type: string
4504
+ format: uuid
4505
+ readOnly: true
4506
+ description: Unieke resource identifier (UUID4).
4507
+ type:
4508
+ allOf:
4509
+ - $ref: '#/components/schemas/TypeEnum'
4510
+ description: |-
4511
+ Het type plan.
4512
+
4513
+ * `pip` - Persoonlijk plan inburgering en perticipatie
4514
+ * `werk` - Werk
4515
+ * `inkomen` - Inkomen
4516
+ PatchedRelatie:
4517
+ type: object
4518
+ properties:
4519
+ uuid:
4520
+ type: string
4521
+ format: uuid
4522
+ readOnly: true
4523
+ description: Unieke resource identifier (UUID4).
4524
+ persoon:
4525
+ allOf:
4526
+ - $ref: '#/components/schemas/Persoon'
4527
+ readOnly: true
4528
+ persoonUuid:
4529
+ type: string
4530
+ format: uuid
4531
+ writeOnly: true
4532
+ description: UUID van de primaire persoon.
4533
+ gerelateerdePersoon:
4534
+ allOf:
4535
+ - $ref: '#/components/schemas/Persoon'
4536
+ readOnly: true
4537
+ gerelateerdePersoonUuid:
4538
+ type: string
4539
+ format: uuid
4540
+ writeOnly: true
4541
+ description: UUID van de gerelateerde persoon.
4542
+ relatietype:
4543
+ allOf:
4544
+ - $ref: '#/components/schemas/RelatieType'
4545
+ readOnly: true
4546
+ relatietypeUuid:
4547
+ type: string
4548
+ format: uuid
4549
+ writeOnly: true
4550
+ description: UUID van het relatietype.
4551
+ PatchedRelatieType:
4552
+ type: object
4553
+ properties:
4554
+ uuid:
4555
+ type: string
4556
+ format: uuid
4557
+ readOnly: true
4558
+ description: Unieke resource identifier (UUID4).
4559
+ naam:
4560
+ type: string
4561
+ description: Naam van het relatietype
4562
+ maxLength: 100
4563
+ Persoon:
4564
+ type: object
4565
+ properties:
4566
+ uuid:
4567
+ type: string
4568
+ format: uuid
4569
+ readOnly: true
4570
+ description: Unieke resource identifier (UUID4).
4571
+ persoonsprofiel:
4572
+ type: string
4573
+ example: urn:namespace:component:resource:uuid
4574
+ description: URN naar het persoonsprofiel (alleen voor primaire personen verplicht).
4575
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4576
+ maxLength: 255
4577
+ klant:
4578
+ type: string
4579
+ example: urn:namespace:component:resource:uuid
4580
+ description: URN naar de Klant (verplicht voor primaire personen, optioneel voor secundaire).
4581
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4582
+ maxLength: 255
4583
+ bsn:
4584
+ type: string
4585
+ description: BSN voor BRP-koppeling (verplicht voor primaire personen, optioneel voor secundaire).
4586
+ maxLength: 9
4587
+ minLength: 9
4588
+ required:
4589
+ - uuid
4590
+ Plan:
4591
+ type: object
4592
+ properties:
4593
+ urn:
4594
+ type: string
4595
+ example: urn:namespace:component:resource:uuid
4596
+ readOnly: true
4597
+ description: De Uniform Resource Name van de plan.
4598
+ uuid:
4599
+ type: string
4600
+ format: uuid
4601
+ readOnly: true
4602
+ description: Unieke resource identifier (UUID4).
4603
+ status:
4604
+ allOf:
4605
+ - $ref: '#/components/schemas/StatusEnum'
4606
+ description: |-
4607
+ Status van het plan.
4608
+
4609
+ * `actief` - Actief
4610
+ * `afgerond` - Afgerond
4611
+ * `geannuleerd` - Geannuleerd
4612
+ titel:
4613
+ type: string
4614
+ description: Titel van het plan.
4615
+ maxLength: 255
4616
+ notitie:
4617
+ type: string
4618
+ description: Notitie bij het plan.
4619
+ maxLength: 1000
4620
+ startdatum:
4621
+ type: string
4622
+ format: date-time
4623
+ description: Startdatum van het plan.
4624
+ einddatum:
4625
+ type: string
4626
+ format: date-time
4627
+ nullable: true
4628
+ description: Einddatum van het plan.
4629
+ redenEinde:
4630
+ type: string
4631
+ description: Reden waarom het plan is beëindigd.
4632
+ maxLength: 1000
4633
+ plantype:
4634
+ allOf:
4635
+ - $ref: '#/components/schemas/PlanType'
4636
+ readOnly: true
4637
+ plantypeUuid:
4638
+ type: string
4639
+ format: uuid
4640
+ writeOnly: true
4641
+ description: UUID van de gekoppelde plantype.
4642
+ overkoepelendPlan:
4643
+ allOf:
4644
+ - $ref: '#/components/schemas/OverkoepelendPlan'
4645
+ readOnly: true
4646
+ overkoepelendPlanUuid:
4647
+ type: string
4648
+ format: uuid
4649
+ writeOnly: true
4650
+ description: UUID van het overkoepelend plan.
4651
+ zaak:
4652
+ type: string
4653
+ example: urn:namespace:component:resource:uuid
4654
+ description: URN naar de bijbehorende zaak in het zaaksysteem.
4655
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4656
+ maxLength: 255
4657
+ domeinregister:
4658
+ type: string
4659
+ example: urn:namespace:component:resource:uuid
4660
+ description: URN naar het domeinregister voor dit plan.
4661
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4662
+ maxLength: 255
4663
+ medewerker:
4664
+ type: string
4665
+ example: urn:namespace:component:resource:uuid
4666
+ description: URN naar de medewerker in het HR-systeem.
4667
+ pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
4668
+ maxLength: 255
4669
+ required:
4670
+ - overkoepelendPlan
4671
+ - overkoepelendPlanUuid
4672
+ - plantype
4673
+ - plantypeUuid
4674
+ - startdatum
4675
+ - titel
4676
+ - urn
4677
+ - uuid
4678
+ PlanType:
4679
+ type: object
4680
+ properties:
4681
+ uuid:
4682
+ type: string
4683
+ format: uuid
4684
+ readOnly: true
4685
+ description: Unieke resource identifier (UUID4).
4686
+ type:
4687
+ allOf:
4688
+ - $ref: '#/components/schemas/TypeEnum'
4689
+ description: |-
4690
+ Het type plan.
4691
+
4692
+ * `pip` - Persoonlijk plan inburgering en perticipatie
4693
+ * `werk` - Werk
4694
+ * `inkomen` - Inkomen
4695
+ required:
4696
+ - type
4697
+ - uuid
4698
+ Relatie:
4699
+ type: object
4700
+ properties:
4701
+ uuid:
4702
+ type: string
4703
+ format: uuid
4704
+ readOnly: true
4705
+ description: Unieke resource identifier (UUID4).
4706
+ persoon:
4707
+ allOf:
4708
+ - $ref: '#/components/schemas/Persoon'
4709
+ readOnly: true
4710
+ persoonUuid:
4711
+ type: string
4712
+ format: uuid
4713
+ writeOnly: true
4714
+ description: UUID van de primaire persoon.
4715
+ gerelateerdePersoon:
4716
+ allOf:
4717
+ - $ref: '#/components/schemas/Persoon'
4718
+ readOnly: true
4719
+ gerelateerdePersoonUuid:
4720
+ type: string
4721
+ format: uuid
4722
+ writeOnly: true
4723
+ description: UUID van de gerelateerde persoon.
4724
+ relatietype:
4725
+ allOf:
4726
+ - $ref: '#/components/schemas/RelatieType'
4727
+ readOnly: true
4728
+ relatietypeUuid:
4729
+ type: string
4730
+ format: uuid
4731
+ writeOnly: true
4732
+ description: UUID van het relatietype.
4733
+ required:
4734
+ - gerelateerdePersoon
4735
+ - gerelateerdePersoonUuid
4736
+ - persoon
4737
+ - persoonUuid
4738
+ - relatietype
4739
+ - relatietypeUuid
4740
+ - uuid
4741
+ RelatieType:
4742
+ type: object
4743
+ properties:
4744
+ uuid:
4745
+ type: string
4746
+ format: uuid
4747
+ readOnly: true
4748
+ description: Unieke resource identifier (UUID4).
4749
+ naam:
4750
+ type: string
4751
+ description: Naam van het relatietype
4752
+ maxLength: 100
4753
+ required:
4754
+ - naam
4755
+ - uuid
4756
+ ResultaatEnum:
4757
+ enum:
4758
+ - behaald
4759
+ - gefaald
4760
+ type: string
4761
+ description: |-
4762
+ * `behaald` - Behaald
4763
+ * `gefaald` - Gefaald
4764
+ StatusEnum:
4765
+ enum:
4766
+ - actief
4767
+ - afgerond
4768
+ - geannuleerd
4769
+ type: string
4770
+ description: |-
4771
+ * `actief` - Actief
4772
+ * `afgerond` - Afgerond
4773
+ * `geannuleerd` - Geannuleerd
4774
+ TypeEnum:
4775
+ enum:
4776
+ - pip
4777
+ - werk
4778
+ - inkomen
4779
+ type: string
4780
+ description: |-
4781
+ * `pip` - Persoonlijk plan inburgering en perticipatie
4782
+ * `werk` - Werk
4783
+ * `inkomen` - Inkomen
4784
+ securitySchemes:
4785
+ tokenAuth:
4786
+ type: apiKey
4787
+ in: header
4788
+ name: Authorization
4789
+ description: Token-based authentication with required prefix "Token"
4790
+ servers:
4791
+ - url: /plannen/api/v0