From e2466d2ea57a4309ed590238d0dfff282fa78c55 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 14:09:49 +0100 Subject: [PATCH 01/17] Update --- .../DESIGN/drc/relateren-documenten_copy.json | 5 + .../drc/current_version/image-1.png | Bin 0 -> 21762 bytes .../drc/current_version/image.png | Bin 0 -> 21492 bytes .../drc/current_version/readme.md | 65 + .../drc/current_version/relateren-docs.md | 80 + api-specificatie/ztc/current_version/test.txt | 1 + .../ztc/current_version/test2.txt | 0 .../ztc-api-catalogi-1_3_2_copy.yaml | 15581 ++++++++++++++++ 8 files changed, 15732 insertions(+) create mode 100644 api-specificatie/DESIGN/drc/relateren-documenten_copy.json create mode 100644 api-specificatie/drc/current_version/image-1.png create mode 100644 api-specificatie/drc/current_version/image.png create mode 100644 api-specificatie/drc/current_version/readme.md create mode 100644 api-specificatie/drc/current_version/relateren-docs.md create mode 100644 api-specificatie/ztc/current_version/test.txt create mode 100644 api-specificatie/ztc/current_version/test2.txt create mode 100644 api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml diff --git a/api-specificatie/DESIGN/drc/relateren-documenten_copy.json b/api-specificatie/DESIGN/drc/relateren-documenten_copy.json new file mode 100644 index 000000000..8c441c715 --- /dev/null +++ b/api-specificatie/DESIGN/drc/relateren-documenten_copy.json @@ -0,0 +1,5 @@ +{ + "informatieobject": "", + "relevantAnderInformatieobject": "", + "aardRelatie": "geanonimiseerd" +} \ No newline at end of file diff --git a/api-specificatie/drc/current_version/image-1.png b/api-specificatie/drc/current_version/image-1.png new file mode 100644 index 0000000000000000000000000000000000000000..f5993cf53c42778f765bea0f4eaa8da509c8f617 GIT binary patch literal 21762 zcmeIabyQVt7caU6!2&UmloAkwPNfkgB&9o~TcsO8!63IvN(xfa-5^RxcZbs5Y??b4 zzVG*)GtRyD-*fL6hcO&uyZ2gaKhJz-{N|j$x!=mmisPRrJC8!4@FgW4DxgrOSx~4` zYiDuc9hr*IpC}YHO7fwIlGEqK5m&d5Q_;uAj^6t_Ihq%7%e?6`=&n{;Wk0_2@WKz~ zvvhMBpzQTHnyv$>RQxACKD~u6KW2)oJ5<^At}v zBDzRx*|*NC>2$hg$BQx*zjBfR`uNjiDpzNn0yZoT@-0n@G1yF9FLs(6J{tB|-^JU} zk+R9sN)htdQ*U>VU&!vtzU+N+s5jX4M{jI_`uAzdd5lL zwasI+8fz#no{rt$E$`*9PwQog$l5sb%kD@xVpKa%t!NbUu>a!vE9duiOI)f^3(-RI zH~Z=XjN@qZ^*rG}U$>;D@3MJ#l}Hy0H^Eg(jt8&W92}3f<@@7)1UK4F?aX@x4~?lR zrcX-V7aY>5GOV<&SUDH#|IwYRAQJXjFm%3UYW+R8nuqSX;g9B4&E>qT=VO%fVP^WD zlVQ=-EX7@&zlIr+??UTV5S@Z6Uu*2s;jH3xepG(;t;*-5xo`)XDuJp8Z)_};jt~fbg&fv zW^l?1jz^1%XOCh?TvJ!&k+MvC>mKZZYk5etHs(Xf?M4rK?yt$ow_(2*uirPXRI%Tw z;`DgC=Rf(X{%AG2TI z^^=ad>nQpK4&~mY{1uzV4=>z~F6IZlON;c1AYW6}rH2ob4)ePQx9C#W9jWGG8Yi$T z!$^dL@nfSmT}RGpskI27o1Ul>imLLouMSgwqI}hE;Moe*y%*gq#rhH?{kon9n|W~y zg1oM1%4mT`Jo5})_A!Ry$t75F4~0-X9N=Srs`0DBFWm=Hr*XjV6n>12rCPcPzMIG! zpWxgN*9P%>qj>>f1`?t-+qRl61|Rrb4^b=hh+0?ql<#sFIv*G-zh;~~W!2iM$tPz{NysNuFV>csflV%Qdgdk`~-h zf3KpPz@tmp+3|aOF7$MC56ehVyd9gHoHBB99I@FfaO`8Oc(rhZ+_BkGA#!Yc+rM5L zKW`3|Tho+HHSYl}o!l$#NM;h_mehR3OTYyC)TOU-Yhz)(+FTi_fgF#=0N%@YMw!hm zi0W4{B`!MkxbKB*XV$835zV6gj(4M;_j2krT6y9tLKheel+h{ z$zD^8!9iK-*9))bne27voaNe=xQDo=gfy|0@=e1Z3%*yZB_2_Wc~$@Nr%P%T_!Sv? z*^Wevx^62qCGDKr56<>|U5Zts62U;r9e*~C#^rf}TB4_1#);03Eq{W4YU|5^LlZd( zl)?}FZ}?*b4;312_>1Y+tB;Xi?chuRg`c!G-8>fvi%&?aJ?>#%vLP@VBkN4_j)fH@ zzT@G;Ci-s4@^%fIu`1SOM6ZOLj0yjc^?c4WvDI14H$4sO4Q(-`xy5%EGtT^DZu5eJ zd%3Mtw-nbCKL;!7%gV`hf#sEMN2W8G=o`v3$*0-|?PBDP+#}(@cZ>)bHLI8m<>|mx z(AN>Puk#e{f4geh@TMcAh&>}Yzc!vkwFX4~p$qFAobQYt&1(DjDcrXW^`M^oF(IVcYy}tp|^5D^z1HEDf8l5AfVJ zo7kh@P~I&Iatn2xNn$t*taXk0JsQSeE7@7e^<(8;xrzTdPJ0X1jMUgu5LCbT9nE+i zi68F-9h3Ap{NUu_;Sn#uL0$5ClJdbj+Ut-6hcDvJH7hO%@Y?+QCBJl?Z=S^SY^N46 zfhvzOGIH{sBAc<4!q@tLqbqeBrGU$srKQe2Z0_se@#940ujRodptx9t%p zNx*V$z*l%bG_iDoA^#v?iPvc|{9@zz84<4mqrtALBlRM7amt&2*qseX5yV&#DdG3z8 zk~iH|UT?xE0j7#<{rrIr(dKMJ@rDfz2zO$wI(nHCR%*GT6P3{ke#_yPHX|R0E%ym8 zZB$yAJ<<846`Fg~TyP4QCw)i|$(!s$rAeg0Ra z#-rv%*Y<|X>fEiayVChvFiH;TG%HT0khfs`S0W{xJgZJys9FSZTybbDr*?u9^UBlfx}@j@fP6Uh>eq*LkA}1|lV~%A3evRWdHcb&0&wZr$g;sF zQ`#LTh$&>KBM6>I$9C%-QOZ$`y0eYD)ZpUibvMmCKc}4C^3nrzXjRS#o|Z%>DE!5e zgSz#{8=twN?u76h+dbGBGi+US{i0uPUY@d=8p+ahep%Duj#uU_i2krKjkS%UExT3% zje-CPb`k)h=}viyXgkm!LAlopfwAo`X~nnXYse5W4LCPl^W0JviQOLKa4tuJ>%o5a zT;4BFBOma>Tzobq3R&dWHzntHF5gBVWh2Yj1@iKH_IuyBKe_U1*X^F4SsGc1sxMA` znx%7VVEJl!vE$=XT~-6Y#t52{?A*nU&tv#*=4}1ozFWQyDMrZ1`0clbinf_yK&{Fh zb;sRb-&G)ou6;ol&$&Xga;D<&K$ScHw)|?I`1I)tDvdNgkMAqR{?sF>T_y##$23#K z&dXt>q(%8nT%;b_=&3gEn&RX;pb-WuXEK)Ci>5X%nMG+D^c{(!ncZ)4D=+qN*sib+ z+0~AVoN9aC)}4w@bnIg+bX)S7OPMePST8J`l$3Pm&YezQeDdz$VM|=*J9qCQ@=uZq z6DxV$@!{jg#KgpEIX4t_FaW?il6TZJiB{h_x(=!;THrG4>@^Z7uP@RHMu&iJ<`NK) z5icxH{NdDgb<#D~qj7zEe`_h@VBh2pn7CwTsJ605SoBr}8=7A(xt0P0|2OBgl?8+L zHs)~Rh+zedZ+|zuPY7NF4wKg{e{?;^?rXU+{dD_lT1}l!fD^H@%i!xj@$bJuzMEeA zms-xeZ;j7KE-q1Y{zj4CV9^>)^W9tA*u<@>F}-jD$HEugvC+twn6JO=h46PdD>;hE z$v$zl*m_Vp9~C$ZS<}V(wXQyBbdc;sWYt!3xqWti5q%QHEvI>^b_3|j{8&LxxyB-NK_}%!stleWi$}}uA{HFT7ea2)Kh3ab#dX~J7R^61)5A2i zRH&UE>lf$%)(!$B3tg1|UVUV|`fRB%`iZsr{@;Xe_B0E>LlB)AcmUADrC|5Zyzae= z(qt52@_?fw-B&kGHWVjaACnuXaGSKGLLlmLK>($fP}6NT0nQEvMK3CYf? zulNLIv8K{OuG>mMlmZDOc;_9kgsEkd6+vdk6>mE` z6IOR^!(cYLr{@VlaB zW@hHr*4*#yOSPEkZ{B>2CSp{J`}OPb$crYXJGXAFnu)T4C|{IlO&|Fe7HSE#ANjYI zVk}07w9B1xjGM#tD~VF%lR8HC_V$8*-VLx_(EiBDz#z_H;-Zjd(i|R-bAiaT#v8}j zYrH?lz+>o~qX&M77Kh|xIXP7ol~CPNs^sc(-PDB(7F z)PFECZ}*DFqgLP8LM;b8U*yK*dC8dg+bZX&jAdHnYX)<@Uh@SEUIW!L`_+FrbWqRk zhXyX6|KUMeZmG73+S%!XjBBTS1i$#{t|)fr?7f*eChpU*El67OprsL9WWPGi#O}#s zOdi6oXi#YHR2QV9M*gfYq-3nBWu}}ABlC;r%3@fb_+DmjH zP)VF(=I482tIOqxfqJhlOSgryiC***{rU6fv<2uV9?e{t2%w?+85O<6OGiy&u>CGn zh|6>J@K`49_A}9(7nJ3g8G&-c)(>|FKRdt3?!C5JOeXs(rnE4RGx|PpwmTma(bvt) zySac&FE5obA!5#iSUON8#!X>PU6uAN)XpqCw5CDgU4EvFrd{`QZXTYy+}wNd*nqsL zy#QcT^`X(|Njn{~w*9017_&cOf!9f&xvwmGt*@_p4RQ8bnVPP;W-<9M{jB%%@Xoi1 zojIq`^e67^+qcHO52Rk^-uf(?3^F{_Ic{~V{F0Dx!+pJx!GrXAJV}%9c^9WV7Z2JJ zV_*A)-rWl0(_R|JX3|mIG9@J?p@VpF8!c6~3EZDnJ^@T>>b1$^@A=xHe_?X7q)KCX zr)aZYPUym}2Y6fCZ32Vi3Gu}6msoeN;BNCI%V-z5hwYx;0jOe}=9=;+Vbp(*MC{1} z8{}kU-z^yx6x)k zKF+^$Tsh}{(@zs-sst5*91CSz$eRIhw2=B@;r}iXaQ_H+h>wXj^-EwLlF3C7L%tvP z>1dNd?j_e3qDNArqG!u3xa@FgO*`0c{drO1X3o*w=lV_phkRKtDbVM#-mN=#*ca^W zxYK8N&=y3$at!K8ZeZDoKuB1~DZ6;4aPeyA*|&dE7=04q=0#SY%@2 zyI^4Fca8);)JIWlDkithXTD}hgM=N-Z>}LUjPZ<&vAc~wfFLEU>26U+Y5A(k3Ir=5 z7*D@3Fpfhx-;iJ5ns+}eZf*{3^7UdFVF)J{j|ro3-3jc)=;-c=ODznuIt4$Daet`$ zdH+2;Y;)Mt(%SZn&}RU=0Eb`Wdkus<@wwS)+oKcfw{2+n`N!5=QW;U@ET-~_bUvWW zT}+$*WAY(vD7B8W>vw-L-R)Yx?cw0yP(2kH6?N#VpRWui2bLM*^yl0LmqCgT#==)` z$y|Mg=A*Z_cifO!M0~qK99Cq=yU7EM3S$(rknPPt<);T;4oqaXb{*`-jt`$mEs)3s z9UJZN)G`lc+1ON6&i+=p#=prtY-U&JpDIjMx-rIRH35w|SS|fEi^o&-4F>YL; z8|9!P;NA~}ZubH(**DTfEfyP?YsC`Auu!vq1a~K|N;RodV0BRXM-q1?kt%8srCP2O zlB!=1(I~Y`Re#gX7knvIBCuwj>q6Zv-}7+`bA3fc>v;k=FE>;^rTotOu#~H9(ErNr zwkQqZ%7BnYZ_wGV0M=X%eAf_dU-z z#@V)PLphZ}K#`$Cy&?X*r&X};WLaed+s(PzzbYhp^O2b%tSmmK_UrMI#3+~Pvin|= ziq#iT@NIcW5J^+^3};H?V$T`8Q=@I~xHe$ae-^4|rb%X9UnS9_ZW}GxO~xiBO>=e* z8mQV7qvwnLIl-itgmzwJ;^^ho>4S< zN7Cc93ih>oIC?@zom18!@h6{XiOIT?WDMb&p5lkcF=Xcmu6+xkgUZ#L6b=hK`?c1D z?C&WS&$D}zs4B91^Hx%i3cS79cy(-V23#l^{`fp*4_oXK^&paBLvWKsFCR4K22%_> z9GEs_|3-hMz18e5Wic`z7zHPH1I5Y$$mq;8Y zP1maY?TvOyf7Hm*geY-&3&}2%-tw3?MMMy zfsvwHk!)Ju&(p4s3usEPii!LR6=j1$sT=PwfQDZU4f593nY!Zqw{JJD6nnGzCKwtU z@0IIlXpj|Ji$T-^bk%m`lkp)YhB>Thia0U*#7oALybLW{sT^{%n(IXJkpv>#_D2Vc zA@|XS4k|;npWhm^1THL=Pr0P6%1{Wp+`gN!ymO98vq}cCsw9Z1NXoFj5=+`4xVN=5 zlBTX`O~T(`85Q!&qv&TO)u>!}tTX%z7t>5Z(S$%N*f_kI63b*k&n*6T;yzd<}p+ryK z@9UFsuAV8DjTTG~nELd%Y`^}_=pr6po(v}mmuX_J=S9tZXHx>P>ZB<~TBZPLNp5VJ zveMc1koUwagHQX<;_#h{!#{uF!dCQ(8=#}s?&gTFqf;94^5Y*QgTup9pi4&&Q5)y( z4bmGqCT)}m{+i|ncv`K_U%CD%O9IVp**~thQbUsP`*1Iig0H!+qCku1V}3p-7Z1;V zPx`Za*Yy`92#JV(EjjEjde-{lpEB9K#mK1S>|8=h&Dv^9H`52^nLM>-Y-kv6h0^n+ zRYbQWyj)5`4AHgcfsE6$5UBbnWfw~0SYWFjQ$bSE@%^*Pwbe36cOf#g&|s^WSUAnL zdUnA9q4`B{(<$t})P5onqF&@3%?m7tiVo7zSfW(`>uiUTDRw1~%g&Y{M+k|if$?c((2fok7w)o+}(BV<&4S#{EKR;1AlwlK>YN`Ho&oT4^`Ys zhG~yu?pV^h?BXLS(C}D@_vV6hl6m&Ib5UxBznKqqNp4@55@e^Bt!$uF<#M!@aaqo6 zq2<>Mjnc~j0A#0D7Bp8jvM%3r7UV-9rp`w90${EqidwIGOoc)q^l@gS^wziisEgF}_q7Wx=RcwqfmxFY^m`={C z`fT|<%wcPC9?^VpKs+wMuQ`TeL8i&dio?=944N7L{ka)vKL9rUkrkfUadYCf9cz5+ ze!$qX@Sh?+0vQDPqmV8q>F}s66s~l(j_naCTn}ArFSbdZU4Coe z@#0{&X2WJgs!!hxrpoSgzsL}1mFQ2>Gm*BnNJ}^+e5R?b4YSK~<8PsYt}4!JXeqSz zw>$*ie&N%Xq@e?Q<;oRK({}2fo}Nc#_h-Mu`F(kBBBZ)|x9wrsZIl;^C~F|42y-m5 zG1Jzk?KpC+r|_YW8y3pc5y^0Pqdn{?{39=k1)PO~Dm7sl9ytxvsKVkY_#AHW@o9q1 zZr<*_?R<2GFhv#@E@?+=`vyF$!a;dme4?f{%OPWKYs;}k0-sz$j2?{?drJ$2yVl5r zR)Y1W{^bJHnD^4r(Vf;dY5jcvR39mav2?pVtn})$Xy`DX)@Gogp&94h-QA@Lx*ZIN z^0iiS<)~+A!$_H*jJzm@1h!?5P}vqi9G`0Ky&pYAX` z;N-1rF5i<*AJQA{|M#tb3ftAa%sS-_+5a?=b^p^urbTL^@OQGD%r_3$@VedoaP31| zzEew`DGxU4Qnk&+qfzb?cnQ+F21zTLZmW2j{E78BC_k}{?fVMu?zS}|<#1t){Zc{S z{GdgavWJI9eiRn!?9--Drox8uHy%6xbiF%YUm*TZ<2+ZYruDx&iul`GukQW#^Z#KV z|EbGs7e9O1{0|>OmzYI|?%!HF@qgOsPqMEfdqVY-{og;aU)abf34-IKL)n)RLb$Nn z0jl|4DhND+x0_=>fBvjuMa#jVsJr`1l}-{;i^q>2D?lK1o4a_Wy!gf-KFUjC za&j^yB}Jm8r3Fn_G{odrOCx!QkukqK8ggl%AdG79+`K7q#o;GiiRv+sO%0Jc@fDDS9gXK+SL}nzvG#U7XH9T`?MS7; z%Wr6@7l8g?w;+7Y_=^{7e;#QXYD)mLuoHo83VM=1;?bmKVruyoizvqUl`=fi5Lj>A z1@rqEa}2R=SCT^EeN-4r8R5c5IH%bMmD>ebuib*me6>pFiN%8*(o z9D=M32i(`LJYaSblkINvIV{RUl?XYcJ_xaKV37}Vl;N7{se0%wBHOqR*PPw;(ASTL z0Nzq{_3G7#C#O;EsTV1D6F+_=gyem$J5`aQvg!ka+-E_otkcaAU!cMQ#v@EfI(Dk+Xe;Z>@Rf1&w{MKGk#|w0p<~BK7<6KB@x8pW z`IEO#FWK=<+3{{gjUCi6xVAAvohH6$)I}<*eEo5C^E(@eT4?_Ixc5pXE7kYG9htHXuJKI>Sp`TyjbzF+g@~Lx-C?8wfHFK53@4fEdu6 z&xS|-vR_Wc`5dhJ33c~oXu^UEtVeixWS5O8WXW(w-f%`j25@$sl&Ie5#_MjPi1R+wE`R;UrrNeR3Se&8z9E`iv8Hy!4Wg zj0-N1z=2I-B8%X9b3mV9fb4y8GBQ2$J?XUOd|t~xWos@B8AJ0@k0B=qC^ueBTG=$D z=#L*hAUVIJ0;m{WY;IPGTT zB|EeAYnw4qk&%m6mEefBqc6bbI3m24!vS zjQM$UtC3Q!MQI&WDFYuqd5-v96e_!N0xn9R{OvEX&rH53fn7iys=#he zL23xAy`uj%;!sd1BD>ek??I^@qUSHqG9yOO+$>$9#f;cRh&UzN7@zZcq6fH+$LLTN z-Q^G3&wG?r=cdARLnj-*KPwy2$8dqLVDZgaU+a`rwUeATrX|t8nwo~(q& z${p~PXjnKQ6;;;f&)1veUcOvzn6uk++g4CeKz0e`A=qVivQL%gv4?H38079_g_))E zckrnMwa}Z546*sC+U|RsA%sq|;ueR{Jx-=;Q%WDLH!9wpj-r=j4oe?F%v3*FpB5n^ zRD1V_Z?}}If#ZK+YdiI#q?w^a3`L91nE_`%n62+aT3tL9s`)V_q-MunD-;pe@bIwL z%A*%;^*?_`)UuXaNH$0Dv}O4m?~fhppzY?nQ{zsFeVM4T8LRX<6(|gSG4S%6qpm9v zU2$R>J6-R5&Ja9aH?)0qAy`F4MZ;RiYq{pH=R#%2RdBGtG9VO;fAFrNtqd$D$%Xx$<#p1(ZSqwQoh4N}CFll)YXC-+=L9xP66JlurE(;3FU>EH% z0I(q0I}8}#5+mw6 zL*>@~dmroBE)7I}FXo%vH^rbSVcKWqF?CmWZMQ5#^bu0pF=j>S$$);SJ8iV^jB)Dn zuqQ-DMmB#--EJ?k(XHwOMAv0K#N#%@Hx@FP>fCXeiwmVSdg97dz^T|$uqm52MV$L4 zop&~Ff`4!J3px?}%EkuRP6`+sv{?>^s&Mf1K8A+gVPR?O6!fQ_`YIFU=6$YeuP4iH zCfX5K+onHTf7&G^oXx-&N=)$eA0r~>FaoyVPcn2WG}2YG0!_WdAoZFkKS{-?L6b+;+hN9w0@$X zfM)05_!JS53ceK47@LZ%&?I-HZ2a#1dqsQu0$c*hZ(!w+vd$F_Su0j~9C~MBMpisj z(O^?n%VXh2w?60QvfIW&aT`|ftGQXp+&m3oL?RKRFJ9D-(dvRQ<^eEhK;FYjsk&}! zuczB$v)BykOpgwBr;E3R{c|=U)NeSCkSN+Dred4w*2xFl%_?V~WfwYH3!>jOzNcm1 zqs;qk+)KxK>Y9SB%OY92zg$+}w!0ookq9p7+O=zq;H;s>WL=~Q;u;tjFlI=|&sRdK z1kkN*)*yoX1f6J5A6S5)(NNLV&3g6fH2zy{B07pG{9z?1CnvbACe zPSz6%3YX$ysoeQb^N|kSF`b3l0;k%bh7nqT!3>I2xe$*Ve|KJ)ecQb$<7q^FXMeoCYOF6S`B+l2BTmF8 zp+9%_oN_P--Oe4!LfU@<6>0u>KiN}3TRU3EZS4`Vi@iVZS(FqN4T$C;YbgHQf7?kv z=zsvy6lU&ig_>4BDi1Xo85!f3tpH)3Ku^tO?I-bw>z--~ zTX3w}k6y0ax0dV#(QakfxTg;hF2i%fc>ZqXX~oyaTcK!lLV-n}`9g078K-Hmxw$!~ z^SU7xWQcK1kR;i0086h2$Q)8lf4Q}Dn<$5?w>G{HB}#r!QdLccFS2Nl6Cuol2WwN- zig`6v10Avls99}6J*Y>VR*YHQ@CFoFpqPclAbe?*i{*jy&Tl_uxEXZU@j*JADsLbl zJje>)w8K}mv}$HT1;xU}C34pVsI!k_K7Kh!z(@F#8KXx)CR^%|MlCUN-?W>C?N(3K z0U}~&X8pnlZc z7gm*{4O{_EcKZ9XrO<7MN(SAy>%O^p?M04rDpUr*DQznq6}e^uRgy#BJc%%GZdgjw zNV{pJ3Es822wr92*!yZJ{Ceo$siUAH5T=oztghZG16{^faDaT!h!y8YGe7mQ6 zzIQ(+m@d}xT6#SvkT8&PGpY%ym^cEub!?=k$bHA-1lSNZxE&9eLbT!c@<+hyR0bi6 z8f%h}Ufz8~j&O_R3SY-VT@^T5E#nVak&ZpkYRCln<~B+ZA`%uZyoFG8U92n~H7tRm zeO#Cji@jJeIhUfU)U$*4sXdPGi9}ap09s>P?N%s81JKWqz&;=#{qO<{^ zv}bk3a}D{Ec;@Bvzsdd10Ma1B4NV(S>Hqp5>UZL8Cc$Dw_tNgwJ?tX?2e7d;N)h35C;t95clz%nE zYui@`B!Q4-is6176Hg9$xR3YR8N}94!|7{rR1!-UAu9KcQt=k(l2nuX@Xn0N3ic`y zxo8U%8~{T@8d`HfD->ZRefu2@`eCD?Xah{~h+45L6K77hRAyf>4gN;J^7dg0FF~}? z!5hL)ycko%$GM;kzed_g*uT(!?xpNPxZgl2UI*%%xfM{{;RZ*+Es|y17A%Ocn478bC>I+s~`y5rdvEjfE1>&MBYWd+k{BxE6Xm`q&h} zlYNSd|6naMRT-2Y?9Ap>8$Zxry`yOW zg9M020}iR7X57dL-LjPYZxZDt`vTSj%s$`d@4?J1mTS;>-DvzC4s@Y!W~6Y}1Th_J z%#I0IdHA()ASjzmzXy&yc##C4!BZPX1z3?PzAqe(MVR*>71m^WE=$I&P4&K8SIBNP zutA-h#zd$wGBh6eP?8F(-{W9!g8M^iI;p^HjV0CkM%e`(KnZw^-mRz!M4K!2y0K|Y zKAjr$MkYZ1dLAxtwj>Z+26K4{P%|yJUm9lAQkh4{bKUSCyber=vnB57Rt2Tk_0F6OVT`mObcYYl z;P+9XR(~y#B=n{ATYX^9!j4bif>!{EVsPOMXZq3{&^5>e4v;#>n|J;FYEXQlK?ZJ6 zvz!ih`Wv$^SL1@(M{?bQF$tTdW?b6rE7lEXpOqva(Q4KjkTy_ovtPmj3t8@&B?UML z;l?pNHAp!r#S;HFS^1wd1AxzcV`O4v1RpUNJGPVAmr`;h9N4k_-3I>Ooa3a@T1x&m z#-Fft|Gh{06VxjH{p6{Ef!*)#uaQzGDy|EV1~U0_i3wb~>Et2~(z=*@0fQHxAZCv7 z{!bj#e@L+!NYNc_Lbc{>(>uXp3jD2#%@0)bKo%3}3xJw@?6S*<+hOW=9_8#pMnl)U zuSTXu)}cub5}kkjz(kP_tJqK&^mmaN3(OHje(=Bo%2fA_V}^e0oI?0w+nX!qhL2xV zFHs6=WJP(bri`(P5BfgIBc9dEXtIee7Odc0o{o=X-Mbl3=A42w+ol~r;k$>*#`;$?4y-I(V~w7(BYt(&+)+^Q_fkr|088_T{L+IqL;CD43MFiDZN zbixC^+8zGk=R>Bkw(aQWRX6|gf47}&kTxLDA)wIS?&1r!erIqeRxmaexpl$S012-O zLs^op3nC}3x&>UdL=nCYLM4dxWIfYW)F*_aRX@_60<=XJ*QxJb3kU&NvXgk`=np1l zEi%Wyh{9E<9lI?flnxl!Z8H@FN8@wF;G7Y%FV=FA5i7kCA05&^foYI0GE=U#4hPU) zv~V~O8(y`K#Q+Vk&mTt!ykCcn0F0La(Qgn4!oU%k-Fif@Z(rDYI8{Y|+wu%cca8)* zpJOeWV%~8o$z6%+{#T%a7XSz3&)#Myv@g&1o8@%|!WNM(F&5J zv{|-2TEAp%+6|)xn&%S%CTyO|1*mxW#V(+j=6zK((BYPYDKHZ1B{x;7Eb!v7LjTKt z?g0X5^Tnzny)n|!SUg*rQ4OCZ#pZ`K7oImwZG zPQRJdP&dLs^MMeJP)dNi*=|h{2W%OxnZ|3tQXR#%7o$Ulc6=PTZ*Xl-$D{cvvY^i^ zg1IfphoOT0ug8k)*6%M{zlx7@rt9d3Og?loW8OS+t~08>Ei>b$rs24K4F->F*LWyY?510vc2*p$mLM!dk( zK9%(2T-QSEgHcbWtR)zvk#XNl=2crzIJ!&jjeD~WDBsv-z+J(Ml+n8d^Ji%0=&WZB zhlfWM?gzK>CXSki`I;>pPx!;?|MG_~l1b;@LGOD2;70nt+^#0fh?xO^h&=TlTJ;d| zEMINE$7tFW8B)IQFAAlkYO|!?%@*I}FK)nNXNGy8wo1pvLt&Pxtw4mq?6A))!0W2u zr~5$y1{ep&st%f}9+sU$c~M(e9XkB{@dGA`U}iG^9YlS|0+h-JQpICDGqk;llVxL- zw-X*9;vcFHI)C3VPJkY7(Z+#nZ1m8hVf-h!rm)F53FjtF<);^uQnfIORkAaH?4TRp zTZMQ0mD0(&09NoF_c8BxcpLhx-Pg@oK>>Jkr;@Ux4MhRfA;f(;IR+tlq8fakGjqT= zw!{3$iBy$e#1M|Y17Jxe4iuDw)o_99c!q{!xNF-TfH1nj*v9vAKnZWB- z_NzCp0LhF4n;0f9FlBXh728U`qbNp0d)XnJ4W2==^z=nGr=$y!Fq9)1BV3oR`D>`W z!tZ=9xP2+`ARe`kcn1MFhtOH2^``?13s@5?phtoVA4{?+FpVmGFJkV0$qbkWsF&v$tEElAI_Ip#G?ozf!UD4`P9{dKCKJ@ zTH}kXKdE< zY6;9t({~+Zm7p&UK1YmD@9oFu2M8(BRT}VilseC-{he?34A`)LlGND&4G3HjHnZ*g zraFg#9zta;)KvL>zxDoyI>}PIHorl+e1yA=ca}^f6ya_olQfcH^YUsVK{QHCf!n#T zW8))l;b#&}=iNgkx_?pH<*z8M$k@wJ|=qoBof`-RGOmq65#}Jj3&8r7o!j`> z>^&?7i?Z)iMdhTT=+A!7>=#23M< zdV}41{;A@crNDl=rVeO*7@M44q!+Mu-=32r>8r;9j%I}j$E3N&UZB1EGyGS#dAk*O93<2ADPZ0Rhv_L+Y<86k_GId! zz&)G;7Vch!=llgZrjS1^tzM!^2{o?9p`jQJRx$Z@^KE5d;Ue=uFelcN=9ozf z-%-A;Oy2UAnEZ^cuO~->yYrd5H}Gd4&8K5mGB$F&`WZ;7rgD-fUZQ}pwMIY#w=Fb$ z>E=e0b>Eqefb&VW90-CzAQ}j`7MN{yBRi5l>!G=gvCu6nyt;)m7TTe_bdYziF3zkd zej+Qs;Ox7QO)ARc-zuMoO!(wUe!Cc7tiMWa`_&(UVe}QfwQT@lbk55`06by9XM&ex zhL&)p*-sB6N(~fYtDbNCb%FrIpbY!!zQLOwGwzC^{l->%C?ztE2eD1%T%LVX2pYid z^G2*9P`-S{FBHdq=zT{_;i`2Mn}M|ILu6q2B*QFpwInDsM@I|JgIyro|hH95pW=rAzr(BNIu+ zA?>}=>Mjt$j9Bh`oSX}Ol#6fh6^~Z*D+e|S67r%KVV6sVBQVt_v3|X)-1|>lQ#7x; zisO-C1YMi+1qY!M_M4H+*6HmVyIN59*(fPO&_uSO-_#)KsA8J$ukHqfy2|b+HBbXI zajEsw)(>#fkvvHh$AZq8UExNw`M|!DXbauMj`@%eG4iz$vamHb<1({3SY+hZ&IPMc z6Y-O|&69I|0@443hD?~9>v<2-Wy7NhkNGb`OPk62XdB;`AtIgZQr|TZsyV=Y$r!Kt ze|e-s2&hFSNG>n{$W^J94ZVDwwJ;AN@ig))7^VYzRxaZuJ=5GbQstfj!q*v5$Xxi! zuZL^+IPB=8F!t!31&Kop14%>(48}qT1Gup0f9E~~7ak>o*5)SV zWrt9D!5Iyt{^5{@13Y>kfFMu5v~D7j{zP3 zIrsNGe2^^LwA0XmzcX9nASg&n`SPUpDb!u61}q>-81JJx1@c!ZwGzRPA~&>&B8d8qM)+0sOGuJLqF``(ov!U; zI%LzvaUH<|hh-u~+U}ET?Gs20M;NTrW1zE5yT7_3bH+_z-FIx1C9C(H)pBY7=t-L( zZ7{IkQmfTJk)F#YfwctONr`mPhYLySB>oRv;*B+CVHLfC8^P23B@f_)%{EsT4nx^u zo|18>ACZKWCPrw5nHkfUE)NWuFoIH1f zpK;)Ko{dk=(W?%g*NgWwOX`pi_c4by-$?b-eMRZGLx1onx_+I-(=THT{YqKzz~~YI z`XPBa$bYx{e9qvJFzA~ZQmeFIUc0}7PEMKo(ZOQ@VM>IrL1jA%B!`qjz<31nOkeR@ z8>EOp@=aN0@uK?hjK<0#!Ex4r!`&KjgRc}{!V@vPbtW{!i}z|mEm|A{CU=?p%REv6 z3(qf&tXM!wW-Q-*cJftOtf;#Qo|J>>ui}tMj_2Q;b&`{l=a66QIMol8DyD7 zC(7u%pW~EL0qtDk(}D-t>V_>aV)cU>`!hdTbY4E889o%3h8bqteDaP?=+oP+EzaEW zoQg2zfg+`3=N~Te0)5p29gkfjXjwljyAS2fk@E=iGW!ieLPS6U5Go!CxNOGhF+d%b z5GYru>KjPW5tVR4bs;+W;h#4b5s0YvAD<3=+spr=4CDboVIo|FPS6{yztR`;vcd)8hi8n?5Xs@&x{&7lO5BE z^0?~3r_?zG&HYY4V-4ngy~lQGqQH)Eo2&QTc!ap-SQ)B4yBeiO2W?|ck4&L)@uS@= zPa)5vCf$WLl-G=N%#4laas9^L9Oe%WN_gC`d}nj6YlFXSqfF@Fisw1hK_AueX4A&f z5DyP*9gAV&=g`p5#`gAhc~w;G9mu*2So(sF250V_|!RfJ9Eddefz1 z7!LUC8)6je`Z^XWPXFbpY6*D9R80@XdIg?JMnr=0N3Jpb-+#^C&dw@ugN22GcG%Z!cCtz2RR3RugnN8}7{0XnI2OJGyPo$HidTgMg*RLVeGN5z6zj7U*eERs zs=5gl8h8yCg^euqRc{eMIRC;E38v~3*G){`ScwAJACsp@J(+y8rr zaPW91SLb|3=~08V*nIC zmcSwW4@&soO(N=ynDoh(V10j|cyj-LHu-;q^uJ$7K79*Qh@LjIZJjx2=*!ZL#b7Xd z9H?;!fxAbCWk?JQ$-BDSf)1cipKpTBpis$(TSrx!{hyEi|0Rv%Q+hNrkjzBne3(TeebiMkLugnWvQ*GEz}8B3o8u@4XdS+4Hm|dy{e6 ze$Tf)<9l7d+`HJ3UvvEzH{sG^H1|bPR}1t6dxSOx$kVZYmyO_9+6f<Q>LJ#t0rj7ozHH3d2iiLla}0i!eo`uV}1qi3lrlJcTyD@+Nj2W=0tiw5idv#{1aCx`EE!5_Z6f{hp7C0_$4LZPk%Uk z1|{F~MLKPNtJSr@ga(nc!}ln2{=PT*Keu~nw!}s^nDp>#a(!ig`oF&Sq5k{MOTKe8 zA|i@Hz2)NiYn(35zdsT*=sWx_;u^-Jo7eWq_rd{Q+t0xn13jN@kNQ?>)BL#R&d!~f zrDA>jy?UN=O!|kz8Gd>_w%>hSk|4XbW1Q)`<&kro^n$Bv={(K!+spD2zfy?vk08Td zo*a{tLkE}?ra!tpGCVm)P&bmvX-zSker|Oj)!3zlu6Jjk+HqF8ZdXv{liU$X72q*teq3)&?JN0go9>0p}IJZGd6~#%5TXj_*4tGx5@pT24 zikZFBZLa<$FL2zg(d=sKLu}W(?asRB-XD$}IZWOp$K@)jh2{xwGurzQwXO>jFx0mB z&ulf0n;7M3TzN=KJhISFYyRZvOF})~_?p@0KC77B%>wSO9i_%iGEKBJT4|v`F?eaq z5mWPGZ)QvmfAK`f$%H*bd)i{X!*U;LDlpFm9XUC@`?6W9noXEWu3Oq=Jp;CwcFsYd zpupm(qz2BSyi98@Tu^?FqP2UAAi{S4t3i3LqrZ8?`ki{&rBHzrwtKeN@VQ8_EY+5i zG|fM6!Kn$l>g4vYMWue<6rJRXb!Ub{c|5doMr&Ybt5kxXfD}2?_{_CqC3`=@)tLMm z*ZVh0YOHMs(wNJ*?!m3{inxZs1#pG1URAT$ac+n#=7LYK6_T!)589HipG9e@F1u-e zt;KqkT|g#gs&wQ}`+7<+IQ2=GJ^^e`{HV@T0&hyIIM~Yt4%RB-i-UY~$JA+^v>V2( z@;AR3YrXUpcvGXc`;+HEiwwWEv^2U0RV2vP5^&FoX zN$#@Y*{E@HaxM%JqHe9tVdZRXZ5M_}Q1V%^X}3F9Ls;~T?$`hFg_FFYED<-XT7Gq! zgG>%~SME~Sf6qbDN8jV_Za%iYyUhqAR-slB#i+QuPcXzSTK&5muEk_?Jbq+OlB3Ez zLFy76-+s+5PI>zUdP0#GFNAb`|0Tn{J$wp}*A?aKiGE_oiWcKK>t@<##+t;t;h4(t zC8H1_DH&r96lPa`x8hvpetEhGw8-6!(5+GS)~#Dk{GimE#5_FJUQ?Fu9|{}xQF0r` z68Tn+EU{FK(-jfdb=VFBR_4Ul%C{AAC@2(wOJ+2_tM#0A<>4DfX2XQkUpTrX z(2+)8mn58+>F)aiPPc9kWu7x%;x6&NU_ffU;Co%hJJnc`Sw?B{Ng` z_H8h81mb7maUJQAi|76GSv{ zwOTT>fKrt%{nWhhrdr|ijQgMs+F48=KuVFjsZ1kCbq`?uZIyTVMqQaGm4rf>$LrUQ zBRKm~?@Mwm@o68heZ}|pbTZTY5!pB;QafRB?x#n$O9pnA<&8vN;ko(NNWIaEtEBZ$+;Oo{DiNdu6zY$Fz zKDZx!qhU+;xrDMem4KacC0&k6GUu5_q15w7*xbB)->LF}?4xY1O2$?>MLW_P#omtF z9L-zuCBfWpY6zRL;^lEXBFyEHkOcC1Cw|ZW!+!HiwrgHn8z|xnE+hN?#gNoudmlxxRt5!k!R~5(d;JNmN^h9H2`W1a1`k9sV2}zwe?V!=w(89G zMh}S4Oo6JL)NxJq(O2m=!oyHew87yZ{p@fLo)5uYapHB|U!>3PjnN&nov&DaLy=C`IXF0Y zVU!O~Jc7$h^-F3^`gJpK!^-v2~#j{84J=VV=GBo@E52d1#=lIH{!n~B4hNe5$ zu$98>)!*LLRI|jUedJ&tN0BKfj*kcg>UA?^PWz+3J#ugT-|qUJ2jUCB%l;clWt7Zb z^DsU9)NT5*#Gm)?&>n^nC=|JE(?8yv1c@w=kNzIFE8i~IC-rhK1$-JK5xTKy-LF!i zd}DXqv&8;(0@kTIp|$gyTH-H9o6g^5s^Oo)%!_@h@6FjZp1i22;b*@69E;IfTIk)0 zsud}_X+)E@!G^Z2lQZg@8?arj=cG-u4bLlrp5J7$SAMoTw{(K zPo0IAu3_2a5l8QoY0A<`&{|=N8S&V&xZeGMU^{GX*q>8|sa5z_zD$hu7z@Z57;lw| zLJ&Z3Im+Gle3NII1kjJb?vu*O9(UB5^NoJkzveJ07)8X)Y`j+ZXss<$4_`}Rren{f zTeNkKLMjXMo5IwJ8*VB?VM;)M18vCYgr zPM*7&Y%hA3w6-=o6(&~>#m!X?k@q$|`!&p23z3hgrYj^Vm^EzbU#n#53-(AKbWUXD8AcmKrM$<_4drUd^gm z!ucY;Cbzao>0T;!saCMo{*@-kROmNi^mffaX*vGs^m9p?Y$7d|;6mK4dcAumucQ=g zH{aWCZdTvitSB$yFtPpw>u)|`N zG&Y=*djEl83uv^`*E9mT+K)dWCQ^&ymwqNv(f~3FX330Bnr9;OI;SV;g}&eJFus$m zM(3jd#otW~j-$+Cfi^6;-!meJ))ZR4Uq^SejL>?Sj=c(1P%$N9xNt+{3%FYYJ4sjr zuK>5^IgBgyTCxLA5jAxXcZ0Lb#jUN>Qv>EVqdkqDXFM%soSE5K;%O~D6<;(c-*p-# z=s&W*Q5X=fZeIK)QXL-^QpuuP-Q05U@y7n=2e|clSF?ce7FlAx7qQB%i`PO$6az|g z3-p$p3UKYIhB!Bt)u>;Y<&ySKNj@^B4^^;E=Sbc&x!+@{Znpg5^kAx?{gD66aO>pn z`|5M|6!agYt16E|5rgdfBQytznoud=jg)IkULeNz?09|S|iS7_1uE} ztoL|rrMvtdRCu42@N#b1Sn(gE&HL)al zQaaVQXfO$;-NeQgNO)k8;AB*_d)_rxA#q`-+O8Lt$~5NKbb((jfM;9D-k|53nxSX& zh2wSLH0?EuEMsft&VV(b0BgYMYGrNB7Q*TA==pw;279A^Zf-7td1tS$ywGJ9mWB(T z+bdmNN$D0{tb#&93^TOlPu={|)mve>Bkaim&sW+V9ng~Yt(pC#N-DB4q-1ATFtNXl zvllxuGg4VuoVF4^^-L~u*5&t2+u6sBnA0u1t3eSFbNNwA`ywIPf_$tM*voC@lMd{+ z+304s3nwq2LL%mM`6F1mBq=1~_p&p-?b<`AW}2=i+&84TSFx~nK~&AcF4#h9+oVn3 zC*~d)WjxPIyT2BO0@!W8FD#0Ix!QUx>eSmj=~C6O@s=p=(q~Q^=D?Tlv^fvV_@67P zDqx884CMA@L)lEJR*TH@?KNn>N!a^xE`8*s&#{|7KDF8w>^&zoyE+H5X3u@I`xLil zRd+r{*>xxCO*j~dU<&@wb(m4mK0Yo3Pj5C^7CVc%Nzvl=0i8;`xwyIu3zUV^pCo@n=GZO z8s>45&Ya!i?7iz?BOW~pP>%Gfs=7@|CpxG!bVR5wATTgKhwC7(iGTRHL;#O*2cxw* zw?Pv}Au=^AtTEPI{96VC-gkOL?L=wvu-WRiwe@Vi_L4JV(&G z{&G%Yb;K^Qr*vx$t-GLCH;fCk9l=L0>eAbJ5m4uoB1y%FlO)?)#BJ$zJybX25LB+f zBheG9%t$K8kL+=@#T3^zsZQf^ZHD+VCsO<_d}KU~sS9@2UvGYBe7?Jb>1VeRjt7X%`be6l~VXVmj6Efwhm4EidJ{lv~&4QYv#Vn+Au?^|Kl zjm#c|Sc;xhGP}rasC#Gj$2>$_h+m?msxA}Vu^$$_9Z+U4Y=kkh{dE3@79&7D?UMqz zHGwP&fpE6Jemz;`4Qc#RRwjIog2M3#ky5%E6Iw0L$bTz*g>b-n()auKJMhhqQOi74 z=C&D|@JMSp#Bt8|<(3;*gz{TN1q1}FeLo{dIFvA?*U-@5-#G(`bxsZ!a=Li$G7C*QYLrt1dQB@}(6@a9EvmpvA$k6E=cuxFsP8 zNnPF85dqGP83$4O`QF&HwCj}%Z=C2n;uw|dEELkL-^43kgw}Id4FB~tF zmBHk7KjY))XXPuH&^-dkjT?umEzu5cX{j4MTsa~#p{k}9KCxZrOUv!bFF0D^ZA(K< zy*vE=HL`aW1|QkE!pc3f$_Z|6?(zhh{3kdS?-5p3)@I+##)$w>16kQ+mUeHQH;ofq z2WHF7$7isukzBj&_vp6R=2$;r43x9>b||jw%_FTq&4bZRjlsHU&;G6QJjxUcj81ls) zlD;(J5=;l#CB1q55@l)K6Ow_e?CgBG$N9{x{D$~EFn82%Vy{zsr+Gbmc~*jPG0xYH z%+2Wj^nkkGkcbw9plhqx0+Y$9K7!cZnb)M{GnmOrxkynAtCX&dOXlLn-9{WlfVy@i z@L_7{lvpMphM=L;lw?Q{-0+JTI15dpoYrXGHFhA^8T9YTT4~bz=-| z+1XcV()8&KUWht4Z6TT1y9|`pwFX3ubr}$U-Egx>B`_?DToL(&U>YAbt@NW75W(kQ5_lEh8n^Ra=CH<^OUg)Tm z(y1px+2}~7A043^VQz+$vp}Q8zW#RJ^PZE-d&g=Pvni|jynS&(OJ!q_(*IPA@5s$E zRL^#5PTQmiY-()8bQWxTbvbv1Tcb2u418(7K*V*5Esfd1UJG|Hnv`zqomh4tI!;3$ zvH+Q#mingUdoO%Pib5X2hqZaZCx_NW)CX?DW%30VdtwNw*>zO1on-}@iSc0F(bn-9jPIh3;+ zBUEvhTI7UN!MRdwlQQ^`3uKL*T|P#+{~jb*XBJ1c53BYur>Gwc#GY38%u%WF>g7 zH6`72)v^8>{jFi~dMaCKifLgw8`aqM0ufqkNR54_W6R`(-TNpay$d0!vDwWDIcCyP zyqb&7vu`NO;vg!QN)mFZA`x}Yvo`zM`kHenSy8vI@h-*_0nFU^bZiQIR2kflB`!Zv z=Z^ZEsaaZZch1xL`nz}Ue*E~+(VvfL?mrSGx8j3U>kqbkW8M6MDxW{i>ve%-41SbS z&0U6PbomgHD0?BXZk@m&e#o~$Zc&KD-2w4{s_5E2^wGT%)kkJW zX?vNhM{qrEs;3Ai(q4Jx!6ivUlgXm?TOkn~{UT8#)4hd-?S*8I01pU=FLlY`F-o+R z)y)o@;KZ>zb;dYydB{=XlrGsB?h@Co79l%ztFwhbvYF+253BmFVY!I~#HAPtXVaOz zj*eCdM#@`-LR{|W-!$LfNno6-$_Y6Eb&EDUD(>rN&z;+P5EK>}xxjmOTF+19N`od( zhr->vZx$R;lALw+!w!kO&B2V;N<<^ZNR_HN>;nEVu%N%ZG1!dt#usn>?By~i`vkNg zXG!%mrL19e-5D5hEWZd*-1@`~SJeRf<@mh3ylx3T@2{_>916p$6ug@LC;-}Jqh1Eh zB^2Y&VLg8}ms=2!PYQrC;LswLu(V>aU*-x}<|>XL4jxjHedTv^-wg7^ zMECJA_`L9FrlyXPbC=M!eoFGde_S*(s%}^du@e&xxs1hrPED^)-Oz zKoU=YzrVC@W_$4q+-{lfxab|u{-{yRlWkAsD%4%!^j4Tp08X+ zQoMV4Cf(PZ;Y2oA$yHTUrujvlLZwfY_1nkDa8eHurwyac<W5 z^ESW@DVEI!=Q6T09K~)5pzp3)t3MuJ96lBXs3S+``a;X2BjZNwuA-hFW$&7Q`=8k9TDcWb1iO z%qb+uWNXT_$$tB)n5uMyT-cfGuO8N>QAI8M=C%8tUf}oVNrCI*dEs`M4W#HrZ#yBk)mKSw`zb<@rl~;X?KqixoSIfCK+sMKwK}{|DWb$M)0zQ;zLr*D8}j zVBhKIPo6x%-zQAL`}pBQKDs9Xh5EwkZ3g}U|S0RaV^Y!~1l%5UM zClF7pzD^@vS96`_?O8nEc6s{;J*+V7G64Kx3XJpVK3 zzoq5BDFG$#&)?vBij)9Rs5|HX9`0Wf0cPRD-w^esC;Myd%xZa#5{D)4(ZZt#ZL=iD z4$IopmVomyqi3y#umi&THK3qxm7;wbe3 z)7Zb!^o$ed*}=me{%h}soBbOh{~yTvU&#C&T8YD&4NAQ0pE~#=6yBfy#d?@70dxBI zHcI~8@8{sd(J#&Zi{<~%5o3HFKYo1m$`wiWkW@rY5DEYc>E_8K9Sk4W?lv?xo3-=h zpOc3NP(|_i)x3;Q?kK9-lx^RF#3x@t8a{VpRmPl9yARi< zL0_@mok`>@CMqg=pA8`@WW0cb{5s|RBv|s9w1mF?7e?Ij31l$;TW|xS03#$p_JugA z7wG_MIyg8W@P&3G93n)E0(sRFRxEHaP?(ap;D*;Mi@m;oAoWtiFM0wxAko*?hu}`y z>TqfaGGQIQ>B#M62>aK6fB^NUSB_qtZ_HArTK@f1rF1S=IT@L!S4dIfk7)&Mq*z#3 zyxza>Ojbzjf8ok37uA)TS&mm8z628mcoHi@S!Ea_EA@wg` zzMLAs0w}|Te(>PIsR09y%!=)l-@kv`j5yRS?pjoAC1^R$Fg23AwRkZ`6EIj;o2G!e{6&GRFDWwT67y#fmTNWYoRw(|l1sSl_ORNm`VU`T5)Pib}cmF@Z5 zRz`H9Ty(*U1F`)vG0G_7OTPs5Jzg^c|Hb`}?ZiX5F(xlfQ7Ze?x`H@-9 zBcBd{k=@-F);&p~p_J>h-O}JxS5gmju8&#XWJH4~Xw6ZQ(F%^^!V}?n6A<)S1P636 zF-g&K*_z1eCyTM32}CTyw9ykiy<<`+y3F; zCMG81z3p`qb925z+qG$Vm@YXv8Qm(nlUBU@tL8oOaxSr}(Zy1x|+@908DbNJvc-OC8sy=^Gq-?@I6CTn`Evae1*( zb^1l?J?czo*+lNcMNH>G*o|uQ|6Y5CPvQw&&5y>$kDW6-(M8m^-dWaKB_<|f;0g>L zK7qg+61*qEH#4M=!_v}QMvqJI^; z9}(fGME{@VJ^ z_sIqgIJm51dRROqif(s5F4`;U9+rWO6 zjg9x!sW)%lfYX`WcG{RX?tVt7prS&Vw~#0snRB57FUDFA@DCKNI3qVBH8r(+#le)= zLElD!H(B_&3x0oFTMT%_{1j(#Lj>BaAGL)4Jtx)NoK>#8#!@D(%K2TNNk`2gHfT5WMwy*A6c3a!K^kLLc35&NSU-JTu>VjjYrh5 zj65GBUA1Mf2Gwb3GWU87TihnNR}#un|NWgm#bC8$wuHU4 z^m+@!AL1ypDR6N?j3AX^(RF~+Hb;r52dtGZIk$3Ml?RIkwo8471K*E^-+b*j`R+Eh zvPaW?=$vIaVnycO==}&}fs=itpzsk4$6kdYVhj-bd!usKN@d_ko4}!|II3e`FZtks zPn7GvL#|0h(B|f5%mBxu?|65x03x3~f1VlLpJ)7WYa8Mm-lz5Cyu7@|Ad-kFgkggs zBh$fpA{U9cigah;jb1%)YYJeNh)5`7=I2e`bPO$z{bMBRDR^*P^okP)lUw_D_3SgRl0GN2hN#cLKj_kpDhd& z%7Lc2%t zxdkdz@MX@Y3<<^gUp(VXf#_NCd_&<6aT5YJbVs_qNWxsDU0i|1$RcjIz-)lWeo+IQ zwse3&Q)sMyWAKrMweiWxl%ymnFwkJiKqV1%0U*8E_m;77a)NAR3TSIYKK(Xs=>{5! zr{Yhx7yM^3QfT+{xAMb>Ki9QU;&s0)Z|0fyab+e4R6}r&LgfW0lD-=%wZ|+D7N;a9 z`!o7ba^42Zs{r%VFHqg`L|j#VRaI5e;~@ytvKUTF9I{Z`?rT0_@BXj}?t86ELCzT5 zFyhK>*1MH4-`tNlZjO3Z_fMuMrn)Df<-)jXEPA{*n!F)Aij)R7g+$yjLEtvm{akk? zATU>}cu}mHXZ8KUito``}e&dKfwC3VZ^?9+2Nzy8tMK# zn4O)yeXzf-4fmEf7451eC$b(W3L@6s)fHNE9m2;9Mt@?dJoZWm>aOx_Jd$tpq;pY$ zsLS9~Bl0{r4#)kise#;gF#D-<@BZX%Mog*3Vj*nm2?(nvoKw$((HKs4dy>Dh&)5s< z!)~lJe@%a})5Y;V8r>ewi^;Q{Q-U?hfp$@gxd`8aG|I9MIMf<=z`{c~vZic*XtQw) z1U5WMRHvhAeP|L(N(9-|3uM4g#QkJ|0C^sQ?dcfg4d9A8?)8!i<|RVPPJMIVr4a`e z6e$iu;;*?LcQ{Up?Pkr+&hk9@{`P7f5YA&3fCAU{&Gc$&8=xl$nGRC%h)e|A8h=)N z?W$TPP$_$VEkuiD37l>wB-hR6{Kn0Qgt|PC7+g+U+(f95Nx($7%`WtZ%Uj+P8C59* zf4OKFqu-vwu99SY!TJ}+Y-O^-^Bx7HL-05k=36X(dQiPRy zdV7PcXb`xET|gPms9aP_uW#hk*525*n~?eONbSDWSKAW?a*BZ2HsXM1AVIc5{Mh0N zAduLSsF$bZ;MjIO0;EFlIRW1RqJU9_AxY;nki~$g@k3knS9gWZt(Sn^IglQ3;EPn4 z5%UBxb#aOaI)6%Vwtw0-#`_7_syNYg_XV9ZAeg;s@A;U+$)wF0$Zp~RLYqISimqN&y8*}tiQd~fpqsS=G4se!!YT4)(@r21 zW1tv-uzgqa5dhIu{~gv!Qhf9;dMOZ$vo0w8o?d%~fPsLIx2K8#H{~ikhLCK8>=77C zWQ@B^iyQx_Bn@o;kWbRUn)-c_^DibPw^0rhWbj%;p2_fK*uAY0uBo|A{1tYdl9T9ByLEjPH! zeDf8J@{)Yv=?%U>#d-kCl$kZH>?;~mP0Bo2#xt+C1If{W4F`*Nne#vxg!%w(1#2pT zou1OGN{V%9bXvT@#-#e5?o&d5cKN_(z2CyVt4H}T_Uk+JC*DTExg)efSRMhzGGWy@ z8k#uB((@pbfyM(5>eJ#UDCIhRO2{hKFA5{_GGHJQ+i#Ytrs&NTXgoqYgH!v%i6jyH z9s{h@O?`SwVFEfyX3<{DfZ%Yb)wsO;2mpN`Cr{0ddTu66(a5%h#dbK*Y??+EE`B`6 z&>0tF8#FoK%jW3_8wms;P4rtP)v-4x21duI#Lez9u z`aKTsxtGr&CNZr69^;i8p%fni;gP!T;)zx3h3IKx6{@MyNeIZj{E49%(IM3wBN+Cw{HQRal zmiX%fb1u6xEa(t-!O;sJzlHkieg8o7imaN`;7l2qjoOdkC{lvE&8~p>l$btFxkc1_-F>W5*pTqqUk}f;SH|DULLTV%WBxG z@y6$hC^^S#V{%=hJZD7<&3CyGBur>sE-X@nQ4HDGJ$# z5&=}?QqpMiXU~4X;^=b;8J!|Gbs7m%i*>q6LOD!~+7<@PQimqod=KOPnA~E3#h^3A zhD6;?5vcITB`&wIfU5#$%?Gfj;3+-9W+_=JYBXZffG}EM&+TS+iiRfjU!A{l`Ysz) z4xWu=5O2Q015Y4^+SQW~GN_z3DI&7`^7)@rv%v?ArLDLc7s+S0riW5v-~(#`cH0{4 zHUyC<#Pi1Fz5@&gG3R-}M*qtmqELdU!xoW9QiPQ$i2BP?{z+UA^a~Y9`p0kor9ud! zRuFaApz-%N2=ed;p#XT+wu0Qf?_ z&;-F&=mdO2^Q~`jE_D~oX*?c8C%(#;t+Yi5ztieRjho)8^KAFr0^+Vy>OeMdXe}0o zGohv(RwoFxm$=HH&s2K%!f-x`I@s#f?aAg(Nr_gjrCwj!B!~eAB-KF#iL}$b>Mxd#X|Ptz)v_a1f6D zPnQ=|xXf|aC3Vh4+W*0$)!4Co?&6_t{eW?4iCPYv;@_;}OeZ1e)c{|~`O_f?-_?*Z z+Ed7aZq$|x#=!uq!5P#f6K6N?EH`#h>%v-SS`RlUc8XE8tCO<}Fzt={?eCd@fr;vnN)L2?8u0#hQB;HD# zH`ZHU7-2;tmx=BG=CsyQIqsglA>&^xU8~9pya1hr5AoRy=8AA(e8CH(ePKdSD(?%U zaqPsF4GX=<(^8n+lK}@@xeoI{AApJ8mKNecF(>FY=ENg+<__*Zs+U#I((`|6*9+X` zWNdfHhCEy{U+_{l2#wcV`vXjrOMMQ5K_V?^ObIUe{B^%|;OZX5L|)U#?c>rpJ?}_~ zRSr0gHC0mT=O-Yt^xmLa;C((EH`@D9DHiz0>KT{|3c#89Dvpk6{Rqt#)_ZJ1tm{2L zwp_5ot3{eXqlGw3{aZE!m|8DCLg?qtt_>|)4hQ!;ZVV68=5b$S7s7sDwD+M`A0p`f%3BWXcjvqhXUrL2Somi?osJQYV zyeq|QSy_SjrTg)hpkw|(Fovo7vvK8bZB5AN(y>j%tjm73?kQ^BT@pC}0!q=FzS z8$iLJsL(JWQggJ~!N%aCm-5qL;_vrdQ()qAWqG1HS@fU@R2Nu_EKI&8?t4Ix#R>$3 z7MZbFmW#l>d%z}qUs1g6hQDs7W8wtFDoD^q48^1;+77S7hnaJ(0qo#K<&BachGl^D1O&BLPp#9yp*N z$|YGEgz&=9u@U^-Y_u9NGKisv>n*@K{jSjteR)1r=XD~|h6b!-Hb+M%h>@>B6vdbf z!Sq+m>0_9JrQbhHk4+*3>VtAV@6{_?Cs&S*`x`H|DkkkzZ#E$vZ#{OP9l(&02f;_K z+o3hHub{JMyM5yim74k(1qV`(K5ifvG``OciY+p*vs~s19cR)f)TyJQD+_>PJ$x_A zty7^`?5zrgN<35`P$=S)c<=Z=z<|FEN;*BJDmULN*-}GCN_Cpq@^-FYzsnOkmN+rG z0(wpA;L*nC&fqGsx+k~3Zn?NPdS7rYGw9zQq6 z*yelM*-`{QIoKaLz$_WS4mALm$@BMIywLfXc_9ky4nzqC2&2AETJA2BS-&!nDVlu~ zIImZStdz9Ja#PZFwvSMc7y1SrGKw`-6=>|#8ES}AdP%+K531!?N22gP6(IS*#Zsp- zMx4S#!H)nAU$MOi0yDPg-|KhKIoG8qo50$$HPE&lujQUTb#>LKG2pQ8?~G~c{@fBD&xPF5;dQ0ic4 zuFlKcWqqX&9ZCp~7c9`N_qPfH4GqM>(DkZKdBkUW6;JsmaR!DSzEpWj% zTG7x1xXe6@qcy>eORjpx@1u!m*6|P%4mk)2D_@$Ma!kvT+`e@Hm`nA?mbrE3E6J^> z^oR)MAjf=MGJdb1OpR^dAg4!f+uqG*M8d<}4Ly?g@5W69zQNYB z!^v(2UZha)a6G;iDG%ljLWrFs^wsUa1DSY6RV|gl^Ur<>OFJ2eeh=#5j0UUUL(Ufq z4HIVefsZPpj9P?OzUJPT3#K{nOD7uuI!r$L8&JXyxuDR*g-tzUM1p-jow1bfNC$ym zo+FJvh3qJrf#G{+Nan%>Khel^On!Xlk}>E_aOJ)6mY2PQo z)xLxNvpsZEINAEHjiDW+hm>X2#X!K!AWx=&Is-f&xPZ`VN&t2^Iv3IfZEBwlG%s%= z-By*Qeb4)cl~TwKoT>R+~ekD zXNE4u*d(A{h*MrQp*jMv&K2||-NqyI zHf})j(ejsIASX}D(o~nVHcr}#lMdMHJ7QkEau9kz#&ZU(e#iskpzgdS>2*paNpS6+ zdLxZ3YMx@F>7rfkRv&TV%|ydzjR1e3LlUSVAJP}HdHw!rse4UG&pERn5UBb4? zTlb9QQDzNmB&3|mB2yG2~fEkWP5 zr-K+Hws4=?-g}^_h(s9v$P&_zH*^x~FIJj5Xyo6)f;TeuILx@g9!%iwJT24&Jdci>}ZOqQs>2qCT8_sPvgh2FHxi50QiM=PiV7~7DXx-1ctrg zQRmv51RurgGzzv}R_W#dhrwG8F4fOefl|{01M@e}pH27cwM%?T8Zs`L0KpVq2$JC} zZZ|xFFqmT6C94D4Q6^+;j?PtWX+SS7uA~rYYJfa&Apfdx;!)CIdH<2M`(@hQVDR`iiX z{lmz7MX7gDBMC`v%tj!@Krrj;>_q^W1k*CdRa=-Ef_ZJi!Tq!WKD`D;D`J4yu#k54Xp0N6vm;Q~=9Q^Q^{F>`e_@l(njvc#;EQ@g}L&4+`F z+Sz{4rQxpgbr<3QsL#Bl0A_vtM=%#c!$tBeaKdJN zsw~O2+?&tU06&VFQ+HWTf}iM^T;JlXU`0~dn)Uh6TpQ@oeuOj`Um`i1PeR|e_BLSW zofrS{a4bkIO?cFzs|MuercAzHw5JuJTy-SGd>e>78pSUCG#i?ip z3I!Q5>CG1m@JzbHb}Yp?Q67`qrq@U2_}@!&aM$`i8Vzrr++Q%rLt3+jD_@kTVS{=`7E=ruV-M4F-MY)DzH>izT6c$8=! zwCR&vq=r~Q_Ny7hAQa0*f3ZQ|ZaG1KZ&kJyn9#HnhGagF!#IeYgk}Muucz4%hzSMS z`})n?etL*Nh6r-jHX9Zp26P-=%|{}1V~}WQbxk6CYupNH7(OLozNTLLyx*v4@Mq~h zSgW4Dl0gKE5TK2f|1#X&M!C#Vy!5e2$GG>U_x1})5C6*+hJxP#jJ;p3>(*mF@+Goz zm7U_|zwpi*l10h^RY>y}c8BO!Z~hA)$+nTLfU;&f(|E7fc^5Gm8TPjDRzTnQ6>sVk z0M?tR9;Iz?1AOEXd1owKUE~>=oi^n~03b_KN05GM@HML`<+_D?O3Vt>@pW^XhiBxkYLT?L>-f2_gO!k~pp0dxS#f49%5*BtXN)u+@Rm+yZbk!_5lM zJmfJ5-b!AQfib!!e%_(1hhI_NW`s5ThIyw=8A&L?GUdf_uTeI77rRF@;r@M!n zp`2KB{UK9RiyKz5H(Mnk5gRixhO~@V`-q?UxW09zJ*p-Xgz=!}>QRlp?0Ny{7 zRBOxryX55%$n{ShqG_m|KTG*bzAHb$3H&wP=ndw77rfbc3>F2Y-UI~M6{q}ve5*L6 zoTlxx>-O{+Hns9tg$T)LgG39F(=k@uLn+xFs zasH&A(-Z}~%0KT9R=ME6*7GPXNj*39c)6;5x?*d4Z>Hr2p4*7a?hC=;kr6XE zL&A$0AAnL*H(@1^ft@Rl#z#eKX=!O7-!L+xC@o8e&ce~*H5@|`U1da}xB||gNN%=v z!XCuMftE#pJoyxPG6t4bFC~lOKtBH9{|Tkz24JI`_icO>QPKbX9ejL=K>+V7iUx+K zdP9gJvHa(~f4+l{#U-uq-SGI3sgEB+QU3hDzk`q6yvGSq1g6MRV6_}y|9S79@5~D$ zZU8X=519y-k31lb3|s+V`F}3|E3!37WNU}xAzS+izoqhL9si8??_7tE|NnicFJk(y z;bwj=u`r@yp0=GvU1Ao&6K`;Vqm*^TcMI4fM!9{02kx`OMOt;7K?NcQI3CZ8x>}6L z23ijFFbBDR1u2wx19CfuuOR~TX^jxYbRL96VCER=J|YNKa0~zS+Q%qV%s3(%htncg zA`7Ga*K5eMh`1h3+lNextoFZNLsom@?`aX)6oA$I*K5dXt&r6s(>?{ucPSCtnf~iF zWVQdfTM*6vdhKwv|GC@$FC5YfC=LBN8$|FAZ{k1C7CEHDyFpfqsLf;M{7xci`Znj`-AQXuF f->?4f)4-jG>n~r@7l{vt?@;KwvUf6W>$v|P1W$_G literal 0 HcmV?d00001 diff --git a/api-specificatie/drc/current_version/readme.md b/api-specificatie/drc/current_version/readme.md new file mode 100644 index 000000000..e02f35bd4 --- /dev/null +++ b/api-specificatie/drc/current_version/readme.md @@ -0,0 +1,65 @@ +Naar aanleiding van gesprekken die gevoerd zijn in Nieuwegein en voortschrijdend inzicht heb ik het API-ontwerp voor het relateren van informatieobjecten aangepast, zie [redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/Documenten-relateren-aan-andere-relevante-documenten/api-specificatie/drc/current_version/openapi.yaml#tag/informatieobjectenrelaties/operation/informatieobjectrelatie_create). + +De naamgeving in deze nieuwe versie is consistent gemaakt met de naamgeving van het RGBZ waarin zaken aan elkaar gerelateerd kunnen worden met de relatie "heeft relevante andere". + +![afbeelding](https://github.com/VNG-Realisatie/gemma-zaken/assets/37145898/b5fa783f-e61f-42a3-a7f1-a5ee9b4578dc) + +Op dezelfde manier modelleren we de relatie "heeft relevante andere" tussen informatieobjecten: + +![afbeelding](https://github.com/VNG-Realisatie/gemma-zaken/assets/37145898/87aa8534-97a6-49d0-b13d-aa8ca720876d) +De relatieklasse `INFORMATIEOBJECTENRELATIE` is vertaald naar het REST-endpoint `informatieobjectenrelaties` (in meervoud). + +In het volgende voorbeeld leggen we de relatie tussen de twee documenten `` en `` waarbij het laatstgenoemde document een publiceerbare versie is van de eerste. + +`POST /informatieobjectenrelaties` + +```json +{ + "informatieobject": "", + "relevantAnderInformatieobject": "", + "aardRelatie": "publiceerbaar" +} +``` + +Deze relatie wordt als conveniance ook zichtbaar gemaakt in de resource `/enkelvoudiginformatieobject`: + +`GET /enkelvoudiginformatieobjecten/<>` + +``` +{ + ..., + "relevanteAndereInformatieobjecten": [ + { + "informatieobject": "", + "aardRelatie": "publiceerbaar", + "richtingRelatie": "standaard" + } + ], +} +``` + +`GET /enkelvoudiginformatieobjecten/<>` + +``` +{ + ..., + "relevanteAndereInformatieobjecten": [ + { + "informatieobject": "", + "aardRelatie": "publiceerbaar", + "richtingRelatie": "omgekeerd" + } + ], +} +``` + +Het attribuut "richtingRelatie" wordt gebruikt om de waarde van het attribuut "aardRelatie" in de goede richting te lezen. + +In de aanvullende specificatie van de standaard leggen we vast dat het attribuut `aardRelatie` aanvankelijk alleen de twee volgende waarden mag hebben. + +| Waarde attribuut 'aardRelatie'| Beschrijving | +| --- | ---| +| `publiceerbaar` | Het relevante andere informatieobject is een publiceerbare variant. | +| `ongespecificeerd` | De relatie met het relevante andere informatieobject is niet gespecificeerd. | + +In de toekomst kan deze tabel eventueel worden uitgebreid met nieuwe waarden als daar behoefte aan is. diff --git a/api-specificatie/drc/current_version/relateren-docs.md b/api-specificatie/drc/current_version/relateren-docs.md new file mode 100644 index 000000000..51c585865 --- /dev/null +++ b/api-specificatie/drc/current_version/relateren-docs.md @@ -0,0 +1,80 @@ +Naar aanleiding van gesprekken die gevoerd zijn in Nieuwegein en voortschrijdend inzicht heb ik het API-ontwerp voor het relateren van informatieobjecten aangepast, zie [redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/Documenten-relateren-aan-andere-relevante-documenten/api-specificatie/drc/current_version/openapi.yaml#tag/informatieobjectenrelaties/operation/informatieobjectrelatie_create). + +De naamgeving in deze nieuwe versie is consistent gemaakt met de naamgeving van het RGBZ waarin zaken aan elkaar gerelateerd kunnen worden met de relatie "heeft relevante andere". + +![afbeelding](https://github.com/VNG-Realisatie/gemma-zaken/assets/37145898/b5fa783f-e61f-42a3-a7f1-a5ee9b4578dc) + +Op dezelfde manier modelleren we de relatie "heeft relevante andere" tussen informatieobjecten: + +![Alt text](image-1.png) + +De relatieklasse `INFORMATIEOBJECTENRELATIE` is vertaald naar het REST-endpoint `informatieobjectenrelaties` (in meervoud). + +In de aanvullende specificatie van de standaard leggen we vast dat het attribuut "relatie" de volgende waarden mag hebben. + +| | Waarde attribuut "relatie"| Beschrijving | Inverse | Read-only | +| --- | --- | --- | --- | --- | +| 1 | `is_een_geanonimiseerde_variant_van` | Informatieobject A is een geanonimiseerde variant van informatieobject B. | 3 | Nee | +| 2 | `is_een_vervanger_van` | Informatieobject A is een vervanger van informatieobject B. | 4 | Nee | +| 3 | `heeft_als_geanonimiseerde_variant` | Informatieobject A heeft als geanonimiseerde variant informatieobject B. | 1 | Ja | +| 4 | `is_vervangen_door` | Informatieobject A is vervangen door informatieobject B | 2 | Ja | + +In de toekomst kan deze tabel eventueel worden uitgebreid met nieuwe waarden als daar behoefte aan is. + +In het volgende voorbeeld leggen we vast dat `` een geanonimiseerde variant is van ``. + +`POST /informatieobjectenrelaties` + +```text +{ + "informatieobjectA": "", + "informatieobjectB": "", + "relatie": "is_een_geanonimiseerde_variant_van" +} +``` + +De notatie `` staat voor de de URL-referentie naar het informatieobject `doc`. + +Deze relatie wordt als conveniance ook zichtbaar gemaakt in de resource `/enkelvoudiginformatieobject`: + +`GET /enkelvoudiginformatieobjecten/<>` + +```text +{ + ..., + "gerelateerdeInformatieobjecten": [ + { + "informatieobject": "", + "rol": "is_een_geanonimiseerde_versie_van" + } + ], +} +``` + +De notatie `<>` staat voor de uuid van het informatieobject `doc`. + +`GET /enkelvoudiginformatieobjecten/<>` + +```text +{ + ..., + "gerelateerdeInformatieobjecten": [ + { + "informatieobject": "", + "relatie": "heeft_als_geanonimiseerde_variant" + } + ], +} +``` + +Samenvattend zijn dit de verschillen: + +- In het informatiemodel is het objecttype INFORMATIEOBJECT hernoemd naar ENKELVOUDIGINFORMATIEOBJECT voor consistentie met het RGBZ. +- Attribuut "aardRelatie" in het informatiemodel is hernoemd naar "relatie". +- De relatie "heeft relevante andere" in het informatiemodel is henoemd naar "heeft gerelateerd". +- We maken expliciet gebruik van inverse relaties in plaats van het attribuut "richtingRelatie" om de richting van de relatie aan te duiden. +- In de resource `/informatieobjectenrelaties` is het attribuut "informatieobject" hernoemd naar "informatieobjectA" en het attribuut "relevantAnderInformatieobject" hernoemd naar "informatieobjectB". +- De relatie `heeft_als_publiceerbare_variant` is hernoemd naar de (inverse) relaties `is_een_geanonimiseerde_variant_van` en `heeft_als_geanonimiseerde_variant`. +- De (inverse) relaties `is_een_vervanger_van` en `is_vervangen_door` zijn toegevoegd. +- De relatie `ongespecificeerd` is verwijderd om wildgroei te voorkomen. + diff --git a/api-specificatie/ztc/current_version/test.txt b/api-specificatie/ztc/current_version/test.txt new file mode 100644 index 000000000..94d27e26d --- /dev/null +++ b/api-specificatie/ztc/current_version/test.txt @@ -0,0 +1 @@ +daadsadassada \ No newline at end of file diff --git a/api-specificatie/ztc/current_version/test2.txt b/api-specificatie/ztc/current_version/test2.txt new file mode 100644 index 000000000..e69de29bb diff --git a/api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml b/api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml new file mode 100644 index 000000000..0ca9611a3 --- /dev/null +++ b/api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml @@ -0,0 +1,15581 @@ +openapi: 3.0.3 +info: + title: Catalogi API + version: 1.3.2 + description: + "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ + \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ + \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ + \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ + \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ + wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ + Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ + \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ + \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ + \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ + \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ + \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ + \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ + \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ + \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ + \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ + user_id\": \"\",\n \"user_representation\": \"\"\ + \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ + \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ + \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ + vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ + \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ + \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ + \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ + \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ + \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\ + \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\ + \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\ + Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ + \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ + \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ + \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /besluittypen: + get: + operationId: besluittype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle BESLUITTYPEn opvragen. + parameters: + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + schema: + type: string + format: uri + - name: zaaktypen + required: false + in: query + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + schema: + type: string + - name: informatieobjecttypen + required: false + in: query + description: + Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten + van dit BESLUITTYPE worden vastgelegd. + schema: + type: string + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - besluittypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedBesluitTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: besluittype_create + description: Maak een BESLUITTYPE aan. + summary: Maak een BESLUITTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitTypeCreate' + required: true + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /besluittypen/{uuid}: + get: + operationId: besluittype_retrieve + description: Een specifieke BESLUITTYPE opvragen. + summary: Een specifieke BESLUITTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - besluittypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: besluittype_update + description: + Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het + een concept betreft. + summary: Werk een BESLUITTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitTypeUpdate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: besluittype_partial_update + description: + Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept + betreft. + summary: Werk een BESLUITTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: besluittype_destroy + description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft. + summary: Verwijder een BESLUITTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - besluittypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: besluittype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - besluittypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /besluittypen/{uuid}/publish: + post: + operationId: besluittype_publish + description: + Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten + API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke + wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet + worden, dan moet je een nieuwe versie aanmaken. + summary: Publiceer het concept BESLUITTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /catalogussen: + get: + operationId: catalogus_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle CATALOGUSsen opvragen. + parameters: + - name: domein + required: false + in: query + description: domein + schema: + type: string + - name: domein__in + required: false + in: query + description: domein__in + schema: + type: string + - name: rsin + required: false + in: query + description: rsin + schema: + type: string + - name: rsin__in + required: false + in: query + description: rsin__in + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - catalogussen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCatalogusList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: catalogus_create + description: Maak een CATALOGUS aan. + summary: Maak een CATALOGUS aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - catalogussen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Catalogus' + required: true + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Catalogus' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /catalogussen/{uuid}: + get: + operationId: catalogus_retrieve + description: Een specifieke CATALOGUS opvragen. + summary: Een specifieke CATALOGUS opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - catalogussen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogusExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: catalogus_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) CATALOGUS opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - catalogussen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /eigenschappen: + get: + operationId: eigenschap_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle EIGENSCHAPpen opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - eigenschappen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEigenschapList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: eigenschap_create + description: + Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Maak een EIGENSCHAP aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - eigenschappen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /eigenschappen/{uuid}: + get: + operationId: eigenschap_retrieve + description: Een specifieke EIGENSCHAP opvragen. + summary: Een specifieke EIGENSCHAP opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - eigenschappen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/EigenschapExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: eigenschap_update + description: + Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het + bijbehorende ZAAKTYPE een concept betreft. + summary: Werk een EIGENSCHAP in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - eigenschappen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: eigenschap_partial_update + description: + Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Werk een EIGENSCHAP deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - eigenschappen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedEigenschap' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: eigenschap_destroy + description: + Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Verwijder een EIGENSCHAP. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - eigenschappen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: eigenschap_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - eigenschappen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /informatieobjecttypen: + get: + operationId: informatieobjecttype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle INFORMATIEOBJECTTYPEn opvragen. + parameters: + - name: catalogus + required: false + in: query + description: + URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + schema: + type: string + format: uri + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInformatieObjectTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: informatieobjecttype_create + description: Maak een INFORMATIEOBJECTTYPE aan. + summary: Maak een INFORMATIEOBJECTTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /informatieobjecttypen/{uuid}: + get: + operationId: informatieobjecttype_retrieve + description: Een specifieke INFORMATIEOBJECTTYPE opvragen. + summary: Een specifieke INFORMATIEOBJECTTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: informatieobjecttype_update + description: + Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen + als het een concept betreft. + summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: informatieobjecttype_partial_update + description: + Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het + een concept betreft. + summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: informatieobjecttype_destroy + description: + Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een + concept betreft. + summary: Verwijder een INFORMATIEOBJECTTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: informatieobjecttype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - informatieobjecttypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /informatieobjecttypen/{uuid}/publish: + post: + operationId: informatieobjecttype_publish + description: + Publiceren van het informatieobjecttype zorgt ervoor dat dit in + een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype + zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren + nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. + summary: Publiceer het concept INFORMATIEOBJECTTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/InformatieObjectType' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaattypen: + get: + operationId: resultaattype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle RESULTAATTYPEn opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: zaaktype + schema: + type: string + - name: zaaktype_identificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: status + schema: + type: string + - name: datum_geldigheid + required: false + in: query + description: datum_geldigheid + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - resultaattypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResultaatTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: resultaattype_create + description: + Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Maak een RESULTAATTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - resultaattypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeCreate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaattypen/{uuid}: + get: + operationId: resultaattype_retrieve + description: Een specifieke RESULTAATTYPE opvragen. + summary: Een specifieke RESULTAATTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaattypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: resultaattype_update + description: + Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het + bijbehorende ZAAKTYPE een concept betreft. + summary: Werk een RESULTAATTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - resultaattypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeCreate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeUpdate' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: resultaattype_partial_update + description: + Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Werk een RESULTAATTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - resultaattypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedResultaatType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: resultaattype_destroy + description: + Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Verwijder een RESULTAATTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - resultaattypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: resultaattype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaattypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /roltypen: + get: + operationId: roltype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ROLTYPEn opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: omschrijvingGeneriek + required: false + in: query + description: Algemeen gehanteerde omschrijving van de aard van de ROL. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - roltypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRolTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: roltype_create + description: + Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Maak een ROLTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - roltypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /roltypen/{uuid}: + get: + operationId: roltype_retrieve + description: Een specifieke ROLTYPE opvragen. + summary: Een specifieke ROLTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - roltypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: roltype_update + description: + Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een + concept betreft. + summary: Werk een ROLTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - roltypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: roltype_partial_update + description: + Werk een ROLTYPE deels bij. Dit kan alleen als het een concept + betreft. + summary: Werk een ROLTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - roltypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRolType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: roltype_destroy + description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft. + summary: Verwijder een ROLTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + tags: + - roltypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: roltype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ROLTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - roltypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /statustypen: + get: + operationId: statustype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle STATUSTYPEn opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - statustypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedStatusTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: statustype_create + description: + Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Maak een STATUSTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - statustypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /statustypen/{uuid}: + get: + operationId: statustype_retrieve + description: Een specifieke STATUSTYPE opvragen. + summary: Een specifieke STATUSTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statustypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: statustype_update + description: + Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het + bijbehorende ZAAKTYPE een concept betreft. + summary: Werk een STATUSTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - statustypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: statustype_partial_update + description: + Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Werk een STATUSTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - statustypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedStatusType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: statustype_destroy + description: + Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Verwijder een STATUSTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - statustypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: statustype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statustypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakobjecttypen: + get: + operationId: zaakobjecttype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKOBJECTTYPEn opvragen. + parameters: + - name: anderObjecttype + required: false + in: query + description: + Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + schema: + type: string + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. + schema: + type: string + format: uri + - name: datumBeginGeldigheid + required: false + in: query + description: De datum waarop het is ontstaan. + schema: + type: string + - name: datumEindeGeldigheid + required: false + in: query + description: De datum waarop het is opgeheven. + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: objecttype + required: false + in: query + description: + URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + schema: + type: string + format: uri + - name: relatieOmschrijving + required: false + in: query + description: + Omschrijving van de betrekking van het Objecttype op zaken van + het gerelateerde ZAAKTYPE. + schema: + type: string + - name: zaaktype + required: false + in: query + description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaakobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakObjectTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakobjecttype_create + description: Maak een ZAAKOBJECTTYPE aan. + summary: Maak een ZAAKOBJECTTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakobjecttypen/{uuid}: + get: + operationId: zaakobjecttype_retrieve + description: Een specifieke ZAAKOBJECTTYPE opvragen. + summary: Een specifieke ZAAKOBJECTTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakobjecttype_update + description: Werk een ZAAKOBJECTTYPE in zijn geheel bij. + summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakobjecttype_partial_update + description: Werk een ZAAKOBJECTTYPE deels bij. + summary: Werk een ZAAKOBJECTTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakObjectType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakobjecttype_destroy + description: Verwijder een ZAAKOBJECTTYPE. + summary: Verwijder een ZAAKOBJECTTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakobjecttypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakobjecttype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecttypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaaktype-informatieobjecttypen: + get: + operationId: zaakinformatieobjecttype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE. + schema: + type: string + format: uri + - name: informatieobjecttype + required: false + in: query + description: informatieobjecttype + schema: + type: string + - name: richting + required: false + in: query + description: + Aanduiding van de richting van informatieobjecten van het gerelateerde + INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + schema: + type: string + enum: + - inkomend + - intern + - uitgaand + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaaktype-informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakTypeInformatieObjectTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakinformatieobjecttype_create + description: + 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen + als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: + + - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`' + summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktype-informatieobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaaktype-informatieobjecttypen/{uuid}: + get: + operationId: zaakinformatieobjecttype_retrieve + description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. + summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaaktype-informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakinformatieobjecttype_update + description: + "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\ + \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\ + \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\ + \ dezelfde `catalogus`" + summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktype-informatieobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakinformatieobjecttype_partial_update + description: + "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\ + \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\ + \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ + \ `catalogus`" + summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktype-informatieobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakinformatieobjecttype_destroy + description: + "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\ + \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\ + \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" + summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaaktype-informatieobjecttypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakinformatieobjecttype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaaktype-informatieobjecttypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaaktypen: + get: + operationId: zaaktype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKTYPEn opvragen. + parameters: + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + schema: + type: string + format: uri + - name: identificatie + required: false + in: query + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + style: form + explode: false + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaaktypen + security: + - JWT-Claims: + - (catalogi.lezen | documenten.lezen | zaken.lezen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaaktype_create + description: + "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\ + \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `zaaktypeidentificatie`.\ + \ Dezelfde zaaktypeidentificatie mag enkel opnieuw gebruikt worden als het zaaktype\ + \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\ + \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE." + summary: Maak een ZAAKTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeCreate' + required: true + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaaktypen/{uuid}: + get: + operationId: zaaktype_retrieve + description: Een specifieke ZAAKTYPE opvragen. + summary: Een specifieke ZAAKTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: datumGeldigheid + schema: + type: string + description: + filter op datumGeldigheid voor het zelf en alle onderliggende + objecten + tags: + - zaaktypen + security: + - JWT-Claims: + - (catalogi.lezen | documenten.lezen | zaken.lezen) + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaaktype_update + description: + "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\ + \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\ + \ dezelfde catalogus behoren als het ZAAKTYPE." + summary: Werk een ZAAKTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeUpdate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaaktype_partial_update + description: + "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\ + \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\ + \ catalogus behoren als het ZAAKTYPE." + summary: Werk een ZAAKTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaaktype_destroy + description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft. + summary: Verwijder een ZAAKTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaaktypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaaktype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaaktypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaaktypen/{uuid}/publish: + post: + operationId: zaaktype_publish + description: + Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API + kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke + wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc. + Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een + nieuwe versieaanmaken. + summary: Publiceer het concept ZAAKTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - vervolg + - bijdrage + - onderwerp + type: string + AfleidingswijzeEnum: + enum: + - afgehandeld + - ander_datumkenmerk + - eigenschap + - gerelateerde_zaak + - hoofdzaak + - ingangsdatum_besluit + - termijn + - vervaldatum_besluit + - zaakobject + type: string + ArchiefnominatieEnum: + enum: + - blijvend_bewaren + - vernietigen + type: string + BesluitType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: + Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: + De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + description: + URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: + Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BesluitTypeExpanded: + allOf: + - $ref: '#/components/schemas/BesluitType' + - properties: + _expand: + $ref: '#/components/schemas/BesluitTypeEmbedded' + BesluitTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + EmptyObject: + type: object + description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. + example: {} + BesluitTypeCreate: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: + Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: + De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatieobjecttypen + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: + Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BesluitTypeUpdate: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: + Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: + De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatieobjecttypen + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: + Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BlankEnum: + enum: + - '' + BronCatalogus: + type: object + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + properties: + url: + type: string + format: uri + title: URL-referentie broncatalogus + maxLength: 200 + domein: + type: string + description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus domein + maxLength: 5 + rsin: + type: string + description: + Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder + is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus rsin + maxLength: 9 + required: + - domein + - rsin + - url + BronZaaktype: + type: object + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + properties: + url: + type: string + format: uri + title: URL-referentie bronzaaktype + maxLength: 200 + identificatie: + type: string + description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. + title: bronzaaktype identificatie + maxLength: 50 + omschrijving: + type: string + description: + De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd + in de Broncatalogus. + title: bronzaaktype omschrijving + maxLength: 80 + required: + - identificatie + - omschrijving + - url + BrondatumArchiefprocedure: + type: object + description: + Specificatie voor het bepalen van de brondatum voor de start van + de Archiefactietermijn (=brondatum) van het zaakdossier. + properties: + afleidingswijze: + allOf: + - $ref: '#/components/schemas/AfleidingswijzeEnum' + title: Afleidingswijze brondatum + description: + "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ + \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ + \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ + \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ + \ in een ander datumveld dan de datumvelden waarop de overige waarden\ + \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ + \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ + \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ + \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ + \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ + * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ + \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ + \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ + * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ + \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ + \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ + \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ + \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ + \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ + \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ + \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ + \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ + \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ + \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ + \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ + \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ + \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ + \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ + \ van het zaakobjecttype het betreft." + datumkenmerk: + type: string + description: + Naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. + title: datumkenmerk + maxLength: 80 + einddatumBekend: + type: boolean + description: + Indicatie dat de einddatum van het procesobject gedurende de + uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend + is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten + worden. + title: einddatum bekend + objecttype: + description: + 'Het soort object in de registratie dat het procesobject representeert. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: objecttype + oneOf: + - $ref: '#/components/schemas/ObjecttypeEnum' + - $ref: '#/components/schemas/BlankEnum' + registratie: + type: string + description: + De naam van de registratie waarvan het procesobject deel uit + maakt. + title: registratie + maxLength: 80 + procestermijn: + type: string + nullable: true + title: Brondatum procestermijn + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' + is. + format: duration + required: + - afleidingswijze + nullable: true + Catalogus: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + domein: + type: string + description: + Een afkorting waarmee wordt aangegeven voor welk domein in + een CATALOGUS ZAAKTYPEn zijn uitgewerkt. + title: domein + maxLength: 5 + rsin: + type: string + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. + title: rsin + maxLength: 9 + contactpersoonBeheerNaam: + type: string + title: Naam contactpersoon + description: + De naam van de contactpersoon die verantwoordelijk is voor + het beheer van de CATALOGUS. + maxLength: 40 + contactpersoonBeheerTelefoonnummer: + type: string + title: Telefoonnummer + description: + Het telefoonnummer van de contactpersoon die verantwoordelijk + is voor het beheer van de CATALOGUS. + maxLength: 20 + contactpersoonBeheerEmailadres: + type: string + format: email + title: Emailadres + description: + Het emailadres van de contactpersoon die verantwoordelijk is + voor het beheer van de CATALOGUS. + maxLength: 254 + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden + ontsloten. + title: Catalogus + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden + ontsloten. + title: catalogus + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS + worden ontsloten. + title: Catalogus + uniqueItems: true + naam: + type: string + nullable: true + description: De benaming die is gegeven aan de zaaktypecatalogus. + title: naam + maxLength: 200 + versie: + type: string + nullable: true + description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. + title: versie + maxLength: 20 + begindatumVersie: + type: string + format: date + nullable: true + description: + Datum waarop de versie van de zaaktypecatalogus van toepassing + is geworden. + title: begindatum versie + required: + - besluittypen + - contactpersoonBeheerNaam + - domein + - informatieobjecttypen + - rsin + - url + - zaaktypen + CatalogusExpanded: + allOf: + - $ref: '#/components/schemas/Catalogus' + - properties: + _expand: + $ref: '#/components/schemas/CatalogusEmbedded' + CatalogusEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + CheckListItem: + type: object + properties: + itemnaam: + type: string + description: De betekenisvolle benaming van het checklistitem + title: itemnaam + maxLength: 30 + toelichting: + type: string + nullable: true + description: + Beschrijving van de overwegingen bij het controleren van het + aandachtspunt + title: toelichting + maxLength: 1000 + vraagstelling: + type: string + description: + Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt + gecontroleerd moet worden. + title: vraagstelling + maxLength: 255 + verplicht: + type: boolean + description: + Het al dan niet verplicht zijn van controle van het aandachtspunt + voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. + title: verplicht + required: + - itemnaam + - vraagstelling + Eigenschap: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + naam: + type: string + description: De naam van de EIGENSCHAP + title: eigenschapnaam + maxLength: 20 + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + definitie: + type: string + description: De beschrijving van de betekenis van deze EIGENSCHAP + title: definitie + maxLength: 255 + specificatie: + allOf: + - $ref: '#/components/schemas/EigenschapSpecificatie' + title: specificatie van eigenschap + toelichting: + type: string + description: + Een toelichting op deze EIGENSCHAP en het belang hiervan voor + zaken van dit ZAAKTYPE. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + een STATUS van het STATUSTYPE kan worden gezet. + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - catalogus + - definitie + - naam + - specificatie + - url + - zaaktype + - zaaktypeIdentificatie + EigenschapExpanded: + allOf: + - $ref: '#/components/schemas/Eigenschap' + - properties: + _expand: + $ref: '#/components/schemas/EigenschapEmbedded' + EigenschapEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustype: + oneOf: + - $ref: '#/components/schemas/StatusTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + EigenschapSpecificatie: + type: object + properties: + groep: + type: string + description: + Benaming van het object of groepattribuut waarvan de EIGENSCHAP + een inhoudelijk gegeven specificeert. + title: groep + maxLength: 32 + formaat: + allOf: + - $ref: '#/components/schemas/FormaatEnum' + description: + 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen + worden vastgelegd. + + + Uitleg bij mogelijke waarden: + + + * `tekst` - Tekst + + * `getal` - Getal + + * `datum` - Datum + + * `datum_tijd` - Datum/tijd' + title: formaat + lengte: + type: string + description: + Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP + worden vastgelegd. + title: lengte + maxLength: 14 + kardinaliteit: + type: string + description: + Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP + bij een zaak van het ZAAKTYPE. + title: kardinaliteit + maxLength: 3 + waardenverzameling: + type: array + items: + type: string + maxLength: 100 + description: Waarden die deze EIGENSCHAP kan hebben. + title: waardenverzameling + required: + - formaat + - kardinaliteit + - lengte + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + FormaatEnum: + enum: + - tekst + - getal + - datum + - datum_tijd + type: string + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + IndicatieInternOfExternEnum: + enum: + - intern + - extern + type: string + InformatieObjectType: + type: object + description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: + URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + title: Catalogus + omschrijving: + type: string + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: omschrijving + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE + voor de openbaarheid bestemd zijn. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + zaaktypen: + type: string + readOnly: true + title: zaaktypen + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + informatieobjectcategorie: + type: string + title: Categorie + description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + maxLength: 80 + trefwoord: + type: array + items: + type: string + maxLength: 30 + description: + Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE + kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar + te onderscheiden.) + title: trefwoord + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' + title: omschrijving generiek + required: + - beginGeldigheid + - besluittypen + - catalogus + - concept + - informatieobjectcategorie + - omschrijving + - url + - vertrouwelijkheidaanduiding + - zaaktypen + InformatieObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/InformatieObjectType' + - properties: + _expand: + $ref: '#/components/schemas/InformatieObjectTypeEmbedded' + InformatieObjectTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + InformatieObjectTypeOmschrijvingGeneriek: + type: object + properties: + informatieobjecttypeOmschrijvingGeneriek: + type: string + description: Algemeen gehanteerde omschrijving van het type informatieobject. + title: informatieobjecttype omschrijving generiek + maxLength: 80 + definitieInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Definitie + description: Nauwkeurige beschrijving van het generieke type informatieobject + maxLength: 255 + herkomstInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Herkomst + description: + De naam van de waardenverzameling, of van de beherende organisatie + daarvan, waaruit de waarde is overgenomen. + maxLength: 12 + hierarchieInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Hierarchie + description: De plaats in de rangorde van het informatieobjecttype. + maxLength: 80 + opmerkingInformatieobjecttypeOmschrijvingGeneriek: + type: string + nullable: true + title: Opmerking + description: Zinvolle toelichting bij het informatieobjecttype + maxLength: 255 + required: + - definitieInformatieobjecttypeOmschrijvingGeneriek + - herkomstInformatieobjecttypeOmschrijvingGeneriek + - hierarchieInformatieobjecttypeOmschrijvingGeneriek + - informatieobjecttypeOmschrijvingGeneriek + ObjecttypeEnum: + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + type: string + OmschrijvingGeneriekEnum: + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + type: string + PaginatedBesluitTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/BesluitType' + PaginatedCatalogusList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Catalogus' + PaginatedEigenschapList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Eigenschap' + PaginatedResultaatTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ResultaatType' + PaginatedInformatieObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/InformatieObjectType' + PaginatedRolTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/RolType' + PaginatedStatusTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/StatusType' + PaginatedZaakObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakObjectType' + PaginatedZaakTypeInformatieObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + PaginatedZaakTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakType' + PatchedEigenschap: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + naam: + type: string + description: De naam van de EIGENSCHAP + title: eigenschapnaam + maxLength: 20 + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + definitie: + type: string + description: De beschrijving van de betekenis van deze EIGENSCHAP + title: definitie + maxLength: 255 + specificatie: + allOf: + - $ref: '#/components/schemas/EigenschapSpecificatie' + title: specificatie van eigenschap + toelichting: + type: string + description: + Een toelichting op deze EIGENSCHAP en het belang hiervan voor + zaken van dit ZAAKTYPE. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + een STATUS van het STATUSTYPE kan worden gezet. + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedResultaatType: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + title: is resultaat van + uniqueItems: true + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + PatchedRolType: + type: object + description: Adds nested create feature + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + omschrijving: + type: string + description: Omschrijving van de aard van de ROL. + title: omschrijving + maxLength: 100 + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' + description: + "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ + \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ + \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ + \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ + \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ + \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ + \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ + \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ + \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ + \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ + \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ + \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ + \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" + title: omschrijving generiek + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedStatusType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + omschrijving: + type: string + description: + Een korte, voor de initiator van de zaak relevante, omschrijving + van de aard van de STATUS van zaken van een ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van STATUSsen + van het STATUSTYPE + title: omschrijving generiek + maxLength: 80 + statustekst: + type: string + description: + De tekst die wordt gebruikt om de Initiator te informeren over + het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende + ZAAKTYPE. + title: statustekst + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + title: Zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + volgnummer: + type: integer + maximum: 9999 + minimum: 1 + description: + Een volgnummer voor statussen van het STATUSTYPE binnen een + zaak. + title: statustypevolgnummer + isEindstatus: + type: boolean + readOnly: true + description: + Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven + is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. + title: isEindstatus + informeren: + type: boolean + description: + "Aanduiding die aangeeft of na het zetten van een STATUS van\ + \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." + title: informeren + doorlooptijd: + type: string + nullable: true + description: + De door de zaakbehandelende organisatie(s) gestelde norm voor + de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij + het desbetreffende ZAAKTYPE. + title: doorlooptijd status + format: duration + toelichting: + type: string + nullable: true + description: Een eventuele toelichting op dit STATUSTYPE. + title: toelichting + maxLength: 1000 + checklistitemStatustype: + type: array + items: + $ref: '#/components/schemas/CheckListItem' + title: checklistitem + eigenschappen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, + voordat een STATUS van dit STATUSTYPE kan worden gezet. + title: eigenschappen + uniqueItems: true + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedZaakObjectType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + anderObjecttype: + type: boolean + description: + Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + title: Ander objecttype + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + objecttype: + type: string + format: uri + description: + URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Objecttype + maxLength: 200 + relatieOmschrijving: + type: string + description: + Omschrijving van de betrekking van het Objecttype op zaken + van het gerelateerde ZAAKTYPE. + title: Relatie omschrijving + maxLength: 80 + zaaktype: + type: string + format: uri + description: + URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de RESULTAATTYPEN. + title: Zaakobjecttypen + uniqueItems: true + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de STATUSTYPEN. + title: Zaakobjecttypen + uniqueItems: true + catalogus: + type: string + format: uri + description: + URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE + behoort. + title: Catalogus + PatchedZaakTypeInformatieObjectType: + type: object + description: 'Represent a ZaakTypeInformatieObjectType. + + + Relatie met informatieobjecttype dat relevant is voor zaaktype.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + informatieobjecttype: + type: string + title: informatieobjecttype + maxLength: 100 + volgnummer: + type: integer + maximum: 999 + minimum: 1 + description: + Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: + 'Aanduiding van de richting van informatieobjecten van het + gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + + Uitleg bij mogelijke waarden: + + + * `inkomend` - Inkomend + + * `intern` - Intern + + * `uitgaand` - Uitgaand' + title: richting + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. + ReferentieProces: + type: object + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + properties: + naam: + type: string + title: Referentieprocesnaam + description: De naam van het Referentieproces. + maxLength: 80 + link: + type: string + format: uri + title: Referentieproceslink + description: De URL naar de beschrijving van het Referentieproces + maxLength: 200 + required: + - naam + ResultaatType: + type: object + description: 'Set gegevensgroepdata from validated nested data. + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + title: is resultaat van + uniqueItems: true + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + ResultaatTypeExpanded: + allOf: + - $ref: '#/components/schemas/ResultaatType' + - properties: + _expand: + $ref: '#/components/schemas/ResultaatTypeEmbedded' + ResultaatTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + ResultaatTypeCreate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + title: '' + title: besluittypen + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + ResultaatTypeUpdate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + title: '' + title: besluittypen + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + RichtingEnum: + enum: + - inkomend + - intern + - uitgaand + type: string + RolType: + type: object + description: Adds nested create feature + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + omschrijving: + type: string + description: Omschrijving van de aard van de ROL. + title: omschrijving + maxLength: 100 + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' + description: + "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ + \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ + \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ + \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ + \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ + \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ + \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ + \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ + \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ + \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ + \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ + \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ + \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" + title: omschrijving generiek + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - omschrijving + - omschrijvingGeneriek + - url + - zaaktype + - zaaktypeIdentificatie + RolTypeExpanded: + allOf: + - $ref: '#/components/schemas/RolType' + - properties: + _expand: + $ref: '#/components/schemas/RolTypeEmbedded' + RolTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + StatusType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + omschrijving: + type: string + description: + Een korte, voor de initiator van de zaak relevante, omschrijving + van de aard van de STATUS van zaken van een ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van STATUSsen + van het STATUSTYPE + title: omschrijving generiek + maxLength: 80 + statustekst: + type: string + description: + De tekst die wordt gebruikt om de Initiator te informeren over + het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende + ZAAKTYPE. + title: statustekst + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + title: Zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + volgnummer: + type: integer + maximum: 9999 + minimum: 1 + description: + Een volgnummer voor statussen van het STATUSTYPE binnen een + zaak. + title: statustypevolgnummer + isEindstatus: + type: boolean + readOnly: true + description: + Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven + is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. + title: isEindstatus + informeren: + type: boolean + description: + "Aanduiding die aangeeft of na het zetten van een STATUS van\ + \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." + title: informeren + doorlooptijd: + type: string + nullable: true + description: + De door de zaakbehandelende organisatie(s) gestelde norm voor + de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij + het desbetreffende ZAAKTYPE. + title: doorlooptijd status + format: duration + toelichting: + type: string + nullable: true + description: Een eventuele toelichting op dit STATUSTYPE. + title: toelichting + maxLength: 1000 + checklistitemStatustype: + type: array + items: + $ref: '#/components/schemas/CheckListItem' + title: checklistitem + eigenschappen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, + voordat een STATUS van dit STATUSTYPE kan worden gezet. + title: eigenschappen + uniqueItems: true + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - catalogus + - isEindstatus + - omschrijving + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + StatusTypeExpanded: + allOf: + - $ref: '#/components/schemas/StatusType' + - properties: + _expand: + $ref: '#/components/schemas/StatusTypeEmbedded' + StatusTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + eigenschappen: + type: array + items: + $ref: '#/components/schemas/EigenschapExpanded' + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + ZaakObjectType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + anderObjecttype: + type: boolean + description: + Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + title: Ander objecttype + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + objecttype: + type: string + format: uri + description: + URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Objecttype + maxLength: 200 + relatieOmschrijving: + type: string + description: + Omschrijving van de betrekking van het Objecttype op zaken + van het gerelateerde ZAAKTYPE. + title: Relatie omschrijving + maxLength: 80 + zaaktype: + type: string + format: uri + description: + URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de RESULTAATTYPEN. + title: Zaakobjecttypen + uniqueItems: true + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de STATUSTYPEN. + title: Zaakobjecttypen + uniqueItems: true + catalogus: + type: string + format: uri + description: + URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE + behoort. + title: Catalogus + required: + - anderObjecttype + - beginGeldigheid + - catalogus + - objecttype + - relatieOmschrijving + - resultaattypen + - statustypen + - url + - zaaktype + - zaaktypeIdentificatie + ZaakObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakObjectTypeEmbedded' + ZaakObjectTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + statustypen: + type: array + items: + $ref: '#/components/schemas/StatusTypeExpanded' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + ZaakType: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van + dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het + aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde + gezet. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + doel: + type: string + description: + Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: + Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: + Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: + "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ + \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ + \ beide sprake kan zijn, dan prevaleert de externe initiatie." + title: indicatie intern of extern + handelingInitiator: + type: string + description: + Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: + "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: + Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: + De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: + De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: + Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: + Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: + Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: + Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: + URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: + De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: string + readOnly: true + title: informatieobjecttypen + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: heeft relevante besluittypen + title: heeft relevante besluittypen + description: + URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + uniqueItems: true + deelzaaktypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen + bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + uniqueItems: true + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatie' + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: + De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + required: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakTypeEmbedded' + ZaakTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaakobjecttypen: + type: array + items: + $ref: '#/components/schemas/ZaakObjectTypeExpanded' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustypen: + type: array + items: + $ref: '#/components/schemas/StatusTypeExpanded' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + eigenschappen: + type: array + items: + $ref: '#/components/schemas/EigenschapExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + roltypen: + type: array + items: + $ref: '#/components/schemas/RolTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + deelzaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + ZaakTypeCreate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van + dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het + aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde + gezet. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + doel: + type: string + description: + Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: + Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: + Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: + "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ + \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ + \ beide sprake kan zijn, dan prevaleert de externe initiatie." + title: indicatie intern of extern + handelingInitiator: + type: string + description: + Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: + "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: + Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: + De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: + De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: + Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: + Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: + Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: + Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: + URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: + De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: string + readOnly: true + title: informatieobjecttypen + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE.' + title: zaaktypen + deelzaaktypen: + type: array + items: + type: string + title: '' + description: + De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatieCreate' + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: + De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + required: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypeInformatieObjectType: + type: object + description: 'Represent a ZaakTypeInformatieObjectType. + + + Relatie met informatieobjecttype dat relevant is voor zaaktype.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + informatieobjecttype: + type: string + title: informatieobjecttype + maxLength: 100 + volgnummer: + type: integer + maximum: 999 + minimum: 1 + description: + Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: + 'Aanduiding van de richting van informatieobjecten van het + gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + + Uitleg bij mogelijke waarden: + + + * `inkomend` - Inkomend + + * `intern` - Intern + + * `uitgaand` - Uitgaand' + title: richting + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. + required: + - catalogus + - informatieobjecttype + - richting + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + ZaakTypeInformatieObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' + ZaakTypeInformatieObjectTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + informatieobjecttype: + oneOf: + - $ref: '#/components/schemas/InformatieObjectTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustype: + oneOf: + - $ref: '#/components/schemas/StatusTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + ZaakTypeUpdate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van + dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het + aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde + gezet. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + doel: + type: string + description: + Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: + Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: + Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: + "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ + \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ + \ beide sprake kan zijn, dan prevaleert de externe initiatie." + title: indicatie intern of extern + handelingInitiator: + type: string + description: + Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: + "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: + Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: + De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: + De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: + Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: + Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: + Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: + Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: + URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: + De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: string + readOnly: true + title: informatieobjecttypen + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE.' + title: zaaktypen + deelzaaktypen: + type: array + items: + type: string + title: '' + description: + De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatieCreate' + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: + De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + required: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + + ZaakTypenRelatie: + type: object + properties: + zaaktype: + type: string + format: uri + description: + URL referentie naar het gerelateerde zaaktype, mogelijks in + een extern ZTC. + title: gerelateerd zaaktype + maxLength: 200 + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Omschrijving van de aard van de relatie van zaken van het + ZAAKTYPE tot zaken van het andere ZAAKTYPE + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - Vervolg + + * `bijdrage` - Bijdrage + + * `onderwerp` - Onderwerp' + title: aard relatie + toelichting: + type: string + description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. + title: toelichting + maxLength: 255 + required: + - aardRelatie + - zaaktype + ZaakTypenRelatieCreate: + type: object + properties: + zaaktype: + type: string + description: '`zaaktype.identificatie` naar het ZAAKTYPE.' + title: zaaktype van + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Omschrijving van de aard van de relatie van zaken van het + ZAAKTYPE tot zaken van het andere ZAAKTYPE + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - Vervolg + + * `bijdrage` - Bijdrage + + * `onderwerp` - Onderwerp' + title: aard relatie + toelichting: + type: string + description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. + title: toelichting + maxLength: 255 + required: + - aardRelatie + - zaaktype + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + # Added by API Auto Mocking Plugin + - description: SwaggerHub API Auto Mocking + url: https://virtserver.swaggerhub.com/michielverhoef/Catalogussen_API/1.3.0 + - url: https://catalogi-api.vng.cloud/api/v1 + description: Productie Omgeving +tags: + - name: besluittypen + description: + Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten + API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het + zaakgericht werken van de behandelende organisatie(s). + - name: catalogussen + description: + "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\ + \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\ + \ beheerd wordt." + - name: eigenschappen + description: + Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant + inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen + worden en geen standaard kenmerk is van een zaak. + - name: informatieobjecttypen + description: + Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen + in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van + een document of ander object dat informatie bevat. + - name: resultaattypen + description: + Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft + de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar + hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. + - name: roltypen + description: + Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding + van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. + - name: statustypen + description: + Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding + van de aard van een status. + - name: zaakobjecttypen + description: + "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\ + \ - `zaaktype` behoort tot dezelfde `catalogus`" + - name: zaaktype-informatieobjecttypen + description: + Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft + aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting + is. + - name: zaaktypen + description: + Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een + ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van + eenzelfde soort. \ No newline at end of file From f6e576974f5e07740650fe18a98cb48bb9990b71 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 16:37:33 +0100 Subject: [PATCH 02/17] Nieuwe statusvelden toegevoegd --- api-specificatie/drc/1.5.x/1.5.0/openapi.yaml | 8674 +++++++++++++++++ .../drc/current_version/openapi.yaml | 371 +- 2 files changed, 8978 insertions(+), 67 deletions(-) create mode 100644 api-specificatie/drc/1.5.x/1.5.0/openapi.yaml diff --git a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml new file mode 100644 index 000000000..bdb2de201 --- /dev/null +++ b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml @@ -0,0 +1,8674 @@ +openapi: 3.0.3 +info: + title: Documenten API + version: 1.5.0 + description: > + Een API om een documentregistratiecomponent (DRC) te benaderen. + + + In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. + Een + + INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. + + INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten + worden + + gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben. + + + GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het + INFORMATIEOBJECT + + (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API + gevalideerd + + of gehandhaafd. + + + De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht + in + + de vorm van INFORMATIEOBJECTTYPEn. + + + **Uploaden van bestanden** + + + Binnen deze API bestaan een aantal endpoints die binaire data ontvangen, al + + dan niet base64-encoded. Webservers moeten op deze endpoints een minimale + + request body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de + + metadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de + + overhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit + + betekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot + + mag zijn. + + + _Nieuw in 1.1.0_ + + + Bestanden kunnen groter zijn dan de minimale die door providers + + ondersteund moet worden. De consumer moet dan: + + + 1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale + bestandsgrootte + meegestuurd wordt en de inhoud leeggelaten wordt. + De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer + en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT. + 2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben + zoals dit aangegeven werd in de response bij 1. + 3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige + BESTANDSDEEL-url gestuurd worden, samen met het lock ID. + 4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat + alle + bestandsdelen correct opgestuurd werden, en voegt deze samen tot het + resulterende bestand. + + Het bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop. + + + De 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden + die + + niet gesplitst hoeven te worden. + + + **Afhankelijkheden** + + + Deze API is afhankelijk van: + + + * Catalogi API + + * Notificaties API + + * Autorisaties API *(optioneel)* + + * Zaken API *(optioneel)* + + + **Autorisatie** + + + Deze API vereist autorisatie. Je kan de + + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + + genereren. + + + ### Notificaties + + + Deze API publiceert notificaties op het kanaal `documenten`. + + + **Main resource** + + + `enkelvoudiginformatieobject` + + + + + **Kenmerken** + + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de + organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en + als eerste in een samenwerkingsketen heeft vastgelegd. + + * `informatieobjecttype`: URL-referentie naar het INFORMATIEOBJECTTYPE (in + de Catalogi API). + + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het + INFORMATIEOBJECT voor de openbaarheid bestemd is. + + + **Resources en acties** + + + + **Handige links** + + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /bestandsdelen/{uuid}: + put: + operationId: bestandsdeel_update + description: based on DRF mixin but without partial_update + summary: Upload een bestandsdeel. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/x-www-form-urlencoded + - multipart/form-data + description: Content type van de verzoekinhoud. + required: true + tags: + - bestandsdelen + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/BestandsDeelRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/BestandsDeelRequest' + required: true + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/BestandsDeelResponse' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten: + get: + operationId: enkelvoudiginformatieobject_list + description: >- + Deze lijst kan gefilterd wordt met query-string parameters. + + De objecten bevatten metadata over de documenten en de downloadlink + (`inhoud`) naar de binary data. Alleen de laatste versie van + elk(ENKELVOUDIG) INFORMATIEOBJECT wordt getoond. Specifieke versies + kunnen alleen + summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. + parameters: + - name: identificatie + required: false + in: query + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + schema: + type: string + - name: bronorganisatie + required: false + in: query + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Een lijst van trefwoorden gescheiden door comma's. + schema: + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + style: form + explode: false + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobjecttype + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEnkelvoudigInformatieObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: enkelvoudiginformatieobject_create + description: |- + **Er wordt gevalideerd op** + - geldigheid `informatieobjecttype` URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben. + - publicatie `informatieobjecttype` - `concept` moet `false` zijn + summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLock' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail: + get: + operationId: audittrail_list + description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. + summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT. + parameters: + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid}: + get: + operationId: audittrail_retrieve + description: Een specifieke audit trail regel opvragen. + summary: Een specifieke audit trail regel opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}: + get: + operationId: enkelvoudiginformatieobject_retrieve + description: ' Het object bevat metadata over het document en de downloadlink (`inhoud`) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.' + summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: >- + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobjecttype + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: enkelvoudiginformatieobject_update + description: >- + Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) + INFORMATIEOBJECT. + + **Er wordt gevalideerd op** + + - correcte `lock` waarde + + - status NIET `definitief` + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest' + required: true + security: + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLock' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: enkelvoudiginformatieobject_partial_update + description: >- + Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) + INFORMATIEOBJECT. + + + **Er wordt gevalideerd op** + - correcte `lock` waarde + - status NIET `definitief` + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest + security: + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLock' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: enkelvoudiginformatieobject_destroy + description: >- + Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende + versies, samen met alle gerelateerde resources binnen deze API. Dit is + alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan + het (ENKELVOUDIG) INFORMATIEOBJECT. + + + **Gerelateerde resources** + + - GEBRUIKSRECHTen + + - audit trail regels + summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: enkelvoudiginformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - enkelvoudiginformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /enkelvoudiginformatieobjecten/{uuid}/download: + get: + operationId: enkelvoudiginformatieobject_download + description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. + summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: >- + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/octet-stream: + schema: + type: string + format: binary + description: OK + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}/lock: + post: + operationId: enkelvoudiginformatieobject_lock + description: >- + Voert een 'checkout' uit waardoor het (ENKELVOUDIG) + INFORMATIEOBJECTvergrendeld wordt met een `lock` waarde. Alleen met deze + waarde kan het(ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) + en weerontgrendeld worden. + summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lock + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/LockEnkelvoudigInformatieObject' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Bad request + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}/unlock: + post: + operationId: enkelvoudiginformatieobject_unlock + description: >- + Heft de 'checkout' op waardoor het (ENKELVOUDIG) + INFORMATIEOBJECTontgrendeld wordt. + summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest' + security: + - JWT-Claims: + - (documenten.lock | documenten.geforceerd-unlock) + responses: + '204': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: No content + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Bad request + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/_zoek: + post: + operationId: enkelvoudiginformatieobject__zoek + description: >- + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet + geschikt voor zoekopdrachten met UUIDs. + summary: Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EIOZoekRequest' + required: true + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEnkelvoudigInformatieObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /gebruiksrechten: + get: + operationId: gebruiksrechten_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle GEBRUIKSRECHTen opvragen. + parameters: + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: startdatum__lt + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__lte + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__gt + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__gte + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: einddatum__lt + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__lte + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gt + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gte + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GebruiksrechtenExpanded' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: gebruiksrechten_create + description: |- + Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. + **Opmerkingen** + - Het toevoegen van gebruiksrechten zorgt ervoor dat de `indicatieGebruiksrecht` op het informatieobject op `true` gezet wordt. + summary: Maak een GEBRUIKSRECHT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenRequest' + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /gebruiksrechten/{uuid}: + get: + operationId: gebruiksrechten_retrieve + description: Een specifieke GEBRUIKSRECHT opvragen. + summary: Een specifieke GEBRUIKSRECHT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: gebruiksrechten_update + description: Werk een GEBRUIKSRECHT in zijn geheel bij. + summary: Werk een GEBRUIKSRECHT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenRequest' + required: true + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: gebruiksrechten_partial_update + description: Werk een GEBRUIKSRECHT relatie deels bij. + summary: Werk een GEBRUIKSRECHT relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedGebruiksrechtenRequest' + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: gebruiksrechten_destroy + description: |- + + **Opmerkingen** + - Indien het laatste GEBRUIKSRECHT van een INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht` van het INFORMATIEOBJECT op`null` gezet. + summary: Verwijder een GEBRUIKSRECHT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: gebruiksrechten_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: >- + De headers voor een specifiek(e) GEBRUIKSRECHT INFORMATIEOBJECT + opvragen + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - gebruiksrechten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /objectinformatieobjecten: + get: + operationId: objectinformatieobject_list + description: ' Deze lijst kan gefilterd wordt met query-string parameters.' + summary: Alle OBJECT-INFORMATIEOBJECT relaties opvragen. + parameters: + - name: object + required: false + in: query + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: objectinformatieobject_create + description: >- + **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit + endpoint bij het synchroniseren van relaties. **Er wordt gevalideerd + op** - geldigheid `informatieobject` URL - de combinatie + `informatieobject` en `object` moet uniek zijn - bestaan van `object` + URL + summary: Maak een OBJECT-INFORMATIEOBJECT relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - objectinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObjectRequest' + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /objectinformatieobjecten/{uuid}: + get: + operationId: objectinformatieobject_retrieve + description: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. + summary: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: objectinformatieobject_destroy + description: >- + **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit + endpoint bij het synchroniseren van relaties. + summary: Verwijder een OBJECT-INFORMATIEOBJECT relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: objectinformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) OOBJECT-INFORMATIEOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - objectinformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /verzendingen: + get: + operationId: verzending_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle VERZENDINGen opvragen. + parameters: + - name: aardRelatie + required: false + in: query + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + schema: + type: string + enum: + - afzender + - geadresseerde + - name: informatieobject + required: false + in: query + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + schema: + type: string + format: uri + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - verzendingen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVerzendingList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: verzending_create + description: Voeg VERZENDINGen toe voor een INFORMATIEOBJECT en een BETROKKENE. + summary: Maak een VERZENDING aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingRequest' + required: true + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /verzendingen/{uuid}: + get: + operationId: verzending_retrieve + description: Een specifieke VERZENDING opvragen. + summary: Een specifieke VERZENDING opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - verzendingen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: verzending_update + description: Werk een VERZENDING in zijn geheel bij. + summary: Werk een VERZENDING in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingRequest' + required: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: verzending_partial_update + description: Werk een VERZENDING relatie deels bij. + summary: Werk een VERZENDING relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVerzendingRequest' + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: verzending_destroy + description: Verwijder een VERZENDING. + summary: Verwijder een VERZENDING + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - verzendingen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: verzending_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) VERZENDING opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - verzendingen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - afzender + - geadresseerde + type: string + AlgoritmeEnum: + enum: + - crc_16 + - crc_32 + - crc_64 + - fletcher_4 + - fletcher_8 + - fletcher_16 + - fletcher_32 + - hmac + - md5 + - sha_1 + - sha_256 + - sha_512 + - sha_3 + type: string + AuditTrail: + type: object + properties: + uuid: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + bron: + allOf: + - $ref: '#/components/schemas/BronEnum' + description: |- + De naam van het component waar de wijziging in is gedaan. + + Uitleg bij mogelijke waarden: + + * `ac` - Autorisaties API + * `nrc` - Notificaties API + * `zrc` - Zaken API + * `ztc` - Catalogi API + * `drc` - Documenten API + * `brc` - Besluiten API + * `cmc` - Contactmomenten API + * `kc` - Klanten API + * `vrc` - Verzoeken API + title: bron + applicatieId: + type: string + description: Unieke identificatie van de applicatie, binnen de organisatie. + title: applicatie id + maxLength: 100 + applicatieWeergave: + type: string + description: Vriendelijke naam van de applicatie. + title: applicatie weergave + maxLength: 200 + gebruikersId: + type: string + description: >- + Unieke identificatie van de gebruiker die binnen de organisatie + herleid kan worden naar een persoon. + title: gebruikers id + maxLength: 255 + gebruikersWeergave: + type: string + description: Vriendelijke naam van de gebruiker. + title: gebruikers weergave + maxLength: 255 + actie: + type: string + description: >- + De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder + aangegeven, maar andere waardes zijn ook + toegestaan + + + Uitleg bij mogelijke waarden: + + + * `create` - Object aangemaakt + + * `list` - Lijst van objecten opgehaald + + * `retrieve` - Object opgehaald + + * `destroy` - Object verwijderd + + * `update` - Object bijgewerkt + + * `partial_update` - Object deels bijgewerkt + title: actie + maxLength: 50 + actieWeergave: + type: string + description: Vriendelijke naam van de actie. + title: actie weergave + maxLength: 200 + resultaat: + type: integer + maximum: 599 + minimum: 100 + description: HTTP status code van de API response van de uitgevoerde handeling. + title: resultaat + hoofdObject: + type: string + format: uri + description: De URL naar het hoofdobject van een component. + title: hoofd object + maxLength: 1000 + resource: + type: string + description: Het type resource waarop de actie gebeurde. + title: resource + maxLength: 50 + resourceUrl: + type: string + format: uri + description: De URL naar het object. + title: resource url + maxLength: 1000 + toelichting: + type: string + description: Toelichting waarom de handeling is uitgevoerd. + title: toelichting + resourceWeergave: + type: string + description: Vriendelijke identificatie van het object. + title: resource weergave + maxLength: 200 + aanmaakdatum: + type: string + format: date-time + readOnly: true + description: De datum waarop de handeling is gedaan. + title: aanmaakdatum + wijzigingen: + allOf: + - $ref: '#/components/schemas/Wijzigingen' + title: wijzigingen + required: + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen + BestandsDeel: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + volgnummer: + type: integer + readOnly: true + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + omvang: + type: integer + readOnly: true + description: De grootte van dit specifieke bestandsdeel. + title: omvang + voltooid: + type: boolean + readOnly: true + description: >- + Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: + het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen. + title: voltooid + lock: + type: string + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + required: + - lock + - omvang + - url + - volgnummer + - voltooid + BestandsDeelRequest: + type: object + properties: + inhoud: + type: string + format: binary + writeOnly: true + description: De (binaire) bestandsinhoud van dit specifieke bestandsdeel. + title: inhoud + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + required: + - lock + BestandsDeelResponse: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + lock: + type: string + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + omvang: + type: integer + description: De grootte van dit specifieke bestandsdeel. + title: omvang + inhoud: + type: string + format: uri + description: De URL naar de bestandsinhoud van dit specifieke bestandsdeel. + title: inhoud + voltooid: + type: boolean + description: >- + Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: + het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen. + title: voltooid + volgnummer: + type: integer + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + required: + - lock + - url + BinnenlandsCorrespondentieadresVerzending: + type: object + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van de + BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het + reguliere binnenlandse correspondentieadres van BETROKKENE. + properties: + huisletter: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende toevoeging aan een huisnummer in + de vorm van een alfanumeriek teken. + title: huisletter + maxLength: 1 + huisnummer: + type: integer + maximum: 99999 + minimum: 1 + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nummering. + title: huisnummer + huisnummerToevoeging: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nadere toevoeging aan een + huisnummer of een combinatie van huisnummer en huisletter. + title: huisnummer toevoeging + maxLength: 4 + naamOpenbareRuimte: + type: string + description: >- + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE + OPENBARE RUIMTE toegekende benaming. + title: naam openbare ruimte + maxLength: 80 + postcode: + type: string + description: >- + De door TNT Post vastgestelde code behorende bij een bepaalde + combinatie van een naam van een woonplaats, naam van een openbare + ruimte en een huisnummer. + title: postcode + maxLength: 6 + woonplaatsnaam: + type: string + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam + nullable: true + BinnenlandsCorrespondentieadresVerzendingRequest: + type: object + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van de + BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het + reguliere binnenlandse correspondentieadres van BETROKKENE. + properties: + huisletter: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende toevoeging aan een huisnummer in + de vorm van een alfanumeriek teken. + title: huisletter + maxLength: 1 + huisnummer: + type: integer + maximum: 99999 + minimum: 1 + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nummering. + title: huisnummer + huisnummerToevoeging: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nadere toevoeging aan een + huisnummer of een combinatie van huisnummer en huisletter. + title: huisnummer toevoeging + maxLength: 4 + naamOpenbareRuimte: + type: string + minLength: 1 + description: >- + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE + OPENBARE RUIMTE toegekende benaming. + title: naam openbare ruimte + maxLength: 80 + postcode: + type: string + description: >- + De door TNT Post vastgestelde code behorende bij een bepaalde + combinatie van een naam van een woonplaats, naam van een openbare + ruimte en een huisnummer. + title: postcode + maxLength: 6 + woonplaatsnaam: + type: string + minLength: 1 + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam + nullable: true + BlankEnum: + enum: + - '' + BronEnum: + enum: + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc + type: string + BuitenlandsCorrespondentieadresVerzending: + type: object + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden + INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens + van BETROKKENE. + properties: + adresBuitenland1: + type: string + description: >- + Het eerste deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 1 + maxLength: 35 + adresBuitenland2: + type: string + description: >- + Het tweede deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 2 + maxLength: 35 + adresBuitenland3: + type: string + description: >- + Het derde deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 3 + maxLength: 35 + landPostadres: + type: string + format: uri + description: >- + Het LAND dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: land postadres + maxLength: 200 + required: + - adresBuitenland1 + - landPostadres + nullable: true + BuitenlandsCorrespondentieadresVerzendingRequest: + type: object + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden + INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens + van BETROKKENE. + properties: + adresBuitenland1: + type: string + minLength: 1 + description: >- + Het eerste deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 1 + maxLength: 35 + adresBuitenland2: + type: string + description: >- + Het tweede deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 2 + maxLength: 35 + adresBuitenland3: + type: string + description: >- + Het derde deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 3 + maxLength: 35 + landPostadres: + type: string + format: uri + minLength: 1 + description: >- + Het LAND dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: land postadres + maxLength: 200 + required: + - adresBuitenland1 + - landPostadres + nullable: true + BuitenlandsCorrespondentiepostadresVerzending: + type: object + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen + van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: >- + De numerieke aanduiding zoals deze door de Nederlandse PTT is + vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: + type: string + description: >- + De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: + type: string + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + BuitenlandsCorrespondentiepostadresVerzendingRequest: + type: object + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen + van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: >- + De numerieke aanduiding zoals deze door de Nederlandse PTT is + vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: + type: string + minLength: 1 + description: >- + De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: + type: string + minLength: 1 + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + EIOZoekRequest: + type: object + properties: + uuid__in: + type: array + items: + type: string + format: uuid + title: '' + description: Array of unieke resource identifiers (UUID4) + title: uuid__in + identificatie: + title: Identificatie + description: + Een binnen een gegeven context ondubbelzinnige referentie naar + het INFORMATIEOBJECT. + type: string + example: "Document123" + bronorganisatie: + title: Bronorganisatie + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." + type: string + example: "000000000" + expand: + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + type: string + example: informatieobjecttype + required: + - uuid__in + EnkelvoudigInformatieObject: + type: object + description: Serializer for the EnkelvoudigInformatieObject model + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + + + Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het informatieobject is vervallen. + + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + DEPRECATED Dit attribuut is verplaatst naar resource + Verzending. De datum waarop het INFORMATIEOBJECT ontvangen is. + Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + DEPRECATED Dit attribuut is verplaatst naar resource + Verzending. De datum waarop het INFORMATIEOBJECT verzonden is, zoals + deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel + inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde + informatieobject kan niet tegelijk inkomend en uitgaand zijn. + Ontvangst en verzending is voorbehouden aan documenten die van of + naar andere personen ontvangen of verzonden zijn waarbij die + personen niet deel uit maken van de behandeling van de zaak waarin + het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectCreateLock: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + + + Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het informatieobject is vervallen. + + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + lock: + type: string + readOnly: true + description: >- + Lock id generated if the large file is created and should be used + while updating the document. Documents with base64 encoded files are + created without lock + title: lock + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectCreateLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + + + Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het informatieobject is vervallen. + + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - taal + - titel + EnkelvoudigInformatieObjectWithLock: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + + + Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het informatieobject is vervallen. + + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectWithLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + + + Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het informatieobject is vervallen. + + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` + veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde + hebben. + title: lock + required: + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - taal + - titel + EnkelvoudigInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/EnkelvoudigInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectEmbedded' + EnkelvoudigInformatieObjectEmbedded: + type: object + properties: + informatieobjecttype: + $ref: >- + https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/InformatieObjectType + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: >- + URI met referentie naar dit specifiek voorkomen van de fout. Deze + kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + Gebruiksrechten: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + required: + - informatieobject + - omschrijvingVoorwaarden + - startdatum + - url + GebruiksrechtenExpanded: + allOf: + - $ref: '#/components/schemas/Gebruiksrechten' + - properties: + _expand: + $ref: '#/components/schemas/GebruiksrechtenEmbedded' + GebruiksrechtenEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + GebruiksrechtenRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + minLength: 1 + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + required: + - informatieobject + - omschrijvingVoorwaarden + - startdatum + Integriteit: + type: object + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal + bestand. + properties: + algoritme: + allOf: + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. + + Uitleg bij mogelijke waarden: + + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 + * `sha_3` - SHA-3 + title: integriteit algoritme + waarde: + type: string + description: De waarde van de checksum. + title: integriteit waarde + maxLength: 128 + datum: + type: string + format: date + description: Datum waarop de checksum is gemaakt. + title: integriteit datum + required: + - algoritme + - datum + - waarde + nullable: true + IntegriteitRequest: + type: object + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal + bestand. + properties: + algoritme: + allOf: + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. + + Uitleg bij mogelijke waarden: + + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 + * `sha_3` - SHA-3 + title: integriteit algoritme + waarde: + type: string + minLength: 1 + description: De waarde van de checksum. + title: integriteit waarde + maxLength: 128 + datum: + type: string + format: date + description: Datum waarop de checksum is gemaakt. + title: integriteit datum + required: + - algoritme + - datum + - waarde + nullable: true + LockEnkelvoudigInformatieObject: + type: object + description: |- + Serializer for the lock action of EnkelvoudigInformatieObjectCanonical + model + properties: + lock: + type: string + readOnly: true + description: Hash string, wordt gebruikt als ID voor de lock + title: lock + required: + - lock + ObjectInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + object: + type: string + format: uri + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + title: object + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + title: Objecttype + description: |- + Het type van het gerelateerde OBJECT. + + Uitleg bij mogelijke waarden: + + * `besluit` - Besluit + * `zaak` - Zaak + required: + - informatieobject + - object + - objectType + - url + ObjectInformatieObjectRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + object: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + title: object + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + title: Objecttype + description: |- + Het type van het gerelateerde OBJECT. + + Uitleg bij mogelijke waarden: + + * `besluit` - Besluit + * `zaak` - Zaak + required: + - informatieobject + - object + - objectType + ObjectTypeEnum: + enum: + - besluit + - zaak + - verzoek + type: string + Ondertekening: + type: object + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet van + een waarde zijn voorzien als de `status` de waarde 'in bewerking' of + 'ter vaststelling' heeft. + properties: + soort: + allOf: + - $ref: '#/components/schemas/SoortEnum' + title: Ondertekeningsoort + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + + Uitleg bij mogelijke waarden: + + * `analoog` - Analoog + * `digitaal` - Digitaal + * `pki` - PKI + datum: + type: string + format: date + title: Ondertekeningdatum + description: >- + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + plaatsgevonden. + required: + - datum + - soort + nullable: true + OndertekeningRequest: + type: object + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet van + een waarde zijn voorzien als de `status` de waarde 'in bewerking' of + 'ter vaststelling' heeft. + properties: + soort: + allOf: + - $ref: '#/components/schemas/SoortEnum' + title: Ondertekeningsoort + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + + Uitleg bij mogelijke waarden: + + * `analoog` - Analoog + * `digitaal` - Digitaal + * `pki` - PKI + datum: + type: string + format: date + title: Ondertekeningdatum + description: >- + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + plaatsgevonden. + required: + - datum + - soort + nullable: true + PaginatedEnkelvoudigInformatieObjectList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' + PaginatedVerzendingList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/VerzendingExpanded' + PatchedEnkelvoudigInformatieObjectWithLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` + veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde + hebben. + title: lock + PatchedGebruiksrechtenRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + minLength: 1 + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + PatchedVerzendingRequest: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + betrokkene: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + minLength: 1 + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + PostadresTypeEnum: + enum: + - antwoordnummer + - postbusnummer + type: string + SoortEnum: + enum: + - analoog + - digitaal + - pki + type: string + StatusEnum: + description: + "Uitleg bij mogelijke waarden: + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element." + enum: + - in_bewerking + - ter_vaststelling + - definitief + - gearchiveerd + type: string + deprecated: true + StatusEnum1_5: + description: + "Uitleg bij de enumeratiewaarden: + + * `in_bewerking` - (In bewerking) De inhoud van het informatieobject kan + op ieder moment en onaangekondigd veranderen. + + * `concept` - (Concept) De inhoud van het informatieobject heeft een + mate van bestendigheid bereikt waardoor die aan derden ter beoordeling + kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van + de inhoud van het informatieobject. (_Nieuw vanaf versie 1.5.0_.) + + * `definitief` - (Definitief) De inhoud van het informatieobject heeft een + mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd + kan worden. + + * `ter_vaststelling` - (Ter vaststelling) De inhoud van het informatieobject + is betrokken bij een lopend besluitvormingsproces. + + * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is + bekrachtigd tijdens een besluitvormingsproces. (_Nieuw vanaf versie 1.5.0_.)" + enum: + - in_bewerking + - concept + - definitief + - ter_vaststelling + - vastgesteld + type: string + UnlockEnkelvoudigInformatieObjectRequest: + type: object + description: |- + Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical + model + properties: + lock: + type: string + description: Hash string, wordt gebruikt als ID voor de lock + title: lock + maxLength: 100 + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: >- + URI met referentie naar dit specifiek voorkomen van de fout. Deze + kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + Verzending: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzending + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + required: + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + - url + VerzendingExpanded: + allOf: + - $ref: '#/components/schemas/Verzending' + - properties: + _expand: + $ref: '#/components/schemas/VerzendingEmbedded' + VerzendingEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + VerzendingRequest: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + betrokkene: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + minLength: 1 + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + required: + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + Wijzigingen: + type: object + properties: + oud: + type: object + additionalProperties: {} + description: >- + Volledige JSON body van het object zoals dat bestond voordat de + actie heeft plaatsgevonden. + title: oud + nieuw: + type: object + additionalProperties: {} + description: Volledige JSON body van het object na de actie. + title: nieuw + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + - description: SwaggerHub API Auto Mocking + url: https://virtserver.swaggerhub.com/michielverhoef/Documenten_API/1.4.2 + - url: https://documenten-api.vng.cloud/api/v1 + description: Productie Omgeving +tags: + - name: enkelvoudiginformatieobjecten + description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). + - name: gebruiksrechten + description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. + - name: objectinformatieobjecten + description: >- + Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft + een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de + Zaken API, en een INFORMATIEOBJECT. + - name: verzendingen + description: Opvragen en bewerken van VERZENDINGen. diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index 717ae8d73..bdb2de201 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Documenten API - version: 1.4.3 + version: 1.5.0 description: > Een API om een documentregistratiecomponent (DRC) te benaderen. @@ -5949,7 +5949,6 @@ components: Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar @@ -5983,26 +5982,65 @@ components: attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. - Uitleg bij mogelijke waarden: + Uitleg bij de enumeratiewaarden: + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. + * `true` De inhoud van het informatieobject is vervallen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element. - title: status - oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true formaat: type: string description: >- @@ -6253,26 +6291,65 @@ components: attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. - Uitleg bij mogelijke waarden: + Uitleg bij de enumeratiewaarden: + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. + * `true` De inhoud van het informatieobject is vervallen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element. - title: status - oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true formaat: type: string description: >- @@ -6522,26 +6599,65 @@ components: attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. - Uitleg bij mogelijke waarden: + Uitleg bij de enumeratiewaarden: + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. + * `true` De inhoud van het informatieobject is vervallen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element. - title: status - oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true formaat: type: string description: >- @@ -6757,26 +6873,65 @@ components: attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. - Uitleg bij mogelijke waarden: + Uitleg bij de enumeratiewaarden: + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. + * `true` De inhoud van het informatieobject is vervallen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element. - title: status - oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true formaat: type: string description: >- @@ -7017,26 +7172,65 @@ components: attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/BlankEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het informatieobject duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. - Uitleg bij mogelijke waarden: + Uitleg bij de enumeratiewaarden: + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. + * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden. + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + nullable: true + indicatieInhoudVervallen: + description: >- + Geeft aan of de inhoud van het informatieobject al dan niet + vervallen, dus niet langer geldig is. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. + * `true` De inhoud van het informatieobject is vervallen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element. - title: status - oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + * `false` De inhoud van het informatieobject is niet vervallen. + + * `null` Het is niet bekend of de inhoud van het informatieobject + is vervallen of niet. + type: boolean + nullable: true + indicatiePersoonsgegevensAanwezig: + description: >- + Geeft aan of in de inhoud van het informatieobject persoonsgegevens + aanwezig zijn. + + * `true` In het informatieobject zijn persoonsgegevens aanwezig. + + * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + + * `null` Het is niet bekend of in de inhoud van het inforformatieobject + persoonsgegevens aanwezig zijn. + type: boolean + nullable: true formaat: type: string description: >- @@ -8020,12 +8214,55 @@ components: - pki type: string StatusEnum: + description: + "Uitleg bij mogelijke waarden: + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element." enum: - in_bewerking - ter_vaststelling - definitief - gearchiveerd type: string + deprecated: true + StatusEnum1_5: + description: + "Uitleg bij de enumeratiewaarden: + + * `in_bewerking` - (In bewerking) De inhoud van het informatieobject kan + op ieder moment en onaangekondigd veranderen. + + * `concept` - (Concept) De inhoud van het informatieobject heeft een + mate van bestendigheid bereikt waardoor die aan derden ter beoordeling + kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van + de inhoud van het informatieobject. (_Nieuw vanaf versie 1.5.0_.) + + * `definitief` - (Definitief) De inhoud van het informatieobject heeft een + mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd + kan worden. + + * `ter_vaststelling` - (Ter vaststelling) De inhoud van het informatieobject + is betrokken bij een lopend besluitvormingsproces. + + * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is + bekrachtigd tijdens een besluitvormingsproces. (_Nieuw vanaf versie 1.5.0_.)" + enum: + - in_bewerking + - concept + - definitief + - ter_vaststelling + - vastgesteld + type: string UnlockEnkelvoudigInformatieObjectRequest: type: object description: |- From a14aed8bcafa87bb764f57ead36aef5dd614e2b0 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 17:02:37 +0100 Subject: [PATCH 03/17] Ignore local files --- .gitignore | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.gitignore b/.gitignore index 2d5d79728..1cef02dd3 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,11 @@ infra/env/ infra/fixtures/ deploy-bot/env/ +api-specificatie/DESIGN/drc/relateren-documenten_copy.json +api-specificatie/drc/current_version/image-1.png +api-specificatie/drc/current_version/image.png +api-specificatie/drc/current_version/readme.md +api-specificatie/drc/current_version/relateren-docs.md +api-specificatie/ztc/current_version/test.txt +api-specificatie/ztc/current_version/test2.txt +api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml \ No newline at end of file From 0a53ff9ad611b13f0a80f30a9eb3b2107cab2251 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 22:17:05 +0100 Subject: [PATCH 04/17] Delete local files --- .../DESIGN/drc/relateren-documenten_copy.json | 5 -- .../drc/current_version/image-1.png | Bin 21762 -> 0 bytes .../drc/current_version/image.png | Bin 21492 -> 0 bytes .../drc/current_version/readme.md | 65 -------------- .../drc/current_version/relateren-docs.md | 80 ------------------ 5 files changed, 150 deletions(-) delete mode 100644 api-specificatie/DESIGN/drc/relateren-documenten_copy.json delete mode 100644 api-specificatie/drc/current_version/image-1.png delete mode 100644 api-specificatie/drc/current_version/image.png delete mode 100644 api-specificatie/drc/current_version/readme.md delete mode 100644 api-specificatie/drc/current_version/relateren-docs.md diff --git a/api-specificatie/DESIGN/drc/relateren-documenten_copy.json b/api-specificatie/DESIGN/drc/relateren-documenten_copy.json deleted file mode 100644 index 8c441c715..000000000 --- a/api-specificatie/DESIGN/drc/relateren-documenten_copy.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "informatieobject": "", - "relevantAnderInformatieobject": "", - "aardRelatie": "geanonimiseerd" -} \ No newline at end of file diff --git a/api-specificatie/drc/current_version/image-1.png b/api-specificatie/drc/current_version/image-1.png deleted file mode 100644 index f5993cf53c42778f765bea0f4eaa8da509c8f617..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 21762 zcmeIabyQVt7caU6!2&UmloAkwPNfkgB&9o~TcsO8!63IvN(xfa-5^RxcZbs5Y??b4 zzVG*)GtRyD-*fL6hcO&uyZ2gaKhJz-{N|j$x!=mmisPRrJC8!4@FgW4DxgrOSx~4` zYiDuc9hr*IpC}YHO7fwIlGEqK5m&d5Q_;uAj^6t_Ihq%7%e?6`=&n{;Wk0_2@WKz~ zvvhMBpzQTHnyv$>RQxACKD~u6KW2)oJ5<^At}v zBDzRx*|*NC>2$hg$BQx*zjBfR`uNjiDpzNn0yZoT@-0n@G1yF9FLs(6J{tB|-^JU} zk+R9sN)htdQ*U>VU&!vtzU+N+s5jX4M{jI_`uAzdd5lL zwasI+8fz#no{rt$E$`*9PwQog$l5sb%kD@xVpKa%t!NbUu>a!vE9duiOI)f^3(-RI zH~Z=XjN@qZ^*rG}U$>;D@3MJ#l}Hy0H^Eg(jt8&W92}3f<@@7)1UK4F?aX@x4~?lR zrcX-V7aY>5GOV<&SUDH#|IwYRAQJXjFm%3UYW+R8nuqSX;g9B4&E>qT=VO%fVP^WD zlVQ=-EX7@&zlIr+??UTV5S@Z6Uu*2s;jH3xepG(;t;*-5xo`)XDuJp8Z)_};jt~fbg&fv zW^l?1jz^1%XOCh?TvJ!&k+MvC>mKZZYk5etHs(Xf?M4rK?yt$ow_(2*uirPXRI%Tw z;`DgC=Rf(X{%AG2TI z^^=ad>nQpK4&~mY{1uzV4=>z~F6IZlON;c1AYW6}rH2ob4)ePQx9C#W9jWGG8Yi$T z!$^dL@nfSmT}RGpskI27o1Ul>imLLouMSgwqI}hE;Moe*y%*gq#rhH?{kon9n|W~y zg1oM1%4mT`Jo5})_A!Ry$t75F4~0-X9N=Srs`0DBFWm=Hr*XjV6n>12rCPcPzMIG! zpWxgN*9P%>qj>>f1`?t-+qRl61|Rrb4^b=hh+0?ql<#sFIv*G-zh;~~W!2iM$tPz{NysNuFV>csflV%Qdgdk`~-h zf3KpPz@tmp+3|aOF7$MC56ehVyd9gHoHBB99I@FfaO`8Oc(rhZ+_BkGA#!Yc+rM5L zKW`3|Tho+HHSYl}o!l$#NM;h_mehR3OTYyC)TOU-Yhz)(+FTi_fgF#=0N%@YMw!hm zi0W4{B`!MkxbKB*XV$835zV6gj(4M;_j2krT6y9tLKheel+h{ z$zD^8!9iK-*9))bne27voaNe=xQDo=gfy|0@=e1Z3%*yZB_2_Wc~$@Nr%P%T_!Sv? z*^Wevx^62qCGDKr56<>|U5Zts62U;r9e*~C#^rf}TB4_1#);03Eq{W4YU|5^LlZd( zl)?}FZ}?*b4;312_>1Y+tB;Xi?chuRg`c!G-8>fvi%&?aJ?>#%vLP@VBkN4_j)fH@ zzT@G;Ci-s4@^%fIu`1SOM6ZOLj0yjc^?c4WvDI14H$4sO4Q(-`xy5%EGtT^DZu5eJ zd%3Mtw-nbCKL;!7%gV`hf#sEMN2W8G=o`v3$*0-|?PBDP+#}(@cZ>)bHLI8m<>|mx z(AN>Puk#e{f4geh@TMcAh&>}Yzc!vkwFX4~p$qFAobQYt&1(DjDcrXW^`M^oF(IVcYy}tp|^5D^z1HEDf8l5AfVJ zo7kh@P~I&Iatn2xNn$t*taXk0JsQSeE7@7e^<(8;xrzTdPJ0X1jMUgu5LCbT9nE+i zi68F-9h3Ap{NUu_;Sn#uL0$5ClJdbj+Ut-6hcDvJH7hO%@Y?+QCBJl?Z=S^SY^N46 zfhvzOGIH{sBAc<4!q@tLqbqeBrGU$srKQe2Z0_se@#940ujRodptx9t%p zNx*V$z*l%bG_iDoA^#v?iPvc|{9@zz84<4mqrtALBlRM7amt&2*qseX5yV&#DdG3z8 zk~iH|UT?xE0j7#<{rrIr(dKMJ@rDfz2zO$wI(nHCR%*GT6P3{ke#_yPHX|R0E%ym8 zZB$yAJ<<846`Fg~TyP4QCw)i|$(!s$rAeg0Ra z#-rv%*Y<|X>fEiayVChvFiH;TG%HT0khfs`S0W{xJgZJys9FSZTybbDr*?u9^UBlfx}@j@fP6Uh>eq*LkA}1|lV~%A3evRWdHcb&0&wZr$g;sF zQ`#LTh$&>KBM6>I$9C%-QOZ$`y0eYD)ZpUibvMmCKc}4C^3nrzXjRS#o|Z%>DE!5e zgSz#{8=twN?u76h+dbGBGi+US{i0uPUY@d=8p+ahep%Duj#uU_i2krKjkS%UExT3% zje-CPb`k)h=}viyXgkm!LAlopfwAo`X~nnXYse5W4LCPl^W0JviQOLKa4tuJ>%o5a zT;4BFBOma>Tzobq3R&dWHzntHF5gBVWh2Yj1@iKH_IuyBKe_U1*X^F4SsGc1sxMA` znx%7VVEJl!vE$=XT~-6Y#t52{?A*nU&tv#*=4}1ozFWQyDMrZ1`0clbinf_yK&{Fh zb;sRb-&G)ou6;ol&$&Xga;D<&K$ScHw)|?I`1I)tDvdNgkMAqR{?sF>T_y##$23#K z&dXt>q(%8nT%;b_=&3gEn&RX;pb-WuXEK)Ci>5X%nMG+D^c{(!ncZ)4D=+qN*sib+ z+0~AVoN9aC)}4w@bnIg+bX)S7OPMePST8J`l$3Pm&YezQeDdz$VM|=*J9qCQ@=uZq z6DxV$@!{jg#KgpEIX4t_FaW?il6TZJiB{h_x(=!;THrG4>@^Z7uP@RHMu&iJ<`NK) z5icxH{NdDgb<#D~qj7zEe`_h@VBh2pn7CwTsJ605SoBr}8=7A(xt0P0|2OBgl?8+L zHs)~Rh+zedZ+|zuPY7NF4wKg{e{?;^?rXU+{dD_lT1}l!fD^H@%i!xj@$bJuzMEeA zms-xeZ;j7KE-q1Y{zj4CV9^>)^W9tA*u<@>F}-jD$HEugvC+twn6JO=h46PdD>;hE z$v$zl*m_Vp9~C$ZS<}V(wXQyBbdc;sWYt!3xqWti5q%QHEvI>^b_3|j{8&LxxyB-NK_}%!stleWi$}}uA{HFT7ea2)Kh3ab#dX~J7R^61)5A2i zRH&UE>lf$%)(!$B3tg1|UVUV|`fRB%`iZsr{@;Xe_B0E>LlB)AcmUADrC|5Zyzae= z(qt52@_?fw-B&kGHWVjaACnuXaGSKGLLlmLK>($fP}6NT0nQEvMK3CYf? zulNLIv8K{OuG>mMlmZDOc;_9kgsEkd6+vdk6>mE` z6IOR^!(cYLr{@VlaB zW@hHr*4*#yOSPEkZ{B>2CSp{J`}OPb$crYXJGXAFnu)T4C|{IlO&|Fe7HSE#ANjYI zVk}07w9B1xjGM#tD~VF%lR8HC_V$8*-VLx_(EiBDz#z_H;-Zjd(i|R-bAiaT#v8}j zYrH?lz+>o~qX&M77Kh|xIXP7ol~CPNs^sc(-PDB(7F z)PFECZ}*DFqgLP8LM;b8U*yK*dC8dg+bZX&jAdHnYX)<@Uh@SEUIW!L`_+FrbWqRk zhXyX6|KUMeZmG73+S%!XjBBTS1i$#{t|)fr?7f*eChpU*El67OprsL9WWPGi#O}#s zOdi6oXi#YHR2QV9M*gfYq-3nBWu}}ABlC;r%3@fb_+DmjH zP)VF(=I482tIOqxfqJhlOSgryiC***{rU6fv<2uV9?e{t2%w?+85O<6OGiy&u>CGn zh|6>J@K`49_A}9(7nJ3g8G&-c)(>|FKRdt3?!C5JOeXs(rnE4RGx|PpwmTma(bvt) zySac&FE5obA!5#iSUON8#!X>PU6uAN)XpqCw5CDgU4EvFrd{`QZXTYy+}wNd*nqsL zy#QcT^`X(|Njn{~w*9017_&cOf!9f&xvwmGt*@_p4RQ8bnVPP;W-<9M{jB%%@Xoi1 zojIq`^e67^+qcHO52Rk^-uf(?3^F{_Ic{~V{F0Dx!+pJx!GrXAJV}%9c^9WV7Z2JJ zV_*A)-rWl0(_R|JX3|mIG9@J?p@VpF8!c6~3EZDnJ^@T>>b1$^@A=xHe_?X7q)KCX zr)aZYPUym}2Y6fCZ32Vi3Gu}6msoeN;BNCI%V-z5hwYx;0jOe}=9=;+Vbp(*MC{1} z8{}kU-z^yx6x)k zKF+^$Tsh}{(@zs-sst5*91CSz$eRIhw2=B@;r}iXaQ_H+h>wXj^-EwLlF3C7L%tvP z>1dNd?j_e3qDNArqG!u3xa@FgO*`0c{drO1X3o*w=lV_phkRKtDbVM#-mN=#*ca^W zxYK8N&=y3$at!K8ZeZDoKuB1~DZ6;4aPeyA*|&dE7=04q=0#SY%@2 zyI^4Fca8);)JIWlDkithXTD}hgM=N-Z>}LUjPZ<&vAc~wfFLEU>26U+Y5A(k3Ir=5 z7*D@3Fpfhx-;iJ5ns+}eZf*{3^7UdFVF)J{j|ro3-3jc)=;-c=ODznuIt4$Daet`$ zdH+2;Y;)Mt(%SZn&}RU=0Eb`Wdkus<@wwS)+oKcfw{2+n`N!5=QW;U@ET-~_bUvWW zT}+$*WAY(vD7B8W>vw-L-R)Yx?cw0yP(2kH6?N#VpRWui2bLM*^yl0LmqCgT#==)` z$y|Mg=A*Z_cifO!M0~qK99Cq=yU7EM3S$(rknPPt<);T;4oqaXb{*`-jt`$mEs)3s z9UJZN)G`lc+1ON6&i+=p#=prtY-U&JpDIjMx-rIRH35w|SS|fEi^o&-4F>YL; z8|9!P;NA~}ZubH(**DTfEfyP?YsC`Auu!vq1a~K|N;RodV0BRXM-q1?kt%8srCP2O zlB!=1(I~Y`Re#gX7knvIBCuwj>q6Zv-}7+`bA3fc>v;k=FE>;^rTotOu#~H9(ErNr zwkQqZ%7BnYZ_wGV0M=X%eAf_dU-z z#@V)PLphZ}K#`$Cy&?X*r&X};WLaed+s(PzzbYhp^O2b%tSmmK_UrMI#3+~Pvin|= ziq#iT@NIcW5J^+^3};H?V$T`8Q=@I~xHe$ae-^4|rb%X9UnS9_ZW}GxO~xiBO>=e* z8mQV7qvwnLIl-itgmzwJ;^^ho>4S< zN7Cc93ih>oIC?@zom18!@h6{XiOIT?WDMb&p5lkcF=Xcmu6+xkgUZ#L6b=hK`?c1D z?C&WS&$D}zs4B91^Hx%i3cS79cy(-V23#l^{`fp*4_oXK^&paBLvWKsFCR4K22%_> z9GEs_|3-hMz18e5Wic`z7zHPH1I5Y$$mq;8Y zP1maY?TvOyf7Hm*geY-&3&}2%-tw3?MMMy zfsvwHk!)Ju&(p4s3usEPii!LR6=j1$sT=PwfQDZU4f593nY!Zqw{JJD6nnGzCKwtU z@0IIlXpj|Ji$T-^bk%m`lkp)YhB>Thia0U*#7oALybLW{sT^{%n(IXJkpv>#_D2Vc zA@|XS4k|;npWhm^1THL=Pr0P6%1{Wp+`gN!ymO98vq}cCsw9Z1NXoFj5=+`4xVN=5 zlBTX`O~T(`85Q!&qv&TO)u>!}tTX%z7t>5Z(S$%N*f_kI63b*k&n*6T;yzd<}p+ryK z@9UFsuAV8DjTTG~nELd%Y`^}_=pr6po(v}mmuX_J=S9tZXHx>P>ZB<~TBZPLNp5VJ zveMc1koUwagHQX<;_#h{!#{uF!dCQ(8=#}s?&gTFqf;94^5Y*QgTup9pi4&&Q5)y( z4bmGqCT)}m{+i|ncv`K_U%CD%O9IVp**~thQbUsP`*1Iig0H!+qCku1V}3p-7Z1;V zPx`Za*Yy`92#JV(EjjEjde-{lpEB9K#mK1S>|8=h&Dv^9H`52^nLM>-Y-kv6h0^n+ zRYbQWyj)5`4AHgcfsE6$5UBbnWfw~0SYWFjQ$bSE@%^*Pwbe36cOf#g&|s^WSUAnL zdUnA9q4`B{(<$t})P5onqF&@3%?m7tiVo7zSfW(`>uiUTDRw1~%g&Y{M+k|if$?c((2fok7w)o+}(BV<&4S#{EKR;1AlwlK>YN`Ho&oT4^`Ys zhG~yu?pV^h?BXLS(C}D@_vV6hl6m&Ib5UxBznKqqNp4@55@e^Bt!$uF<#M!@aaqo6 zq2<>Mjnc~j0A#0D7Bp8jvM%3r7UV-9rp`w90${EqidwIGOoc)q^l@gS^wziisEgF}_q7Wx=RcwqfmxFY^m`={C z`fT|<%wcPC9?^VpKs+wMuQ`TeL8i&dio?=944N7L{ka)vKL9rUkrkfUadYCf9cz5+ ze!$qX@Sh?+0vQDPqmV8q>F}s66s~l(j_naCTn}ArFSbdZU4Coe z@#0{&X2WJgs!!hxrpoSgzsL}1mFQ2>Gm*BnNJ}^+e5R?b4YSK~<8PsYt}4!JXeqSz zw>$*ie&N%Xq@e?Q<;oRK({}2fo}Nc#_h-Mu`F(kBBBZ)|x9wrsZIl;^C~F|42y-m5 zG1Jzk?KpC+r|_YW8y3pc5y^0Pqdn{?{39=k1)PO~Dm7sl9ytxvsKVkY_#AHW@o9q1 zZr<*_?R<2GFhv#@E@?+=`vyF$!a;dme4?f{%OPWKYs;}k0-sz$j2?{?drJ$2yVl5r zR)Y1W{^bJHnD^4r(Vf;dY5jcvR39mav2?pVtn})$Xy`DX)@Gogp&94h-QA@Lx*ZIN z^0iiS<)~+A!$_H*jJzm@1h!?5P}vqi9G`0Ky&pYAX` z;N-1rF5i<*AJQA{|M#tb3ftAa%sS-_+5a?=b^p^urbTL^@OQGD%r_3$@VedoaP31| zzEew`DGxU4Qnk&+qfzb?cnQ+F21zTLZmW2j{E78BC_k}{?fVMu?zS}|<#1t){Zc{S z{GdgavWJI9eiRn!?9--Drox8uHy%6xbiF%YUm*TZ<2+ZYruDx&iul`GukQW#^Z#KV z|EbGs7e9O1{0|>OmzYI|?%!HF@qgOsPqMEfdqVY-{og;aU)abf34-IKL)n)RLb$Nn z0jl|4DhND+x0_=>fBvjuMa#jVsJr`1l}-{;i^q>2D?lK1o4a_Wy!gf-KFUjC za&j^yB}Jm8r3Fn_G{odrOCx!QkukqK8ggl%AdG79+`K7q#o;GiiRv+sO%0Jc@fDDS9gXK+SL}nzvG#U7XH9T`?MS7; z%Wr6@7l8g?w;+7Y_=^{7e;#QXYD)mLuoHo83VM=1;?bmKVruyoizvqUl`=fi5Lj>A z1@rqEa}2R=SCT^EeN-4r8R5c5IH%bMmD>ebuib*me6>pFiN%8*(o z9D=M32i(`LJYaSblkINvIV{RUl?XYcJ_xaKV37}Vl;N7{se0%wBHOqR*PPw;(ASTL z0Nzq{_3G7#C#O;EsTV1D6F+_=gyem$J5`aQvg!ka+-E_otkcaAU!cMQ#v@EfI(Dk+Xe;Z>@Rf1&w{MKGk#|w0p<~BK7<6KB@x8pW z`IEO#FWK=<+3{{gjUCi6xVAAvohH6$)I}<*eEo5C^E(@eT4?_Ixc5pXE7kYG9htHXuJKI>Sp`TyjbzF+g@~Lx-C?8wfHFK53@4fEdu6 z&xS|-vR_Wc`5dhJ33c~oXu^UEtVeixWS5O8WXW(w-f%`j25@$sl&Ie5#_MjPi1R+wE`R;UrrNeR3Se&8z9E`iv8Hy!4Wg zj0-N1z=2I-B8%X9b3mV9fb4y8GBQ2$J?XUOd|t~xWos@B8AJ0@k0B=qC^ueBTG=$D z=#L*hAUVIJ0;m{WY;IPGTT zB|EeAYnw4qk&%m6mEefBqc6bbI3m24!vS zjQM$UtC3Q!MQI&WDFYuqd5-v96e_!N0xn9R{OvEX&rH53fn7iys=#he zL23xAy`uj%;!sd1BD>ek??I^@qUSHqG9yOO+$>$9#f;cRh&UzN7@zZcq6fH+$LLTN z-Q^G3&wG?r=cdARLnj-*KPwy2$8dqLVDZgaU+a`rwUeATrX|t8nwo~(q& z${p~PXjnKQ6;;;f&)1veUcOvzn6uk++g4CeKz0e`A=qVivQL%gv4?H38079_g_))E zckrnMwa}Z546*sC+U|RsA%sq|;ueR{Jx-=;Q%WDLH!9wpj-r=j4oe?F%v3*FpB5n^ zRD1V_Z?}}If#ZK+YdiI#q?w^a3`L91nE_`%n62+aT3tL9s`)V_q-MunD-;pe@bIwL z%A*%;^*?_`)UuXaNH$0Dv}O4m?~fhppzY?nQ{zsFeVM4T8LRX<6(|gSG4S%6qpm9v zU2$R>J6-R5&Ja9aH?)0qAy`F4MZ;RiYq{pH=R#%2RdBGtG9VO;fAFrNtqd$D$%Xx$<#p1(ZSqwQoh4N}CFll)YXC-+=L9xP66JlurE(;3FU>EH% z0I(q0I}8}#5+mw6 zL*>@~dmroBE)7I}FXo%vH^rbSVcKWqF?CmWZMQ5#^bu0pF=j>S$$);SJ8iV^jB)Dn zuqQ-DMmB#--EJ?k(XHwOMAv0K#N#%@Hx@FP>fCXeiwmVSdg97dz^T|$uqm52MV$L4 zop&~Ff`4!J3px?}%EkuRP6`+sv{?>^s&Mf1K8A+gVPR?O6!fQ_`YIFU=6$YeuP4iH zCfX5K+onHTf7&G^oXx-&N=)$eA0r~>FaoyVPcn2WG}2YG0!_WdAoZFkKS{-?L6b+;+hN9w0@$X zfM)05_!JS53ceK47@LZ%&?I-HZ2a#1dqsQu0$c*hZ(!w+vd$F_Su0j~9C~MBMpisj z(O^?n%VXh2w?60QvfIW&aT`|ftGQXp+&m3oL?RKRFJ9D-(dvRQ<^eEhK;FYjsk&}! zuczB$v)BykOpgwBr;E3R{c|=U)NeSCkSN+Dred4w*2xFl%_?V~WfwYH3!>jOzNcm1 zqs;qk+)KxK>Y9SB%OY92zg$+}w!0ookq9p7+O=zq;H;s>WL=~Q;u;tjFlI=|&sRdK z1kkN*)*yoX1f6J5A6S5)(NNLV&3g6fH2zy{B07pG{9z?1CnvbACe zPSz6%3YX$ysoeQb^N|kSF`b3l0;k%bh7nqT!3>I2xe$*Ve|KJ)ecQb$<7q^FXMeoCYOF6S`B+l2BTmF8 zp+9%_oN_P--Oe4!LfU@<6>0u>KiN}3TRU3EZS4`Vi@iVZS(FqN4T$C;YbgHQf7?kv z=zsvy6lU&ig_>4BDi1Xo85!f3tpH)3Ku^tO?I-bw>z--~ zTX3w}k6y0ax0dV#(QakfxTg;hF2i%fc>ZqXX~oyaTcK!lLV-n}`9g078K-Hmxw$!~ z^SU7xWQcK1kR;i0086h2$Q)8lf4Q}Dn<$5?w>G{HB}#r!QdLccFS2Nl6Cuol2WwN- zig`6v10Avls99}6J*Y>VR*YHQ@CFoFpqPclAbe?*i{*jy&Tl_uxEXZU@j*JADsLbl zJje>)w8K}mv}$HT1;xU}C34pVsI!k_K7Kh!z(@F#8KXx)CR^%|MlCUN-?W>C?N(3K z0U}~&X8pnlZc z7gm*{4O{_EcKZ9XrO<7MN(SAy>%O^p?M04rDpUr*DQznq6}e^uRgy#BJc%%GZdgjw zNV{pJ3Es822wr92*!yZJ{Ceo$siUAH5T=oztghZG16{^faDaT!h!y8YGe7mQ6 zzIQ(+m@d}xT6#SvkT8&PGpY%ym^cEub!?=k$bHA-1lSNZxE&9eLbT!c@<+hyR0bi6 z8f%h}Ufz8~j&O_R3SY-VT@^T5E#nVak&ZpkYRCln<~B+ZA`%uZyoFG8U92n~H7tRm zeO#Cji@jJeIhUfU)U$*4sXdPGi9}ap09s>P?N%s81JKWqz&;=#{qO<{^ zv}bk3a}D{Ec;@Bvzsdd10Ma1B4NV(S>Hqp5>UZL8Cc$Dw_tNgwJ?tX?2e7d;N)h35C;t95clz%nE zYui@`B!Q4-is6176Hg9$xR3YR8N}94!|7{rR1!-UAu9KcQt=k(l2nuX@Xn0N3ic`y zxo8U%8~{T@8d`HfD->ZRefu2@`eCD?Xah{~h+45L6K77hRAyf>4gN;J^7dg0FF~}? z!5hL)ycko%$GM;kzed_g*uT(!?xpNPxZgl2UI*%%xfM{{;RZ*+Es|y17A%Ocn478bC>I+s~`y5rdvEjfE1>&MBYWd+k{BxE6Xm`q&h} zlYNSd|6naMRT-2Y?9Ap>8$Zxry`yOW zg9M020}iR7X57dL-LjPYZxZDt`vTSj%s$`d@4?J1mTS;>-DvzC4s@Y!W~6Y}1Th_J z%#I0IdHA()ASjzmzXy&yc##C4!BZPX1z3?PzAqe(MVR*>71m^WE=$I&P4&K8SIBNP zutA-h#zd$wGBh6eP?8F(-{W9!g8M^iI;p^HjV0CkM%e`(KnZw^-mRz!M4K!2y0K|Y zKAjr$MkYZ1dLAxtwj>Z+26K4{P%|yJUm9lAQkh4{bKUSCyber=vnB57Rt2Tk_0F6OVT`mObcYYl z;P+9XR(~y#B=n{ATYX^9!j4bif>!{EVsPOMXZq3{&^5>e4v;#>n|J;FYEXQlK?ZJ6 zvz!ih`Wv$^SL1@(M{?bQF$tTdW?b6rE7lEXpOqva(Q4KjkTy_ovtPmj3t8@&B?UML z;l?pNHAp!r#S;HFS^1wd1AxzcV`O4v1RpUNJGPVAmr`;h9N4k_-3I>Ooa3a@T1x&m z#-Fft|Gh{06VxjH{p6{Ef!*)#uaQzGDy|EV1~U0_i3wb~>Et2~(z=*@0fQHxAZCv7 z{!bj#e@L+!NYNc_Lbc{>(>uXp3jD2#%@0)bKo%3}3xJw@?6S*<+hOW=9_8#pMnl)U zuSTXu)}cub5}kkjz(kP_tJqK&^mmaN3(OHje(=Bo%2fA_V}^e0oI?0w+nX!qhL2xV zFHs6=WJP(bri`(P5BfgIBc9dEXtIee7Odc0o{o=X-Mbl3=A42w+ol~r;k$>*#`;$?4y-I(V~w7(BYt(&+)+^Q_fkr|088_T{L+IqL;CD43MFiDZN zbixC^+8zGk=R>Bkw(aQWRX6|gf47}&kTxLDA)wIS?&1r!erIqeRxmaexpl$S012-O zLs^op3nC}3x&>UdL=nCYLM4dxWIfYW)F*_aRX@_60<=XJ*QxJb3kU&NvXgk`=np1l zEi%Wyh{9E<9lI?flnxl!Z8H@FN8@wF;G7Y%FV=FA5i7kCA05&^foYI0GE=U#4hPU) zv~V~O8(y`K#Q+Vk&mTt!ykCcn0F0La(Qgn4!oU%k-Fif@Z(rDYI8{Y|+wu%cca8)* zpJOeWV%~8o$z6%+{#T%a7XSz3&)#Myv@g&1o8@%|!WNM(F&5J zv{|-2TEAp%+6|)xn&%S%CTyO|1*mxW#V(+j=6zK((BYPYDKHZ1B{x;7Eb!v7LjTKt z?g0X5^Tnzny)n|!SUg*rQ4OCZ#pZ`K7oImwZG zPQRJdP&dLs^MMeJP)dNi*=|h{2W%OxnZ|3tQXR#%7o$Ulc6=PTZ*Xl-$D{cvvY^i^ zg1IfphoOT0ug8k)*6%M{zlx7@rt9d3Og?loW8OS+t~08>Ei>b$rs24K4F->F*LWyY?510vc2*p$mLM!dk( zK9%(2T-QSEgHcbWtR)zvk#XNl=2crzIJ!&jjeD~WDBsv-z+J(Ml+n8d^Ji%0=&WZB zhlfWM?gzK>CXSki`I;>pPx!;?|MG_~l1b;@LGOD2;70nt+^#0fh?xO^h&=TlTJ;d| zEMINE$7tFW8B)IQFAAlkYO|!?%@*I}FK)nNXNGy8wo1pvLt&Pxtw4mq?6A))!0W2u zr~5$y1{ep&st%f}9+sU$c~M(e9XkB{@dGA`U}iG^9YlS|0+h-JQpICDGqk;llVxL- zw-X*9;vcFHI)C3VPJkY7(Z+#nZ1m8hVf-h!rm)F53FjtF<);^uQnfIORkAaH?4TRp zTZMQ0mD0(&09NoF_c8BxcpLhx-Pg@oK>>Jkr;@Ux4MhRfA;f(;IR+tlq8fakGjqT= zw!{3$iBy$e#1M|Y17Jxe4iuDw)o_99c!q{!xNF-TfH1nj*v9vAKnZWB- z_NzCp0LhF4n;0f9FlBXh728U`qbNp0d)XnJ4W2==^z=nGr=$y!Fq9)1BV3oR`D>`W z!tZ=9xP2+`ARe`kcn1MFhtOH2^``?13s@5?phtoVA4{?+FpVmGFJkV0$qbkWsF&v$tEElAI_Ip#G?ozf!UD4`P9{dKCKJ@ zTH}kXKdE< zY6;9t({~+Zm7p&UK1YmD@9oFu2M8(BRT}VilseC-{he?34A`)LlGND&4G3HjHnZ*g zraFg#9zta;)KvL>zxDoyI>}PIHorl+e1yA=ca}^f6ya_olQfcH^YUsVK{QHCf!n#T zW8))l;b#&}=iNgkx_?pH<*z8M$k@wJ|=qoBof`-RGOmq65#}Jj3&8r7o!j`> z>^&?7i?Z)iMdhTT=+A!7>=#23M< zdV}41{;A@crNDl=rVeO*7@M44q!+Mu-=32r>8r;9j%I}j$E3N&UZB1EGyGS#dAk*O93<2ADPZ0Rhv_L+Y<86k_GId! zz&)G;7Vch!=llgZrjS1^tzM!^2{o?9p`jQJRx$Z@^KE5d;Ue=uFelcN=9ozf z-%-A;Oy2UAnEZ^cuO~->yYrd5H}Gd4&8K5mGB$F&`WZ;7rgD-fUZQ}pwMIY#w=Fb$ z>E=e0b>Eqefb&VW90-CzAQ}j`7MN{yBRi5l>!G=gvCu6nyt;)m7TTe_bdYziF3zkd zej+Qs;Ox7QO)ARc-zuMoO!(wUe!Cc7tiMWa`_&(UVe}QfwQT@lbk55`06by9XM&ex zhL&)p*-sB6N(~fYtDbNCb%FrIpbY!!zQLOwGwzC^{l->%C?ztE2eD1%T%LVX2pYid z^G2*9P`-S{FBHdq=zT{_;i`2Mn}M|ILu6q2B*QFpwInDsM@I|JgIyro|hH95pW=rAzr(BNIu+ zA?>}=>Mjt$j9Bh`oSX}Ol#6fh6^~Z*D+e|S67r%KVV6sVBQVt_v3|X)-1|>lQ#7x; zisO-C1YMi+1qY!M_M4H+*6HmVyIN59*(fPO&_uSO-_#)KsA8J$ukHqfy2|b+HBbXI zajEsw)(>#fkvvHh$AZq8UExNw`M|!DXbauMj`@%eG4iz$vamHb<1({3SY+hZ&IPMc z6Y-O|&69I|0@443hD?~9>v<2-Wy7NhkNGb`OPk62XdB;`AtIgZQr|TZsyV=Y$r!Kt ze|e-s2&hFSNG>n{$W^J94ZVDwwJ;AN@ig))7^VYzRxaZuJ=5GbQstfj!q*v5$Xxi! zuZL^+IPB=8F!t!31&Kop14%>(48}qT1Gup0f9E~~7ak>o*5)SV zWrt9D!5Iyt{^5{@13Y>kfFMu5v~D7j{zP3 zIrsNGe2^^LwA0XmzcX9nASg&n`SPUpDb!u61}q>-81JJx1@c!ZwGzRPA~&>&B8d8qM)+0sOGuJLqF``(ov!U; zI%LzvaUH<|hh-u~+U}ET?Gs20M;NTrW1zE5yT7_3bH+_z-FIx1C9C(H)pBY7=t-L( zZ7{IkQmfTJk)F#YfwctONr`mPhYLySB>oRv;*B+CVHLfC8^P23B@f_)%{EsT4nx^u zo|18>ACZKWCPrw5nHkfUE)NWuFoIH1f zpK;)Ko{dk=(W?%g*NgWwOX`pi_c4by-$?b-eMRZGLx1onx_+I-(=THT{YqKzz~~YI z`XPBa$bYx{e9qvJFzA~ZQmeFIUc0}7PEMKo(ZOQ@VM>IrL1jA%B!`qjz<31nOkeR@ z8>EOp@=aN0@uK?hjK<0#!Ex4r!`&KjgRc}{!V@vPbtW{!i}z|mEm|A{CU=?p%REv6 z3(qf&tXM!wW-Q-*cJftOtf;#Qo|J>>ui}tMj_2Q;b&`{l=a66QIMol8DyD7 zC(7u%pW~EL0qtDk(}D-t>V_>aV)cU>`!hdTbY4E889o%3h8bqteDaP?=+oP+EzaEW zoQg2zfg+`3=N~Te0)5p29gkfjXjwljyAS2fk@E=iGW!ieLPS6U5Go!CxNOGhF+d%b z5GYru>KjPW5tVR4bs;+W;h#4b5s0YvAD<3=+spr=4CDboVIo|FPS6{yztR`;vcd)8hi8n?5Xs@&x{&7lO5BE z^0?~3r_?zG&HYY4V-4ngy~lQGqQH)Eo2&QTc!ap-SQ)B4yBeiO2W?|ck4&L)@uS@= zPa)5vCf$WLl-G=N%#4laas9^L9Oe%WN_gC`d}nj6YlFXSqfF@Fisw1hK_AueX4A&f z5DyP*9gAV&=g`p5#`gAhc~w;G9mu*2So(sF250V_|!RfJ9Eddefz1 z7!LUC8)6je`Z^XWPXFbpY6*D9R80@XdIg?JMnr=0N3Jpb-+#^C&dw@ugN22GcG%Z!cCtz2RR3RugnN8}7{0XnI2OJGyPo$HidTgMg*RLVeGN5z6zj7U*eERs zs=5gl8h8yCg^euqRc{eMIRC;E38v~3*G){`ScwAJACsp@J(+y8rr zaPW91SLb|3=~08V*nIC zmcSwW4@&soO(N=ynDoh(V10j|cyj-LHu-;q^uJ$7K79*Qh@LjIZJjx2=*!ZL#b7Xd z9H?;!fxAbCWk?JQ$-BDSf)1cipKpTBpis$(TSrx!{hyEi|0Rv%Q+hNrkjzBne3(TeebiMkLugnWvQ*GEz}8B3o8u@4XdS+4Hm|dy{e6 ze$Tf)<9l7d+`HJ3UvvEzH{sG^H1|bPR}1t6dxSOx$kVZYmyO_9+6f<Q>LJ#t0rj7ozHH3d2iiLla}0i!eo`uV}1qi3lrlJcTyD@+Nj2W=0tiw5idv#{1aCx`EE!5_Z6f{hp7C0_$4LZPk%Uk z1|{F~MLKPNtJSr@ga(nc!}ln2{=PT*Keu~nw!}s^nDp>#a(!ig`oF&Sq5k{MOTKe8 zA|i@Hz2)NiYn(35zdsT*=sWx_;u^-Jo7eWq_rd{Q+t0xn13jN@kNQ?>)BL#R&d!~f zrDA>jy?UN=O!|kz8Gd>_w%>hSk|4XbW1Q)`<&kro^n$Bv={(K!+spD2zfy?vk08Td zo*a{tLkE}?ra!tpGCVm)P&bmvX-zSker|Oj)!3zlu6Jjk+HqF8ZdXv{liU$X72q*teq3)&?JN0go9>0p}IJZGd6~#%5TXj_*4tGx5@pT24 zikZFBZLa<$FL2zg(d=sKLu}W(?asRB-XD$}IZWOp$K@)jh2{xwGurzQwXO>jFx0mB z&ulf0n;7M3TzN=KJhISFYyRZvOF})~_?p@0KC77B%>wSO9i_%iGEKBJT4|v`F?eaq z5mWPGZ)QvmfAK`f$%H*bd)i{X!*U;LDlpFm9XUC@`?6W9noXEWu3Oq=Jp;CwcFsYd zpupm(qz2BSyi98@Tu^?FqP2UAAi{S4t3i3LqrZ8?`ki{&rBHzrwtKeN@VQ8_EY+5i zG|fM6!Kn$l>g4vYMWue<6rJRXb!Ub{c|5doMr&Ybt5kxXfD}2?_{_CqC3`=@)tLMm z*ZVh0YOHMs(wNJ*?!m3{inxZs1#pG1URAT$ac+n#=7LYK6_T!)589HipG9e@F1u-e zt;KqkT|g#gs&wQ}`+7<+IQ2=GJ^^e`{HV@T0&hyIIM~Yt4%RB-i-UY~$JA+^v>V2( z@;AR3YrXUpcvGXc`;+HEiwwWEv^2U0RV2vP5^&FoX zN$#@Y*{E@HaxM%JqHe9tVdZRXZ5M_}Q1V%^X}3F9Ls;~T?$`hFg_FFYED<-XT7Gq! zgG>%~SME~Sf6qbDN8jV_Za%iYyUhqAR-slB#i+QuPcXzSTK&5muEk_?Jbq+OlB3Ez zLFy76-+s+5PI>zUdP0#GFNAb`|0Tn{J$wp}*A?aKiGE_oiWcKK>t@<##+t;t;h4(t zC8H1_DH&r96lPa`x8hvpetEhGw8-6!(5+GS)~#Dk{GimE#5_FJUQ?Fu9|{}xQF0r` z68Tn+EU{FK(-jfdb=VFBR_4Ul%C{AAC@2(wOJ+2_tM#0A<>4DfX2XQkUpTrX z(2+)8mn58+>F)aiPPc9kWu7x%;x6&NU_ffU;Co%hJJnc`Sw?B{Ng` z_H8h81mb7maUJQAi|76GSv{ zwOTT>fKrt%{nWhhrdr|ijQgMs+F48=KuVFjsZ1kCbq`?uZIyTVMqQaGm4rf>$LrUQ zBRKm~?@Mwm@o68heZ}|pbTZTY5!pB;QafRB?x#n$O9pnA<&8vN;ko(NNWIaEtEBZ$+;Oo{DiNdu6zY$Fz zKDZx!qhU+;xrDMem4KacC0&k6GUu5_q15w7*xbB)->LF}?4xY1O2$?>MLW_P#omtF z9L-zuCBfWpY6zRL;^lEXBFyEHkOcC1Cw|ZW!+!HiwrgHn8z|xnE+hN?#gNoudmlxxRt5!k!R~5(d;JNmN^h9H2`W1a1`k9sV2}zwe?V!=w(89G zMh}S4Oo6JL)NxJq(O2m=!oyHew87yZ{p@fLo)5uYapHB|U!>3PjnN&nov&DaLy=C`IXF0Y zVU!O~Jc7$h^-F3^`gJpK!^-v2~#j{84J=VV=GBo@E52d1#=lIH{!n~B4hNe5$ zu$98>)!*LLRI|jUedJ&tN0BKfj*kcg>UA?^PWz+3J#ugT-|qUJ2jUCB%l;clWt7Zb z^DsU9)NT5*#Gm)?&>n^nC=|JE(?8yv1c@w=kNzIFE8i~IC-rhK1$-JK5xTKy-LF!i zd}DXqv&8;(0@kTIp|$gyTH-H9o6g^5s^Oo)%!_@h@6FjZp1i22;b*@69E;IfTIk)0 zsud}_X+)E@!G^Z2lQZg@8?arj=cG-u4bLlrp5J7$SAMoTw{(K zPo0IAu3_2a5l8QoY0A<`&{|=N8S&V&xZeGMU^{GX*q>8|sa5z_zD$hu7z@Z57;lw| zLJ&Z3Im+Gle3NII1kjJb?vu*O9(UB5^NoJkzveJ07)8X)Y`j+ZXss<$4_`}Rren{f zTeNkKLMjXMo5IwJ8*VB?VM;)M18vCYgr zPM*7&Y%hA3w6-=o6(&~>#m!X?k@q$|`!&p23z3hgrYj^Vm^EzbU#n#53-(AKbWUXD8AcmKrM$<_4drUd^gm z!ucY;Cbzao>0T;!saCMo{*@-kROmNi^mffaX*vGs^m9p?Y$7d|;6mK4dcAumucQ=g zH{aWCZdTvitSB$yFtPpw>u)|`N zG&Y=*djEl83uv^`*E9mT+K)dWCQ^&ymwqNv(f~3FX330Bnr9;OI;SV;g}&eJFus$m zM(3jd#otW~j-$+Cfi^6;-!meJ))ZR4Uq^SejL>?Sj=c(1P%$N9xNt+{3%FYYJ4sjr zuK>5^IgBgyTCxLA5jAxXcZ0Lb#jUN>Qv>EVqdkqDXFM%soSE5K;%O~D6<;(c-*p-# z=s&W*Q5X=fZeIK)QXL-^QpuuP-Q05U@y7n=2e|clSF?ce7FlAx7qQB%i`PO$6az|g z3-p$p3UKYIhB!Bt)u>;Y<&ySKNj@^B4^^;E=Sbc&x!+@{Znpg5^kAx?{gD66aO>pn z`|5M|6!agYt16E|5rgdfBQytznoud=jg)IkULeNz?09|S|iS7_1uE} ztoL|rrMvtdRCu42@N#b1Sn(gE&HL)al zQaaVQXfO$;-NeQgNO)k8;AB*_d)_rxA#q`-+O8Lt$~5NKbb((jfM;9D-k|53nxSX& zh2wSLH0?EuEMsft&VV(b0BgYMYGrNB7Q*TA==pw;279A^Zf-7td1tS$ywGJ9mWB(T z+bdmNN$D0{tb#&93^TOlPu={|)mve>Bkaim&sW+V9ng~Yt(pC#N-DB4q-1ATFtNXl zvllxuGg4VuoVF4^^-L~u*5&t2+u6sBnA0u1t3eSFbNNwA`ywIPf_$tM*voC@lMd{+ z+304s3nwq2LL%mM`6F1mBq=1~_p&p-?b<`AW}2=i+&84TSFx~nK~&AcF4#h9+oVn3 zC*~d)WjxPIyT2BO0@!W8FD#0Ix!QUx>eSmj=~C6O@s=p=(q~Q^=D?Tlv^fvV_@67P zDqx884CMA@L)lEJR*TH@?KNn>N!a^xE`8*s&#{|7KDF8w>^&zoyE+H5X3u@I`xLil zRd+r{*>xxCO*j~dU<&@wb(m4mK0Yo3Pj5C^7CVc%Nzvl=0i8;`xwyIu3zUV^pCo@n=GZO z8s>45&Ya!i?7iz?BOW~pP>%Gfs=7@|CpxG!bVR5wATTgKhwC7(iGTRHL;#O*2cxw* zw?Pv}Au=^AtTEPI{96VC-gkOL?L=wvu-WRiwe@Vi_L4JV(&G z{&G%Yb;K^Qr*vx$t-GLCH;fCk9l=L0>eAbJ5m4uoB1y%FlO)?)#BJ$zJybX25LB+f zBheG9%t$K8kL+=@#T3^zsZQf^ZHD+VCsO<_d}KU~sS9@2UvGYBe7?Jb>1VeRjt7X%`be6l~VXVmj6Efwhm4EidJ{lv~&4QYv#Vn+Au?^|Kl zjm#c|Sc;xhGP}rasC#Gj$2>$_h+m?msxA}Vu^$$_9Z+U4Y=kkh{dE3@79&7D?UMqz zHGwP&fpE6Jemz;`4Qc#RRwjIog2M3#ky5%E6Iw0L$bTz*g>b-n()auKJMhhqQOi74 z=C&D|@JMSp#Bt8|<(3;*gz{TN1q1}FeLo{dIFvA?*U-@5-#G(`bxsZ!a=Li$G7C*QYLrt1dQB@}(6@a9EvmpvA$k6E=cuxFsP8 zNnPF85dqGP83$4O`QF&HwCj}%Z=C2n;uw|dEELkL-^43kgw}Id4FB~tF zmBHk7KjY))XXPuH&^-dkjT?umEzu5cX{j4MTsa~#p{k}9KCxZrOUv!bFF0D^ZA(K< zy*vE=HL`aW1|QkE!pc3f$_Z|6?(zhh{3kdS?-5p3)@I+##)$w>16kQ+mUeHQH;ofq z2WHF7$7isukzBj&_vp6R=2$;r43x9>b||jw%_FTq&4bZRjlsHU&;G6QJjxUcj81ls) zlD;(J5=;l#CB1q55@l)K6Ow_e?CgBG$N9{x{D$~EFn82%Vy{zsr+Gbmc~*jPG0xYH z%+2Wj^nkkGkcbw9plhqx0+Y$9K7!cZnb)M{GnmOrxkynAtCX&dOXlLn-9{WlfVy@i z@L_7{lvpMphM=L;lw?Q{-0+JTI15dpoYrXGHFhA^8T9YTT4~bz=-| z+1XcV()8&KUWht4Z6TT1y9|`pwFX3ubr}$U-Egx>B`_?DToL(&U>YAbt@NW75W(kQ5_lEh8n^Ra=CH<^OUg)Tm z(y1px+2}~7A043^VQz+$vp}Q8zW#RJ^PZE-d&g=Pvni|jynS&(OJ!q_(*IPA@5s$E zRL^#5PTQmiY-()8bQWxTbvbv1Tcb2u418(7K*V*5Esfd1UJG|Hnv`zqomh4tI!;3$ zvH+Q#mingUdoO%Pib5X2hqZaZCx_NW)CX?DW%30VdtwNw*>zO1on-}@iSc0F(bn-9jPIh3;+ zBUEvhTI7UN!MRdwlQQ^`3uKL*T|P#+{~jb*XBJ1c53BYur>Gwc#GY38%u%WF>g7 zH6`72)v^8>{jFi~dMaCKifLgw8`aqM0ufqkNR54_W6R`(-TNpay$d0!vDwWDIcCyP zyqb&7vu`NO;vg!QN)mFZA`x}Yvo`zM`kHenSy8vI@h-*_0nFU^bZiQIR2kflB`!Zv z=Z^ZEsaaZZch1xL`nz}Ue*E~+(VvfL?mrSGx8j3U>kqbkW8M6MDxW{i>ve%-41SbS z&0U6PbomgHD0?BXZk@m&e#o~$Zc&KD-2w4{s_5E2^wGT%)kkJW zX?vNhM{qrEs;3Ai(q4Jx!6ivUlgXm?TOkn~{UT8#)4hd-?S*8I01pU=FLlY`F-o+R z)y)o@;KZ>zb;dYydB{=XlrGsB?h@Co79l%ztFwhbvYF+253BmFVY!I~#HAPtXVaOz zj*eCdM#@`-LR{|W-!$LfNno6-$_Y6Eb&EDUD(>rN&z;+P5EK>}xxjmOTF+19N`od( zhr->vZx$R;lALw+!w!kO&B2V;N<<^ZNR_HN>;nEVu%N%ZG1!dt#usn>?By~i`vkNg zXG!%mrL19e-5D5hEWZd*-1@`~SJeRf<@mh3ylx3T@2{_>916p$6ug@LC;-}Jqh1Eh zB^2Y&VLg8}ms=2!PYQrC;LswLu(V>aU*-x}<|>XL4jxjHedTv^-wg7^ zMECJA_`L9FrlyXPbC=M!eoFGde_S*(s%}^du@e&xxs1hrPED^)-Oz zKoU=YzrVC@W_$4q+-{lfxab|u{-{yRlWkAsD%4%!^j4Tp08X+ zQoMV4Cf(PZ;Y2oA$yHTUrujvlLZwfY_1nkDa8eHurwyac<W5 z^ESW@DVEI!=Q6T09K~)5pzp3)t3MuJ96lBXs3S+``a;X2BjZNwuA-hFW$&7Q`=8k9TDcWb1iO z%qb+uWNXT_$$tB)n5uMyT-cfGuO8N>QAI8M=C%8tUf}oVNrCI*dEs`M4W#HrZ#yBk)mKSw`zb<@rl~;X?KqixoSIfCK+sMKwK}{|DWb$M)0zQ;zLr*D8}j zVBhKIPo6x%-zQAL`}pBQKDs9Xh5EwkZ3g}U|S0RaV^Y!~1l%5UM zClF7pzD^@vS96`_?O8nEc6s{;J*+V7G64Kx3XJpVK3 zzoq5BDFG$#&)?vBij)9Rs5|HX9`0Wf0cPRD-w^esC;Myd%xZa#5{D)4(ZZt#ZL=iD z4$IopmVomyqi3y#umi&THK3qxm7;wbe3 z)7Zb!^o$ed*}=me{%h}soBbOh{~yTvU&#C&T8YD&4NAQ0pE~#=6yBfy#d?@70dxBI zHcI~8@8{sd(J#&Zi{<~%5o3HFKYo1m$`wiWkW@rY5DEYc>E_8K9Sk4W?lv?xo3-=h zpOc3NP(|_i)x3;Q?kK9-lx^RF#3x@t8a{VpRmPl9yARi< zL0_@mok`>@CMqg=pA8`@WW0cb{5s|RBv|s9w1mF?7e?Ij31l$;TW|xS03#$p_JugA z7wG_MIyg8W@P&3G93n)E0(sRFRxEHaP?(ap;D*;Mi@m;oAoWtiFM0wxAko*?hu}`y z>TqfaGGQIQ>B#M62>aK6fB^NUSB_qtZ_HArTK@f1rF1S=IT@L!S4dIfk7)&Mq*z#3 zyxza>Ojbzjf8ok37uA)TS&mm8z628mcoHi@S!Ea_EA@wg` zzMLAs0w}|Te(>PIsR09y%!=)l-@kv`j5yRS?pjoAC1^R$Fg23AwRkZ`6EIj;o2G!e{6&GRFDWwT67y#fmTNWYoRw(|l1sSl_ORNm`VU`T5)Pib}cmF@Z5 zRz`H9Ty(*U1F`)vG0G_7OTPs5Jzg^c|Hb`}?ZiX5F(xlfQ7Ze?x`H@-9 zBcBd{k=@-F);&p~p_J>h-O}JxS5gmju8&#XWJH4~Xw6ZQ(F%^^!V}?n6A<)S1P636 zF-g&K*_z1eCyTM32}CTyw9ykiy<<`+y3F; zCMG81z3p`qb925z+qG$Vm@YXv8Qm(nlUBU@tL8oOaxSr}(Zy1x|+@908DbNJvc-OC8sy=^Gq-?@I6CTn`Evae1*( zb^1l?J?czo*+lNcMNH>G*o|uQ|6Y5CPvQw&&5y>$kDW6-(M8m^-dWaKB_<|f;0g>L zK7qg+61*qEH#4M=!_v}QMvqJI^; z9}(fGME{@VJ^ z_sIqgIJm51dRROqif(s5F4`;U9+rWO6 zjg9x!sW)%lfYX`WcG{RX?tVt7prS&Vw~#0snRB57FUDFA@DCKNI3qVBH8r(+#le)= zLElD!H(B_&3x0oFTMT%_{1j(#Lj>BaAGL)4Jtx)NoK>#8#!@D(%K2TNNk`2gHfT5WMwy*A6c3a!K^kLLc35&NSU-JTu>VjjYrh5 zj65GBUA1Mf2Gwb3GWU87TihnNR}#un|NWgm#bC8$wuHU4 z^m+@!AL1ypDR6N?j3AX^(RF~+Hb;r52dtGZIk$3Ml?RIkwo8471K*E^-+b*j`R+Eh zvPaW?=$vIaVnycO==}&}fs=itpzsk4$6kdYVhj-bd!usKN@d_ko4}!|II3e`FZtks zPn7GvL#|0h(B|f5%mBxu?|65x03x3~f1VlLpJ)7WYa8Mm-lz5Cyu7@|Ad-kFgkggs zBh$fpA{U9cigah;jb1%)YYJeNh)5`7=I2e`bPO$z{bMBRDR^*P^okP)lUw_D_3SgRl0GN2hN#cLKj_kpDhd& z%7Lc2%t zxdkdz@MX@Y3<<^gUp(VXf#_NCd_&<6aT5YJbVs_qNWxsDU0i|1$RcjIz-)lWeo+IQ zwse3&Q)sMyWAKrMweiWxl%ymnFwkJiKqV1%0U*8E_m;77a)NAR3TSIYKK(Xs=>{5! zr{Yhx7yM^3QfT+{xAMb>Ki9QU;&s0)Z|0fyab+e4R6}r&LgfW0lD-=%wZ|+D7N;a9 z`!o7ba^42Zs{r%VFHqg`L|j#VRaI5e;~@ytvKUTF9I{Z`?rT0_@BXj}?t86ELCzT5 zFyhK>*1MH4-`tNlZjO3Z_fMuMrn)Df<-)jXEPA{*n!F)Aij)R7g+$yjLEtvm{akk? zATU>}cu}mHXZ8KUito``}e&dKfwC3VZ^?9+2Nzy8tMK# zn4O)yeXzf-4fmEf7451eC$b(W3L@6s)fHNE9m2;9Mt@?dJoZWm>aOx_Jd$tpq;pY$ zsLS9~Bl0{r4#)kise#;gF#D-<@BZX%Mog*3Vj*nm2?(nvoKw$((HKs4dy>Dh&)5s< z!)~lJe@%a})5Y;V8r>ewi^;Q{Q-U?hfp$@gxd`8aG|I9MIMf<=z`{c~vZic*XtQw) z1U5WMRHvhAeP|L(N(9-|3uM4g#QkJ|0C^sQ?dcfg4d9A8?)8!i<|RVPPJMIVr4a`e z6e$iu;;*?LcQ{Up?Pkr+&hk9@{`P7f5YA&3fCAU{&Gc$&8=xl$nGRC%h)e|A8h=)N z?W$TPP$_$VEkuiD37l>wB-hR6{Kn0Qgt|PC7+g+U+(f95Nx($7%`WtZ%Uj+P8C59* zf4OKFqu-vwu99SY!TJ}+Y-O^-^Bx7HL-05k=36X(dQiPRy zdV7PcXb`xET|gPms9aP_uW#hk*525*n~?eONbSDWSKAW?a*BZ2HsXM1AVIc5{Mh0N zAduLSsF$bZ;MjIO0;EFlIRW1RqJU9_AxY;nki~$g@k3knS9gWZt(Sn^IglQ3;EPn4 z5%UBxb#aOaI)6%Vwtw0-#`_7_syNYg_XV9ZAeg;s@A;U+$)wF0$Zp~RLYqISimqN&y8*}tiQd~fpqsS=G4se!!YT4)(@r21 zW1tv-uzgqa5dhIu{~gv!Qhf9;dMOZ$vo0w8o?d%~fPsLIx2K8#H{~ikhLCK8>=77C zWQ@B^iyQx_Bn@o;kWbRUn)-c_^DibPw^0rhWbj%;p2_fK*uAY0uBo|A{1tYdl9T9ByLEjPH! zeDf8J@{)Yv=?%U>#d-kCl$kZH>?;~mP0Bo2#xt+C1If{W4F`*Nne#vxg!%w(1#2pT zou1OGN{V%9bXvT@#-#e5?o&d5cKN_(z2CyVt4H}T_Uk+JC*DTExg)efSRMhzGGWy@ z8k#uB((@pbfyM(5>eJ#UDCIhRO2{hKFA5{_GGHJQ+i#Ytrs&NTXgoqYgH!v%i6jyH z9s{h@O?`SwVFEfyX3<{DfZ%Yb)wsO;2mpN`Cr{0ddTu66(a5%h#dbK*Y??+EE`B`6 z&>0tF8#FoK%jW3_8wms;P4rtP)v-4x21duI#Lez9u z`aKTsxtGr&CNZr69^;i8p%fni;gP!T;)zx3h3IKx6{@MyNeIZj{E49%(IM3wBN+Cw{HQRal zmiX%fb1u6xEa(t-!O;sJzlHkieg8o7imaN`;7l2qjoOdkC{lvE&8~p>l$btFxkc1_-F>W5*pTqqUk}f;SH|DULLTV%WBxG z@y6$hC^^S#V{%=hJZD7<&3CyGBur>sE-X@nQ4HDGJ$# z5&=}?QqpMiXU~4X;^=b;8J!|Gbs7m%i*>q6LOD!~+7<@PQimqod=KOPnA~E3#h^3A zhD6;?5vcITB`&wIfU5#$%?Gfj;3+-9W+_=JYBXZffG}EM&+TS+iiRfjU!A{l`Ysz) z4xWu=5O2Q015Y4^+SQW~GN_z3DI&7`^7)@rv%v?ArLDLc7s+S0riW5v-~(#`cH0{4 zHUyC<#Pi1Fz5@&gG3R-}M*qtmqELdU!xoW9QiPQ$i2BP?{z+UA^a~Y9`p0kor9ud! zRuFaApz-%N2=ed;p#XT+wu0Qf?_ z&;-F&=mdO2^Q~`jE_D~oX*?c8C%(#;t+Yi5ztieRjho)8^KAFr0^+Vy>OeMdXe}0o zGohv(RwoFxm$=HH&s2K%!f-x`I@s#f?aAg(Nr_gjrCwj!B!~eAB-KF#iL}$b>Mxd#X|Ptz)v_a1f6D zPnQ=|xXf|aC3Vh4+W*0$)!4Co?&6_t{eW?4iCPYv;@_;}OeZ1e)c{|~`O_f?-_?*Z z+Ed7aZq$|x#=!uq!5P#f6K6N?EH`#h>%v-SS`RlUc8XE8tCO<}Fzt={?eCd@fr;vnN)L2?8u0#hQB;HD# zH`ZHU7-2;tmx=BG=CsyQIqsglA>&^xU8~9pya1hr5AoRy=8AA(e8CH(ePKdSD(?%U zaqPsF4GX=<(^8n+lK}@@xeoI{AApJ8mKNecF(>FY=ENg+<__*Zs+U#I((`|6*9+X` zWNdfHhCEy{U+_{l2#wcV`vXjrOMMQ5K_V?^ObIUe{B^%|;OZX5L|)U#?c>rpJ?}_~ zRSr0gHC0mT=O-Yt^xmLa;C((EH`@D9DHiz0>KT{|3c#89Dvpk6{Rqt#)_ZJ1tm{2L zwp_5ot3{eXqlGw3{aZE!m|8DCLg?qtt_>|)4hQ!;ZVV68=5b$S7s7sDwD+M`A0p`f%3BWXcjvqhXUrL2Somi?osJQYV zyeq|QSy_SjrTg)hpkw|(Fovo7vvK8bZB5AN(y>j%tjm73?kQ^BT@pC}0!q=FzS z8$iLJsL(JWQggJ~!N%aCm-5qL;_vrdQ()qAWqG1HS@fU@R2Nu_EKI&8?t4Ix#R>$3 z7MZbFmW#l>d%z}qUs1g6hQDs7W8wtFDoD^q48^1;+77S7hnaJ(0qo#K<&BachGl^D1O&BLPp#9yp*N z$|YGEgz&=9u@U^-Y_u9NGKisv>n*@K{jSjteR)1r=XD~|h6b!-Hb+M%h>@>B6vdbf z!Sq+m>0_9JrQbhHk4+*3>VtAV@6{_?Cs&S*`x`H|DkkkzZ#E$vZ#{OP9l(&02f;_K z+o3hHub{JMyM5yim74k(1qV`(K5ifvG``OciY+p*vs~s19cR)f)TyJQD+_>PJ$x_A zty7^`?5zrgN<35`P$=S)c<=Z=z<|FEN;*BJDmULN*-}GCN_Cpq@^-FYzsnOkmN+rG z0(wpA;L*nC&fqGsx+k~3Zn?NPdS7rYGw9zQq6 z*yelM*-`{QIoKaLz$_WS4mALm$@BMIywLfXc_9ky4nzqC2&2AETJA2BS-&!nDVlu~ zIImZStdz9Ja#PZFwvSMc7y1SrGKw`-6=>|#8ES}AdP%+K531!?N22gP6(IS*#Zsp- zMx4S#!H)nAU$MOi0yDPg-|KhKIoG8qo50$$HPE&lujQUTb#>LKG2pQ8?~G~c{@fBD&xPF5;dQ0ic4 zuFlKcWqqX&9ZCp~7c9`N_qPfH4GqM>(DkZKdBkUW6;JsmaR!DSzEpWj% zTG7x1xXe6@qcy>eORjpx@1u!m*6|P%4mk)2D_@$Ma!kvT+`e@Hm`nA?mbrE3E6J^> z^oR)MAjf=MGJdb1OpR^dAg4!f+uqG*M8d<}4Ly?g@5W69zQNYB z!^v(2UZha)a6G;iDG%ljLWrFs^wsUa1DSY6RV|gl^Ur<>OFJ2eeh=#5j0UUUL(Ufq z4HIVefsZPpj9P?OzUJPT3#K{nOD7uuI!r$L8&JXyxuDR*g-tzUM1p-jow1bfNC$ym zo+FJvh3qJrf#G{+Nan%>Khel^On!Xlk}>E_aOJ)6mY2PQo z)xLxNvpsZEINAEHjiDW+hm>X2#X!K!AWx=&Is-f&xPZ`VN&t2^Iv3IfZEBwlG%s%= z-By*Qeb4)cl~TwKoT>R+~ekD zXNE4u*d(A{h*MrQp*jMv&K2||-NqyI zHf})j(ejsIASX}D(o~nVHcr}#lMdMHJ7QkEau9kz#&ZU(e#iskpzgdS>2*paNpS6+ zdLxZ3YMx@F>7rfkRv&TV%|ydzjR1e3LlUSVAJP}HdHw!rse4UG&pERn5UBb4? zTlb9QQDzNmB&3|mB2yG2~fEkWP5 zr-K+Hws4=?-g}^_h(s9v$P&_zH*^x~FIJj5Xyo6)f;TeuILx@g9!%iwJT24&Jdci>}ZOqQs>2qCT8_sPvgh2FHxi50QiM=PiV7~7DXx-1ctrg zQRmv51RurgGzzv}R_W#dhrwG8F4fOefl|{01M@e}pH27cwM%?T8Zs`L0KpVq2$JC} zZZ|xFFqmT6C94D4Q6^+;j?PtWX+SS7uA~rYYJfa&Apfdx;!)CIdH<2M`(@hQVDR`iiX z{lmz7MX7gDBMC`v%tj!@Krrj;>_q^W1k*CdRa=-Ef_ZJi!Tq!WKD`D;D`J4yu#k54Xp0N6vm;Q~=9Q^Q^{F>`e_@l(njvc#;EQ@g}L&4+`F z+Sz{4rQxpgbr<3QsL#Bl0A_vtM=%#c!$tBeaKdJN zsw~O2+?&tU06&VFQ+HWTf}iM^T;JlXU`0~dn)Uh6TpQ@oeuOj`Um`i1PeR|e_BLSW zofrS{a4bkIO?cFzs|MuercAzHw5JuJTy-SGd>e>78pSUCG#i?ip z3I!Q5>CG1m@JzbHb}Yp?Q67`qrq@U2_}@!&aM$`i8Vzrr++Q%rLt3+jD_@kTVS{=`7E=ruV-M4F-MY)DzH>izT6c$8=! zwCR&vq=r~Q_Ny7hAQa0*f3ZQ|ZaG1KZ&kJyn9#HnhGagF!#IeYgk}Muucz4%hzSMS z`})n?etL*Nh6r-jHX9Zp26P-=%|{}1V~}WQbxk6CYupNH7(OLozNTLLyx*v4@Mq~h zSgW4Dl0gKE5TK2f|1#X&M!C#Vy!5e2$GG>U_x1})5C6*+hJxP#jJ;p3>(*mF@+Goz zm7U_|zwpi*l10h^RY>y}c8BO!Z~hA)$+nTLfU;&f(|E7fc^5Gm8TPjDRzTnQ6>sVk z0M?tR9;Iz?1AOEXd1owKUE~>=oi^n~03b_KN05GM@HML`<+_D?O3Vt>@pW^XhiBxkYLT?L>-f2_gO!k~pp0dxS#f49%5*BtXN)u+@Rm+yZbk!_5lM zJmfJ5-b!AQfib!!e%_(1hhI_NW`s5ThIyw=8A&L?GUdf_uTeI77rRF@;r@M!n zp`2KB{UK9RiyKz5H(Mnk5gRixhO~@V`-q?UxW09zJ*p-Xgz=!}>QRlp?0Ny{7 zRBOxryX55%$n{ShqG_m|KTG*bzAHb$3H&wP=ndw77rfbc3>F2Y-UI~M6{q}ve5*L6 zoTlxx>-O{+Hns9tg$T)LgG39F(=k@uLn+xFs zasH&A(-Z}~%0KT9R=ME6*7GPXNj*39c)6;5x?*d4Z>Hr2p4*7a?hC=;kr6XE zL&A$0AAnL*H(@1^ft@Rl#z#eKX=!O7-!L+xC@o8e&ce~*H5@|`U1da}xB||gNN%=v z!XCuMftE#pJoyxPG6t4bFC~lOKtBH9{|Tkz24JI`_icO>QPKbX9ejL=K>+V7iUx+K zdP9gJvHa(~f4+l{#U-uq-SGI3sgEB+QU3hDzk`q6yvGSq1g6MRV6_}y|9S79@5~D$ zZU8X=519y-k31lb3|s+V`F}3|E3!37WNU}xAzS+izoqhL9si8??_7tE|NnicFJk(y z;bwj=u`r@yp0=GvU1Ao&6K`;Vqm*^TcMI4fM!9{02kx`OMOt;7K?NcQI3CZ8x>}6L z23ijFFbBDR1u2wx19CfuuOR~TX^jxYbRL96VCER=J|YNKa0~zS+Q%qV%s3(%htncg zA`7Ga*K5eMh`1h3+lNextoFZNLsom@?`aX)6oA$I*K5dXt&r6s(>?{ucPSCtnf~iF zWVQdfTM*6vdhKwv|GC@$FC5YfC=LBN8$|FAZ{k1C7CEHDyFpfqsLf;M{7xci`Znj`-AQXuF f->?4f)4-jG>n~r@7l{vt?@;KwvUf6W>$v|P1W$_G diff --git a/api-specificatie/drc/current_version/readme.md b/api-specificatie/drc/current_version/readme.md deleted file mode 100644 index e02f35bd4..000000000 --- a/api-specificatie/drc/current_version/readme.md +++ /dev/null @@ -1,65 +0,0 @@ -Naar aanleiding van gesprekken die gevoerd zijn in Nieuwegein en voortschrijdend inzicht heb ik het API-ontwerp voor het relateren van informatieobjecten aangepast, zie [redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/Documenten-relateren-aan-andere-relevante-documenten/api-specificatie/drc/current_version/openapi.yaml#tag/informatieobjectenrelaties/operation/informatieobjectrelatie_create). - -De naamgeving in deze nieuwe versie is consistent gemaakt met de naamgeving van het RGBZ waarin zaken aan elkaar gerelateerd kunnen worden met de relatie "heeft relevante andere". - -![afbeelding](https://github.com/VNG-Realisatie/gemma-zaken/assets/37145898/b5fa783f-e61f-42a3-a7f1-a5ee9b4578dc) - -Op dezelfde manier modelleren we de relatie "heeft relevante andere" tussen informatieobjecten: - -![afbeelding](https://github.com/VNG-Realisatie/gemma-zaken/assets/37145898/87aa8534-97a6-49d0-b13d-aa8ca720876d) -De relatieklasse `INFORMATIEOBJECTENRELATIE` is vertaald naar het REST-endpoint `informatieobjectenrelaties` (in meervoud). - -In het volgende voorbeeld leggen we de relatie tussen de twee documenten `` en `` waarbij het laatstgenoemde document een publiceerbare versie is van de eerste. - -`POST /informatieobjectenrelaties` - -```json -{ - "informatieobject": "", - "relevantAnderInformatieobject": "", - "aardRelatie": "publiceerbaar" -} -``` - -Deze relatie wordt als conveniance ook zichtbaar gemaakt in de resource `/enkelvoudiginformatieobject`: - -`GET /enkelvoudiginformatieobjecten/<>` - -``` -{ - ..., - "relevanteAndereInformatieobjecten": [ - { - "informatieobject": "", - "aardRelatie": "publiceerbaar", - "richtingRelatie": "standaard" - } - ], -} -``` - -`GET /enkelvoudiginformatieobjecten/<>` - -``` -{ - ..., - "relevanteAndereInformatieobjecten": [ - { - "informatieobject": "", - "aardRelatie": "publiceerbaar", - "richtingRelatie": "omgekeerd" - } - ], -} -``` - -Het attribuut "richtingRelatie" wordt gebruikt om de waarde van het attribuut "aardRelatie" in de goede richting te lezen. - -In de aanvullende specificatie van de standaard leggen we vast dat het attribuut `aardRelatie` aanvankelijk alleen de twee volgende waarden mag hebben. - -| Waarde attribuut 'aardRelatie'| Beschrijving | -| --- | ---| -| `publiceerbaar` | Het relevante andere informatieobject is een publiceerbare variant. | -| `ongespecificeerd` | De relatie met het relevante andere informatieobject is niet gespecificeerd. | - -In de toekomst kan deze tabel eventueel worden uitgebreid met nieuwe waarden als daar behoefte aan is. diff --git a/api-specificatie/drc/current_version/relateren-docs.md b/api-specificatie/drc/current_version/relateren-docs.md deleted file mode 100644 index 51c585865..000000000 --- a/api-specificatie/drc/current_version/relateren-docs.md +++ /dev/null @@ -1,80 +0,0 @@ -Naar aanleiding van gesprekken die gevoerd zijn in Nieuwegein en voortschrijdend inzicht heb ik het API-ontwerp voor het relateren van informatieobjecten aangepast, zie [redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/Documenten-relateren-aan-andere-relevante-documenten/api-specificatie/drc/current_version/openapi.yaml#tag/informatieobjectenrelaties/operation/informatieobjectrelatie_create). - -De naamgeving in deze nieuwe versie is consistent gemaakt met de naamgeving van het RGBZ waarin zaken aan elkaar gerelateerd kunnen worden met de relatie "heeft relevante andere". - -![afbeelding](https://github.com/VNG-Realisatie/gemma-zaken/assets/37145898/b5fa783f-e61f-42a3-a7f1-a5ee9b4578dc) - -Op dezelfde manier modelleren we de relatie "heeft relevante andere" tussen informatieobjecten: - -![Alt text](image-1.png) - -De relatieklasse `INFORMATIEOBJECTENRELATIE` is vertaald naar het REST-endpoint `informatieobjectenrelaties` (in meervoud). - -In de aanvullende specificatie van de standaard leggen we vast dat het attribuut "relatie" de volgende waarden mag hebben. - -| | Waarde attribuut "relatie"| Beschrijving | Inverse | Read-only | -| --- | --- | --- | --- | --- | -| 1 | `is_een_geanonimiseerde_variant_van` | Informatieobject A is een geanonimiseerde variant van informatieobject B. | 3 | Nee | -| 2 | `is_een_vervanger_van` | Informatieobject A is een vervanger van informatieobject B. | 4 | Nee | -| 3 | `heeft_als_geanonimiseerde_variant` | Informatieobject A heeft als geanonimiseerde variant informatieobject B. | 1 | Ja | -| 4 | `is_vervangen_door` | Informatieobject A is vervangen door informatieobject B | 2 | Ja | - -In de toekomst kan deze tabel eventueel worden uitgebreid met nieuwe waarden als daar behoefte aan is. - -In het volgende voorbeeld leggen we vast dat `` een geanonimiseerde variant is van ``. - -`POST /informatieobjectenrelaties` - -```text -{ - "informatieobjectA": "", - "informatieobjectB": "", - "relatie": "is_een_geanonimiseerde_variant_van" -} -``` - -De notatie `` staat voor de de URL-referentie naar het informatieobject `doc`. - -Deze relatie wordt als conveniance ook zichtbaar gemaakt in de resource `/enkelvoudiginformatieobject`: - -`GET /enkelvoudiginformatieobjecten/<>` - -```text -{ - ..., - "gerelateerdeInformatieobjecten": [ - { - "informatieobject": "", - "rol": "is_een_geanonimiseerde_versie_van" - } - ], -} -``` - -De notatie `<>` staat voor de uuid van het informatieobject `doc`. - -`GET /enkelvoudiginformatieobjecten/<>` - -```text -{ - ..., - "gerelateerdeInformatieobjecten": [ - { - "informatieobject": "", - "relatie": "heeft_als_geanonimiseerde_variant" - } - ], -} -``` - -Samenvattend zijn dit de verschillen: - -- In het informatiemodel is het objecttype INFORMATIEOBJECT hernoemd naar ENKELVOUDIGINFORMATIEOBJECT voor consistentie met het RGBZ. -- Attribuut "aardRelatie" in het informatiemodel is hernoemd naar "relatie". -- De relatie "heeft relevante andere" in het informatiemodel is henoemd naar "heeft gerelateerd". -- We maken expliciet gebruik van inverse relaties in plaats van het attribuut "richtingRelatie" om de richting van de relatie aan te duiden. -- In de resource `/informatieobjectenrelaties` is het attribuut "informatieobject" hernoemd naar "informatieobjectA" en het attribuut "relevantAnderInformatieobject" hernoemd naar "informatieobjectB". -- De relatie `heeft_als_publiceerbare_variant` is hernoemd naar de (inverse) relaties `is_een_geanonimiseerde_variant_van` en `heeft_als_geanonimiseerde_variant`. -- De (inverse) relaties `is_een_vervanger_van` en `is_vervangen_door` zijn toegevoegd. -- De relatie `ongespecificeerd` is verwijderd om wildgroei te voorkomen. - From 93b8f64995954c0c74cba2bdc06835810284cedb Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 22:24:08 +0100 Subject: [PATCH 05/17] Delete more local files --- api-specificatie/ztc/current_version/test.txt | 1 - .../ztc/current_version/test2.txt | 0 .../ztc-api-catalogi-1_3_2_copy.yaml | 15581 ---------------- 3 files changed, 15582 deletions(-) delete mode 100644 api-specificatie/ztc/current_version/test.txt delete mode 100644 api-specificatie/ztc/current_version/test2.txt delete mode 100644 api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml diff --git a/api-specificatie/ztc/current_version/test.txt b/api-specificatie/ztc/current_version/test.txt deleted file mode 100644 index 94d27e26d..000000000 --- a/api-specificatie/ztc/current_version/test.txt +++ /dev/null @@ -1 +0,0 @@ -daadsadassada \ No newline at end of file diff --git a/api-specificatie/ztc/current_version/test2.txt b/api-specificatie/ztc/current_version/test2.txt deleted file mode 100644 index e69de29bb..000000000 diff --git a/api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml b/api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml deleted file mode 100644 index 0ca9611a3..000000000 --- a/api-specificatie/ztc/current_version/ztc-api-catalogi-1_3_2_copy.yaml +++ /dev/null @@ -1,15581 +0,0 @@ -openapi: 3.0.3 -info: - title: Catalogi API - version: 1.3.2 - description: - "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ - \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ - \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ - \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ - \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ - wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ - Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ - \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ - \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ - \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ - \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ - \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ - \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ - \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ - \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ - \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ - user_id\": \"\",\n \"user_representation\": \"\"\ - \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ - \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ - \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ - vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ - \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ - \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ - \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ - \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ - \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\ - \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\ - \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\ - Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ - \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ - \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ - \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" - contact: - email: standaarden.ondersteuning@vng.nl - url: https://vng-realisatie.github.io/gemma-zaken - license: - name: EUPL 1.2 - url: https://opensource.org/licenses/EUPL-1.2 -paths: - /besluittypen: - get: - operationId: besluittype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle BESLUITTYPEn opvragen. - parameters: - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - schema: - type: string - format: uri - - name: zaaktypen - required: false - in: query - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - schema: - type: string - - name: informatieobjecttypen - required: false - in: query - description: - Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten - van dit BESLUITTYPE worden vastgelegd. - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - besluittypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedBesluitTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: besluittype_create - description: Maak een BESLUITTYPE aan. - summary: Maak een BESLUITTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitTypeCreate' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /besluittypen/{uuid}: - get: - operationId: besluittype_retrieve - description: Een specifieke BESLUITTYPE opvragen. - summary: Een specifieke BESLUITTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - besluittypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: besluittype_update - description: - Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het - een concept betreft. - summary: Werk een BESLUITTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitTypeUpdate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: besluittype_partial_update - description: - Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept - betreft. - summary: Werk een BESLUITTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: besluittype_destroy - description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft. - summary: Verwijder een BESLUITTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - besluittypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: besluittype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - besluittypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /besluittypen/{uuid}/publish: - post: - operationId: besluittype_publish - description: - Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten - API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke - wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet - worden, dan moet je een nieuwe versie aanmaken. - summary: Publiceer het concept BESLUITTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: OK - '400': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '404': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '401': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /catalogussen: - get: - operationId: catalogus_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle CATALOGUSsen opvragen. - parameters: - - name: domein - required: false - in: query - description: domein - schema: - type: string - - name: domein__in - required: false - in: query - description: domein__in - schema: - type: string - - name: rsin - required: false - in: query - description: rsin - schema: - type: string - - name: rsin__in - required: false - in: query - description: rsin__in - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - catalogussen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedCatalogusList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: catalogus_create - description: Maak een CATALOGUS aan. - summary: Maak een CATALOGUS aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - catalogussen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Catalogus' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Catalogus' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /catalogussen/{uuid}: - get: - operationId: catalogus_retrieve - description: Een specifieke CATALOGUS opvragen. - summary: Een specifieke CATALOGUS opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - catalogussen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/CatalogusExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: catalogus_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) CATALOGUS opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - catalogussen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /eigenschappen: - get: - operationId: eigenschap_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle EIGENSCHAPpen opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - eigenschappen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEigenschapList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: eigenschap_create - description: - Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Maak een EIGENSCHAP aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - eigenschappen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /eigenschappen/{uuid}: - get: - operationId: eigenschap_retrieve - description: Een specifieke EIGENSCHAP opvragen. - summary: Een specifieke EIGENSCHAP opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - eigenschappen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/EigenschapExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: eigenschap_update - description: - Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het - bijbehorende ZAAKTYPE een concept betreft. - summary: Werk een EIGENSCHAP in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - eigenschappen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: eigenschap_partial_update - description: - Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Werk een EIGENSCHAP deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - eigenschappen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedEigenschap' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: eigenschap_destroy - description: - Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Verwijder een EIGENSCHAP. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - eigenschappen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: eigenschap_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - eigenschappen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /informatieobjecttypen: - get: - operationId: informatieobjecttype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle INFORMATIEOBJECTTYPEn opvragen. - parameters: - - name: catalogus - required: false - in: query - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - schema: - type: string - format: uri - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedInformatieObjectTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: informatieobjecttype_create - description: Maak een INFORMATIEOBJECTTYPE aan. - summary: Maak een INFORMATIEOBJECTTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /informatieobjecttypen/{uuid}: - get: - operationId: informatieobjecttype_retrieve - description: Een specifieke INFORMATIEOBJECTTYPE opvragen. - summary: Een specifieke INFORMATIEOBJECTTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: informatieobjecttype_update - description: - Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen - als het een concept betreft. - summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: informatieobjecttype_partial_update - description: - Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het - een concept betreft. - summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: informatieobjecttype_destroy - description: - Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een - concept betreft. - summary: Verwijder een INFORMATIEOBJECTTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: informatieobjecttype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - informatieobjecttypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /informatieobjecttypen/{uuid}/publish: - post: - operationId: informatieobjecttype_publish - description: - Publiceren van het informatieobjecttype zorgt ervoor dat dit in - een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype - zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren - nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. - summary: Publiceer het concept INFORMATIEOBJECTTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/InformatieObjectType' - description: OK - '400': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '404': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '401': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaattypen: - get: - operationId: resultaattype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle RESULTAATTYPEn opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: zaaktype - schema: - type: string - - name: zaaktype_identificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: status - schema: - type: string - - name: datum_geldigheid - required: false - in: query - description: datum_geldigheid - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - resultaattypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResultaatTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: resultaattype_create - description: - Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Maak een RESULTAATTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - resultaattypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeCreate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaattypen/{uuid}: - get: - operationId: resultaattype_retrieve - description: Een specifieke RESULTAATTYPE opvragen. - summary: Een specifieke RESULTAATTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaattypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: resultaattype_update - description: - Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het - bijbehorende ZAAKTYPE een concept betreft. - summary: Werk een RESULTAATTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - resultaattypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeCreate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeUpdate' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: resultaattype_partial_update - description: - Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Werk een RESULTAATTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - resultaattypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedResultaatType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: resultaattype_destroy - description: - Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Verwijder een RESULTAATTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - resultaattypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: resultaattype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaattypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /roltypen: - get: - operationId: roltype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ROLTYPEn opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: omschrijvingGeneriek - required: false - in: query - description: Algemeen gehanteerde omschrijving van de aard van de ROL. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - roltypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedRolTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: roltype_create - description: - Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Maak een ROLTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - roltypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /roltypen/{uuid}: - get: - operationId: roltype_retrieve - description: Een specifieke ROLTYPE opvragen. - summary: Een specifieke ROLTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - roltypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: roltype_update - description: - Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een - concept betreft. - summary: Werk een ROLTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - roltypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: roltype_partial_update - description: - Werk een ROLTYPE deels bij. Dit kan alleen als het een concept - betreft. - summary: Werk een ROLTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - roltypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedRolType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: roltype_destroy - description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft. - summary: Verwijder een ROLTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - tags: - - roltypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: roltype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ROLTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - roltypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /statustypen: - get: - operationId: statustype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle STATUSTYPEn opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - statustypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedStatusTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: statustype_create - description: - Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Maak een STATUSTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - statustypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /statustypen/{uuid}: - get: - operationId: statustype_retrieve - description: Een specifieke STATUSTYPE opvragen. - summary: Een specifieke STATUSTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statustypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: statustype_update - description: - Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het - bijbehorende ZAAKTYPE een concept betreft. - summary: Werk een STATUSTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - statustypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: statustype_partial_update - description: - Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Werk een STATUSTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - statustypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedStatusType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: statustype_destroy - description: - Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Verwijder een STATUSTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - statustypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: statustype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statustypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakobjecttypen: - get: - operationId: zaakobjecttype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKOBJECTTYPEn opvragen. - parameters: - - name: anderObjecttype - required: false - in: query - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - schema: - type: string - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. - schema: - type: string - format: uri - - name: datumBeginGeldigheid - required: false - in: query - description: De datum waarop het is ontstaan. - schema: - type: string - - name: datumEindeGeldigheid - required: false - in: query - description: De datum waarop het is opgeheven. - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: objecttype - required: false - in: query - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - schema: - type: string - format: uri - - name: relatieOmschrijving - required: false - in: query - description: - Omschrijving van de betrekking van het Objecttype op zaken van - het gerelateerde ZAAKTYPE. - schema: - type: string - - name: zaaktype - required: false - in: query - description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaakobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakObjectTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakobjecttype_create - description: Maak een ZAAKOBJECTTYPE aan. - summary: Maak een ZAAKOBJECTTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakobjecttypen/{uuid}: - get: - operationId: zaakobjecttype_retrieve - description: Een specifieke ZAAKOBJECTTYPE opvragen. - summary: Een specifieke ZAAKOBJECTTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakobjecttype_update - description: Werk een ZAAKOBJECTTYPE in zijn geheel bij. - summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakobjecttype_partial_update - description: Werk een ZAAKOBJECTTYPE deels bij. - summary: Werk een ZAAKOBJECTTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakObjectType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakobjecttype_destroy - description: Verwijder een ZAAKOBJECTTYPE. - summary: Verwijder een ZAAKOBJECTTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakobjecttypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakobjecttype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecttypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaaktype-informatieobjecttypen: - get: - operationId: zaakinformatieobjecttype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: URL-referentie naar het ZAAKTYPE. - schema: - type: string - format: uri - - name: informatieobjecttype - required: false - in: query - description: informatieobjecttype - schema: - type: string - - name: richting - required: false - in: query - description: - Aanduiding van de richting van informatieobjecten van het gerelateerde - INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - schema: - type: string - enum: - - inkomend - - intern - - uitgaand - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaaktype-informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakTypeInformatieObjectTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakinformatieobjecttype_create - description: - 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen - als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`' - summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktype-informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaaktype-informatieobjecttypen/{uuid}: - get: - operationId: zaakinformatieobjecttype_retrieve - description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. - summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaaktype-informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakinformatieobjecttype_update - description: - "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\ - \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\ - \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\ - \ dezelfde `catalogus`" - summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktype-informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakinformatieobjecttype_partial_update - description: - "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\ - \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\ - \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ - \ `catalogus`" - summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktype-informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakinformatieobjecttype_destroy - description: - "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\ - \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\ - \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" - summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaaktype-informatieobjecttypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakinformatieobjecttype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaaktype-informatieobjecttypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaaktypen: - get: - operationId: zaaktype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKTYPEn opvragen. - parameters: - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - schema: - type: string - format: uri - - name: identificatie - required: false - in: query - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - schema: - type: string - - name: trefwoorden - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - style: form - explode: false - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaaktypen - security: - - JWT-Claims: - - (catalogi.lezen | documenten.lezen | zaken.lezen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaaktype_create - description: - "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\ - \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `zaaktypeidentificatie`.\ - \ Dezelfde zaaktypeidentificatie mag enkel opnieuw gebruikt worden als het zaaktype\ - \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\ - \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE." - summary: Maak een ZAAKTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeCreate' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaaktypen/{uuid}: - get: - operationId: zaaktype_retrieve - description: Een specifieke ZAAKTYPE opvragen. - summary: Een specifieke ZAAKTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: datumGeldigheid - schema: - type: string - description: - filter op datumGeldigheid voor het zelf en alle onderliggende - objecten - tags: - - zaaktypen - security: - - JWT-Claims: - - (catalogi.lezen | documenten.lezen | zaken.lezen) - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaaktype_update - description: - "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\ - \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\ - \ dezelfde catalogus behoren als het ZAAKTYPE." - summary: Werk een ZAAKTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeUpdate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaaktype_partial_update - description: - "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\ - \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\ - \ catalogus behoren als het ZAAKTYPE." - summary: Werk een ZAAKTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaaktype_destroy - description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft. - summary: Verwijder een ZAAKTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaaktypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaaktype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaaktypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaaktypen/{uuid}/publish: - post: - operationId: zaaktype_publish - description: - Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API - kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke - wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc. - Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een - nieuwe versieaanmaken. - summary: Publiceer het concept ZAAKTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: OK - '400': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '404': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '401': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error -components: - responses: - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - schemas: - AardRelatieEnum: - enum: - - vervolg - - bijdrage - - onderwerp - type: string - AfleidingswijzeEnum: - enum: - - afgehandeld - - ander_datumkenmerk - - eigenschap - - gerelateerde_zaak - - hoofdzaak - - ingangsdatum_besluit - - termijn - - vervaldatum_besluit - - zaakobject - type: string - ArchiefnominatieEnum: - enum: - - blijvend_bewaren - - vernietigen - type: string - BesluitType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true - omschrijving: - type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE - title: omschrijving generiek - maxLength: 80 - besluitcategorie: - type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn - format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: - type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - format: uri - title: '' - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. - title: informatieobjecttypen - uniqueItems: true - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: - type: array - items: - type: string - format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. - uniqueItems: true - resultaattypenOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: is resultaat van - uniqueItems: true - vastgelegdIn: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BesluitTypeExpanded: - allOf: - - $ref: '#/components/schemas/BesluitType' - - properties: - _expand: - $ref: '#/components/schemas/BesluitTypeEmbedded' - BesluitTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - resultaattypen: - type: array - items: - $ref: '#/components/schemas/ResultaatTypeExpanded' - EmptyObject: - type: object - description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. - example: {} - BesluitTypeCreate: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true - omschrijving: - type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE - title: omschrijving generiek - maxLength: 80 - besluitcategorie: - type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn - format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: - type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd.' - title: informatieobjecttypen - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: - type: array - items: - type: string - format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. - uniqueItems: true - resultaattypenOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: is resultaat van - uniqueItems: true - vastgelegdIn: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BesluitTypeUpdate: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true - omschrijving: - type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE - title: omschrijving generiek - maxLength: 80 - besluitcategorie: - type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn - format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: - type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd.' - title: informatieobjecttypen - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: - type: array - items: - type: string - format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. - uniqueItems: true - resultaattypenOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: is resultaat van - uniqueItems: true - vastgelegdIn: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BlankEnum: - enum: - - '' - BronCatalogus: - type: object - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - properties: - url: - type: string - format: uri - title: URL-referentie broncatalogus - maxLength: 200 - domein: - type: string - description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus domein - maxLength: 5 - rsin: - type: string - description: - Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder - is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus rsin - maxLength: 9 - required: - - domein - - rsin - - url - BronZaaktype: - type: object - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - properties: - url: - type: string - format: uri - title: URL-referentie bronzaaktype - maxLength: 200 - identificatie: - type: string - description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. - title: bronzaaktype identificatie - maxLength: 50 - omschrijving: - type: string - description: - De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd - in de Broncatalogus. - title: bronzaaktype omschrijving - maxLength: 80 - required: - - identificatie - - omschrijving - - url - BrondatumArchiefprocedure: - type: object - description: - Specificatie voor het bepalen van de brondatum voor de start van - de Archiefactietermijn (=brondatum) van het zaakdossier. - properties: - afleidingswijze: - allOf: - - $ref: '#/components/schemas/AfleidingswijzeEnum' - title: Afleidingswijze brondatum - description: - "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ - \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ - \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ - \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ - \ in een ander datumveld dan de datumvelden waarop de overige waarden\ - \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ - \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ - \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ - \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ - \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ - * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ - \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ - \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ - * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ - \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ - \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ - \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ - \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ - \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ - \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ - \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ - \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ - \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ - \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ - \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ - \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ - \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ - \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ - \ van het zaakobjecttype het betreft." - datumkenmerk: - type: string - description: - Naam van de attribuutsoort van het procesobject dat bepalend - is voor het einde van de procestermijn. - title: datumkenmerk - maxLength: 80 - einddatumBekend: - type: boolean - description: - Indicatie dat de einddatum van het procesobject gedurende de - uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend - is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten - worden. - title: einddatum bekend - objecttype: - description: - 'Het soort object in de registratie dat het procesobject representeert. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: objecttype - oneOf: - - $ref: '#/components/schemas/ObjecttypeEnum' - - $ref: '#/components/schemas/BlankEnum' - registratie: - type: string - description: - De naam van de registratie waarvan het procesobject deel uit - maakt. - title: registratie - maxLength: 80 - procestermijn: - type: string - nullable: true - title: Brondatum procestermijn - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' - is. - format: duration - required: - - afleidingswijze - nullable: true - Catalogus: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - domein: - type: string - description: - Een afkorting waarmee wordt aangegeven voor welk domein in - een CATALOGUS ZAAKTYPEn zijn uitgewerkt. - title: domein - maxLength: 5 - rsin: - type: string - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. - title: rsin - maxLength: 9 - contactpersoonBeheerNaam: - type: string - title: Naam contactpersoon - description: - De naam van de contactpersoon die verantwoordelijk is voor - het beheer van de CATALOGUS. - maxLength: 40 - contactpersoonBeheerTelefoonnummer: - type: string - title: Telefoonnummer - description: - Het telefoonnummer van de contactpersoon die verantwoordelijk - is voor het beheer van de CATALOGUS. - maxLength: 20 - contactpersoonBeheerEmailadres: - type: string - format: email - title: Emailadres - description: - Het emailadres van de contactpersoon die verantwoordelijk is - voor het beheer van de CATALOGUS. - maxLength: 254 - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden - ontsloten. - title: Catalogus - uniqueItems: true - besluittypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden - ontsloten. - title: catalogus - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS - worden ontsloten. - title: Catalogus - uniqueItems: true - naam: - type: string - nullable: true - description: De benaming die is gegeven aan de zaaktypecatalogus. - title: naam - maxLength: 200 - versie: - type: string - nullable: true - description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. - title: versie - maxLength: 20 - begindatumVersie: - type: string - format: date - nullable: true - description: - Datum waarop de versie van de zaaktypecatalogus van toepassing - is geworden. - title: begindatum versie - required: - - besluittypen - - contactpersoonBeheerNaam - - domein - - informatieobjecttypen - - rsin - - url - - zaaktypen - CatalogusExpanded: - allOf: - - $ref: '#/components/schemas/Catalogus' - - properties: - _expand: - $ref: '#/components/schemas/CatalogusEmbedded' - CatalogusEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - zaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - CheckListItem: - type: object - properties: - itemnaam: - type: string - description: De betekenisvolle benaming van het checklistitem - title: itemnaam - maxLength: 30 - toelichting: - type: string - nullable: true - description: - Beschrijving van de overwegingen bij het controleren van het - aandachtspunt - title: toelichting - maxLength: 1000 - vraagstelling: - type: string - description: - Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt - gecontroleerd moet worden. - title: vraagstelling - maxLength: 255 - verplicht: - type: boolean - description: - Het al dan niet verplicht zijn van controle van het aandachtspunt - voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. - title: verplicht - required: - - itemnaam - - vraagstelling - Eigenschap: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - naam: - type: string - description: De naam van de EIGENSCHAP - title: eigenschapnaam - maxLength: 20 - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - definitie: - type: string - description: De beschrijving van de betekenis van deze EIGENSCHAP - title: definitie - maxLength: 255 - specificatie: - allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' - title: specificatie van eigenschap - toelichting: - type: string - description: - Een toelichting op deze EIGENSCHAP en het belang hiervan voor - zaken van dit ZAAKTYPE. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - Status type moet (onder andere) deze EIGENSCHAP hebben, voordat - een STATUS van het STATUSTYPE kan worden gezet. - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - catalogus - - definitie - - naam - - specificatie - - url - - zaaktype - - zaaktypeIdentificatie - EigenschapExpanded: - allOf: - - $ref: '#/components/schemas/Eigenschap' - - properties: - _expand: - $ref: '#/components/schemas/EigenschapEmbedded' - EigenschapEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - statustype: - oneOf: - - $ref: '#/components/schemas/StatusTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - EigenschapSpecificatie: - type: object - properties: - groep: - type: string - description: - Benaming van het object of groepattribuut waarvan de EIGENSCHAP - een inhoudelijk gegeven specificeert. - title: groep - maxLength: 32 - formaat: - allOf: - - $ref: '#/components/schemas/FormaatEnum' - description: - 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen - worden vastgelegd. - - - Uitleg bij mogelijke waarden: - - - * `tekst` - Tekst - - * `getal` - Getal - - * `datum` - Datum - - * `datum_tijd` - Datum/tijd' - title: formaat - lengte: - type: string - description: - Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP - worden vastgelegd. - title: lengte - maxLength: 14 - kardinaliteit: - type: string - description: - Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP - bij een zaak van het ZAAKTYPE. - title: kardinaliteit - maxLength: 3 - waardenverzameling: - type: array - items: - type: string - maxLength: 100 - description: Waarden die deze EIGENSCHAP kan hebben. - title: waardenverzameling - required: - - formaat - - kardinaliteit - - lengte - FieldValidationError: - type: object - description: Formaat van validatiefouten. - properties: - name: - type: string - description: Naam van het veld met ongeldige gegevens - title: name - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - reason: - type: string - description: Uitleg wat er precies fout is met de gegevens - title: reason - required: - - code - - name - - reason - FormaatEnum: - enum: - - tekst - - getal - - datum - - datum_tijd - type: string - Fout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - required: - - code - - detail - - instance - - status - - title - IndicatieInternOfExternEnum: - enum: - - intern - - extern - type: string - InformatieObjectType: - type: object - description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - title: Catalogus - omschrijving: - type: string - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: omschrijving - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE - voor de openbaarheid bestemd zijn. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - zaaktypen: - type: string - readOnly: true - title: zaaktypen - besluittypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. - title: informatieobjecttypen - uniqueItems: true - informatieobjectcategorie: - type: string - title: Categorie - description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - maxLength: 80 - trefwoord: - type: array - items: - type: string - maxLength: 30 - description: - Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE - kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar - te onderscheiden.) - title: trefwoord - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' - title: omschrijving generiek - required: - - beginGeldigheid - - besluittypen - - catalogus - - concept - - informatieobjectcategorie - - omschrijving - - url - - vertrouwelijkheidaanduiding - - zaaktypen - InformatieObjectTypeExpanded: - allOf: - - $ref: '#/components/schemas/InformatieObjectType' - - properties: - _expand: - $ref: '#/components/schemas/InformatieObjectTypeEmbedded' - InformatieObjectTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - InformatieObjectTypeOmschrijvingGeneriek: - type: object - properties: - informatieobjecttypeOmschrijvingGeneriek: - type: string - description: Algemeen gehanteerde omschrijving van het type informatieobject. - title: informatieobjecttype omschrijving generiek - maxLength: 80 - definitieInformatieobjecttypeOmschrijvingGeneriek: - type: string - title: Definitie - description: Nauwkeurige beschrijving van het generieke type informatieobject - maxLength: 255 - herkomstInformatieobjecttypeOmschrijvingGeneriek: - type: string - title: Herkomst - description: - De naam van de waardenverzameling, of van de beherende organisatie - daarvan, waaruit de waarde is overgenomen. - maxLength: 12 - hierarchieInformatieobjecttypeOmschrijvingGeneriek: - type: string - title: Hierarchie - description: De plaats in de rangorde van het informatieobjecttype. - maxLength: 80 - opmerkingInformatieobjecttypeOmschrijvingGeneriek: - type: string - nullable: true - title: Opmerking - description: Zinvolle toelichting bij het informatieobjecttype - maxLength: 255 - required: - - definitieInformatieobjecttypeOmschrijvingGeneriek - - herkomstInformatieobjecttypeOmschrijvingGeneriek - - hierarchieInformatieobjecttypeOmschrijvingGeneriek - - informatieobjecttypeOmschrijvingGeneriek - ObjecttypeEnum: - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - type: string - OmschrijvingGeneriekEnum: - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - type: string - PaginatedBesluitTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/BesluitType' - PaginatedCatalogusList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Catalogus' - PaginatedEigenschapList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Eigenschap' - PaginatedResultaatTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ResultaatType' - PaginatedInformatieObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/InformatieObjectType' - PaginatedRolTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/RolType' - PaginatedStatusTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/StatusType' - PaginatedZaakObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakObjectType' - PaginatedZaakTypeInformatieObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - PaginatedZaakTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakType' - PatchedEigenschap: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - naam: - type: string - description: De naam van de EIGENSCHAP - title: eigenschapnaam - maxLength: 20 - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - definitie: - type: string - description: De beschrijving van de betekenis van deze EIGENSCHAP - title: definitie - maxLength: 255 - specificatie: - allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' - title: specificatie van eigenschap - toelichting: - type: string - description: - Een toelichting op deze EIGENSCHAP en het belang hiervan voor - zaken van dit ZAAKTYPE. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - Status type moet (onder andere) deze EIGENSCHAP hebben, voordat - een STATUS van het STATUSTYPE kan worden gezet. - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedResultaatType: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - title: is resultaat van - uniqueItems: true - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - PatchedRolType: - type: object - description: Adds nested create feature - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - omschrijving: - type: string - description: Omschrijving van de aard van de ROL. - title: omschrijving - maxLength: 100 - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' - description: - "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ - \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ - \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ - \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ - \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ - \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ - \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ - \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ - \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ - \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ - \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ - \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ - \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" - title: omschrijving generiek - catalogus: - type: string - format: uri - nullable: true - description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedStatusType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - omschrijving: - type: string - description: - Een korte, voor de initiator van de zaak relevante, omschrijving - van de aard van de STATUS van zaken van een ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van STATUSsen - van het STATUSTYPE - title: omschrijving generiek - maxLength: 80 - statustekst: - type: string - description: - De tekst die wordt gebruikt om de Initiator te informeren over - het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende - ZAAKTYPE. - title: statustekst - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - title: Zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - volgnummer: - type: integer - maximum: 9999 - minimum: 1 - description: - Een volgnummer voor statussen van het STATUSTYPE binnen een - zaak. - title: statustypevolgnummer - isEindstatus: - type: boolean - readOnly: true - description: - Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven - is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. - title: isEindstatus - informeren: - type: boolean - description: - "Aanduiding die aangeeft of na het zetten van een STATUS van\ - \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." - title: informeren - doorlooptijd: - type: string - nullable: true - description: - De door de zaakbehandelende organisatie(s) gestelde norm voor - de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij - het desbetreffende ZAAKTYPE. - title: doorlooptijd status - format: duration - toelichting: - type: string - nullable: true - description: Een eventuele toelichting op dit STATUSTYPE. - title: toelichting - maxLength: 1000 - checklistitemStatustype: - type: array - items: - $ref: '#/components/schemas/CheckListItem' - title: checklistitem - eigenschappen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, - voordat een STATUS van dit STATUSTYPE kan worden gezet. - title: eigenschappen - uniqueItems: true - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedZaakObjectType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - anderObjecttype: - type: boolean - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - title: Ander objecttype - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - objecttype: - type: string - format: uri - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Objecttype - maxLength: 200 - relatieOmschrijving: - type: string - description: - Omschrijving van de betrekking van het Objecttype op zaken - van het gerelateerde ZAAKTYPE. - title: Relatie omschrijving - maxLength: 80 - zaaktype: - type: string - format: uri - description: - URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de RESULTAATTYPEN. - title: Zaakobjecttypen - uniqueItems: true - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de STATUSTYPEN. - title: Zaakobjecttypen - uniqueItems: true - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE - behoort. - title: Catalogus - PatchedZaakTypeInformatieObjectType: - type: object - description: 'Represent a ZaakTypeInformatieObjectType. - - - Relatie met informatieobjecttype dat relevant is voor zaaktype.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: URL-referentie naar het ZAAKTYPE. - title: zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - informatieobjecttype: - type: string - title: informatieobjecttype - maxLength: 100 - volgnummer: - type: integer - maximum: 999 - minimum: 1 - description: - Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het - ZAAKTYPE. - title: volgnummer - richting: - allOf: - - $ref: '#/components/schemas/RichtingEnum' - description: - 'Aanduiding van de richting van informatieobjecten van het - gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - - - Uitleg bij mogelijke waarden: - - - * `inkomend` - Inkomend - - * `intern` - Intern - - * `uitgaand` - Uitgaand' - title: richting - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn - verplicht aanwezig moeten zijn. - ReferentieProces: - type: object - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - properties: - naam: - type: string - title: Referentieprocesnaam - description: De naam van het Referentieproces. - maxLength: 80 - link: - type: string - format: uri - title: Referentieproceslink - description: De URL naar de beschrijving van het Referentieproces - maxLength: 200 - required: - - naam - ResultaatType: - type: object - description: 'Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - title: is resultaat van - uniqueItems: true - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - besluittypeOmschrijving - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - ResultaatTypeExpanded: - allOf: - - $ref: '#/components/schemas/ResultaatType' - - properties: - _expand: - $ref: '#/components/schemas/ResultaatTypeEmbedded' - ResultaatTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - ResultaatTypeCreate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - title: '' - title: besluittypen - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - besluittypeOmschrijving - - besluittypen - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - ResultaatTypeUpdate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - title: '' - title: besluittypen - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - besluittypeOmschrijving - - besluittypen - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - RichtingEnum: - enum: - - inkomend - - intern - - uitgaand - type: string - RolType: - type: object - description: Adds nested create feature - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - omschrijving: - type: string - description: Omschrijving van de aard van de ROL. - title: omschrijving - maxLength: 100 - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' - description: - "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ - \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ - \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ - \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ - \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ - \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ - \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ - \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ - \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ - \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ - \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ - \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ - \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" - title: omschrijving generiek - catalogus: - type: string - format: uri - nullable: true - description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - omschrijving - - omschrijvingGeneriek - - url - - zaaktype - - zaaktypeIdentificatie - RolTypeExpanded: - allOf: - - $ref: '#/components/schemas/RolType' - - properties: - _expand: - $ref: '#/components/schemas/RolTypeEmbedded' - RolTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - StatusType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - omschrijving: - type: string - description: - Een korte, voor de initiator van de zaak relevante, omschrijving - van de aard van de STATUS van zaken van een ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van STATUSsen - van het STATUSTYPE - title: omschrijving generiek - maxLength: 80 - statustekst: - type: string - description: - De tekst die wordt gebruikt om de Initiator te informeren over - het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende - ZAAKTYPE. - title: statustekst - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - title: Zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - volgnummer: - type: integer - maximum: 9999 - minimum: 1 - description: - Een volgnummer voor statussen van het STATUSTYPE binnen een - zaak. - title: statustypevolgnummer - isEindstatus: - type: boolean - readOnly: true - description: - Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven - is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. - title: isEindstatus - informeren: - type: boolean - description: - "Aanduiding die aangeeft of na het zetten van een STATUS van\ - \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." - title: informeren - doorlooptijd: - type: string - nullable: true - description: - De door de zaakbehandelende organisatie(s) gestelde norm voor - de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij - het desbetreffende ZAAKTYPE. - title: doorlooptijd status - format: duration - toelichting: - type: string - nullable: true - description: Een eventuele toelichting op dit STATUSTYPE. - title: toelichting - maxLength: 1000 - checklistitemStatustype: - type: array - items: - $ref: '#/components/schemas/CheckListItem' - title: checklistitem - eigenschappen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, - voordat een STATUS van dit STATUSTYPE kan worden gezet. - title: eigenschappen - uniqueItems: true - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - catalogus - - isEindstatus - - omschrijving - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie - StatusTypeExpanded: - allOf: - - $ref: '#/components/schemas/StatusType' - - properties: - _expand: - $ref: '#/components/schemas/StatusTypeEmbedded' - StatusTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - eigenschappen: - type: array - items: - $ref: '#/components/schemas/EigenschapExpanded' - ValidatieFout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - invalidParams: - type: array - items: - $ref: '#/components/schemas/FieldValidationError' - title: invalidParams - required: - - code - - detail - - instance - - invalidParams - - status - - title - VertrouwelijkheidaanduidingEnum: - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - type: string - ZaakObjectType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - anderObjecttype: - type: boolean - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - title: Ander objecttype - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - objecttype: - type: string - format: uri - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Objecttype - maxLength: 200 - relatieOmschrijving: - type: string - description: - Omschrijving van de betrekking van het Objecttype op zaken - van het gerelateerde ZAAKTYPE. - title: Relatie omschrijving - maxLength: 80 - zaaktype: - type: string - format: uri - description: - URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de RESULTAATTYPEN. - title: Zaakobjecttypen - uniqueItems: true - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de STATUSTYPEN. - title: Zaakobjecttypen - uniqueItems: true - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE - behoort. - title: Catalogus - required: - - anderObjecttype - - beginGeldigheid - - catalogus - - objecttype - - relatieOmschrijving - - resultaattypen - - statustypen - - url - - zaaktype - - zaaktypeIdentificatie - ZaakObjectTypeExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectType' - - properties: - _expand: - $ref: '#/components/schemas/ZaakObjectTypeEmbedded' - ZaakObjectTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - resultaattypen: - type: array - items: - $ref: '#/components/schemas/ResultaatTypeExpanded' - statustypen: - type: array - items: - $ref: '#/components/schemas/StatusTypeExpanded' - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - ZaakType: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: identificatie - maxLength: 50 - omschrijving: - type: string - description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van - het ZAAKTYPE - title: omschrijving generiek - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - doel: - type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een - zaak van dit zaaktype. - title: doel - aanleiding: - type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten - van een ZAAK van dit ZAAKTYPE. - title: aanleiding - toelichting: - type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving - van het procesverloop op de hoofdlijnen. - title: toelichting - indicatieInternOfExtern: - allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie." - title: indicatie intern of extern - handelingInitiator: - type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht - bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook - het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator - title: handeling initiator - maxLength: 20 - onderwerp: - type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen - nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" - title: onderwerp - maxLength: 80 - handelingBehandelaar: - type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht - bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', - 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar - title: handeling behandelaar - maxLength: 20 - doorlooptijd: - type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK - van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. - title: doorlooptijd behandeling - format: duration - servicenorm: - type: string - nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE - afgerond wordt conform de geldende servicenormen van de zaakbehandelende - organisatie(s). - title: servicenorm behandeling - format: duration - opschortingEnAanhoudingMogelijk: - type: boolean - title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE - kunnen worden opgeschort en/of aangehouden. - verlengingMogelijk: - type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van - ZAAKen van dit ZAAKTYPE kan worden verlengd. - title: verlenging mogelijk - verlengingstermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling - van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde - bevatten als verlenging mogelijk is. - title: verlengingstermijn - format: duration - trefwoorden: - type: array - items: - type: string - title: Trefwoord - maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden - gekarakteriseerd. - title: trefwoorden - publicatieIndicatie: - type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd - moet worden. - title: publicatie indicatie - publicatietekst: - type: string - description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. - title: publicatietekst - verantwoordingsrelatie: - type: array - items: - type: string - maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." - title: verantwoordingsrelatie - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt - voortgebracht. - title: producten of diensten - selectielijstProcestype: - type: string - format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende - groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst - API). - title: selectielijst procestype - maxLength: 200 - referentieproces: - allOf: - - $ref: '#/components/schemas/ReferentieProces' - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - title: referentieproces - verantwoordelijke: - type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker - die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. - title: verantwoordelijke - maxLength: 50 - zaakobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: Zaaktype - uniqueItems: true - broncatalogus: - allOf: - - $ref: '#/components/schemas/BronCatalogus' - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus - bronzaaktype: - allOf: - - $ref: '#/components/schemas/BronZaaktype' - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - title: bronzaaktype - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - title: Catalogus - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: is relevant voor - uniqueItems: true - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn - in ZAKEN van dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - informatieobjecttypen: - type: string - readOnly: true - title: informatieobjecttypen - roltypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit - ZAAKTYPE. - title: Zaaktype - uniqueItems: true - besluittypen: - type: array - items: - type: string - format: uri - title: heeft relevante besluittypen - title: heeft relevante besluittypen - description: - URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - uniqueItems: true - deelzaaktypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen - bij ZAAKen van dit ZAAKTYPE. - title: deelzaaktypen - uniqueItems: true - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypenRelatie' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit - ZAAKTYPE. - title: zaaktype van - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - ZaakTypeExpanded: - allOf: - - $ref: '#/components/schemas/ZaakType' - - properties: - _expand: - $ref: '#/components/schemas/ZaakTypeEmbedded' - ZaakTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - zaakobjecttypen: - type: array - items: - $ref: '#/components/schemas/ZaakObjectTypeExpanded' - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - statustypen: - type: array - items: - $ref: '#/components/schemas/StatusTypeExpanded' - resultaattypen: - type: array - items: - $ref: '#/components/schemas/ResultaatTypeExpanded' - eigenschappen: - type: array - items: - $ref: '#/components/schemas/EigenschapExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - roltypen: - type: array - items: - $ref: '#/components/schemas/RolTypeExpanded' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - deelzaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - ZaakTypeCreate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: identificatie - maxLength: 50 - omschrijving: - type: string - description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van - het ZAAKTYPE - title: omschrijving generiek - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - doel: - type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een - zaak van dit zaaktype. - title: doel - aanleiding: - type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten - van een ZAAK van dit ZAAKTYPE. - title: aanleiding - toelichting: - type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving - van het procesverloop op de hoofdlijnen. - title: toelichting - indicatieInternOfExtern: - allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie." - title: indicatie intern of extern - handelingInitiator: - type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht - bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook - het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator - title: handeling initiator - maxLength: 20 - onderwerp: - type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen - nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" - title: onderwerp - maxLength: 80 - handelingBehandelaar: - type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht - bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', - 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar - title: handeling behandelaar - maxLength: 20 - doorlooptijd: - type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK - van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. - title: doorlooptijd behandeling - format: duration - servicenorm: - type: string - nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE - afgerond wordt conform de geldende servicenormen van de zaakbehandelende - organisatie(s). - title: servicenorm behandeling - format: duration - opschortingEnAanhoudingMogelijk: - type: boolean - title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE - kunnen worden opgeschort en/of aangehouden. - verlengingMogelijk: - type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van - ZAAKen van dit ZAAKTYPE kan worden verlengd. - title: verlenging mogelijk - verlengingstermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling - van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde - bevatten als verlenging mogelijk is. - title: verlengingstermijn - format: duration - trefwoorden: - type: array - items: - type: string - title: Trefwoord - maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden - gekarakteriseerd. - title: trefwoorden - publicatieIndicatie: - type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd - moet worden. - title: publicatie indicatie - publicatietekst: - type: string - description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. - title: publicatietekst - verantwoordingsrelatie: - type: array - items: - type: string - maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." - title: verantwoordingsrelatie - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt - voortgebracht. - title: producten of diensten - selectielijstProcestype: - type: string - format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende - groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst - API). - title: selectielijst procestype - maxLength: 200 - referentieproces: - allOf: - - $ref: '#/components/schemas/ReferentieProces' - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - title: referentieproces - verantwoordelijke: - type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker - die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. - title: verantwoordelijke - maxLength: 50 - zaakobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: Zaaktype - uniqueItems: true - broncatalogus: - allOf: - - $ref: '#/components/schemas/BronCatalogus' - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus - bronzaaktype: - allOf: - - $ref: '#/components/schemas/BronZaaktype' - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - title: bronzaaktype - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - title: Catalogus - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: is relevant voor - uniqueItems: true - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn - in ZAKEN van dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - informatieobjecttypen: - type: string - readOnly: true - title: informatieobjecttypen - roltypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit - ZAAKTYPE. - title: Zaaktype - uniqueItems: true - besluittypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE.' - title: zaaktypen - deelzaaktypen: - type: array - items: - type: string - title: '' - description: - De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak - kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. - title: deelzaaktypen - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypenRelatieCreate' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit - ZAAKTYPE. - title: zaaktype van - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - deelzaaktypen - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - ZaakTypeInformatieObjectType: - type: object - description: 'Represent a ZaakTypeInformatieObjectType. - - - Relatie met informatieobjecttype dat relevant is voor zaaktype.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: URL-referentie naar het ZAAKTYPE. - title: zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - informatieobjecttype: - type: string - title: informatieobjecttype - maxLength: 100 - volgnummer: - type: integer - maximum: 999 - minimum: 1 - description: - Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het - ZAAKTYPE. - title: volgnummer - richting: - allOf: - - $ref: '#/components/schemas/RichtingEnum' - description: - 'Aanduiding van de richting van informatieobjecten van het - gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - - - Uitleg bij mogelijke waarden: - - - * `inkomend` - Inkomend - - * `intern` - Intern - - * `uitgaand` - Uitgaand' - title: richting - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn - verplicht aanwezig moeten zijn. - required: - - catalogus - - informatieobjecttype - - richting - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie - ZaakTypeInformatieObjectTypeExpanded: - allOf: - - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - - properties: - _expand: - $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' - ZaakTypeInformatieObjectTypeEmbedded: - type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." - properties: - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - informatieobjecttype: - oneOf: - - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - statustype: - oneOf: - - $ref: '#/components/schemas/StatusTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - ZaakTypeUpdate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: identificatie - maxLength: 50 - omschrijving: - type: string - description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van - het ZAAKTYPE - title: omschrijving generiek - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - doel: - type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een - zaak van dit zaaktype. - title: doel - aanleiding: - type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten - van een ZAAK van dit ZAAKTYPE. - title: aanleiding - toelichting: - type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving - van het procesverloop op de hoofdlijnen. - title: toelichting - indicatieInternOfExtern: - allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie." - title: indicatie intern of extern - handelingInitiator: - type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht - bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook - het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator - title: handeling initiator - maxLength: 20 - onderwerp: - type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen - nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" - title: onderwerp - maxLength: 80 - handelingBehandelaar: - type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht - bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', - 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar - title: handeling behandelaar - maxLength: 20 - doorlooptijd: - type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK - van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. - title: doorlooptijd behandeling - format: duration - servicenorm: - type: string - nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE - afgerond wordt conform de geldende servicenormen van de zaakbehandelende - organisatie(s). - title: servicenorm behandeling - format: duration - opschortingEnAanhoudingMogelijk: - type: boolean - title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE - kunnen worden opgeschort en/of aangehouden. - verlengingMogelijk: - type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van - ZAAKen van dit ZAAKTYPE kan worden verlengd. - title: verlenging mogelijk - verlengingstermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling - van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde - bevatten als verlenging mogelijk is. - title: verlengingstermijn - format: duration - trefwoorden: - type: array - items: - type: string - title: Trefwoord - maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden - gekarakteriseerd. - title: trefwoorden - publicatieIndicatie: - type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd - moet worden. - title: publicatie indicatie - publicatietekst: - type: string - description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. - title: publicatietekst - verantwoordingsrelatie: - type: array - items: - type: string - maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." - title: verantwoordingsrelatie - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt - voortgebracht. - title: producten of diensten - selectielijstProcestype: - type: string - format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende - groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst - API). - title: selectielijst procestype - maxLength: 200 - referentieproces: - allOf: - - $ref: '#/components/schemas/ReferentieProces' - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - title: referentieproces - verantwoordelijke: - type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker - die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. - title: verantwoordelijke - maxLength: 50 - zaakobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: Zaaktype - uniqueItems: true - broncatalogus: - allOf: - - $ref: '#/components/schemas/BronCatalogus' - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus - bronzaaktype: - allOf: - - $ref: '#/components/schemas/BronZaaktype' - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - title: bronzaaktype - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - title: Catalogus - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: is relevant voor - uniqueItems: true - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn - in ZAKEN van dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - informatieobjecttypen: - type: string - readOnly: true - title: informatieobjecttypen - roltypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit - ZAAKTYPE. - title: Zaaktype - uniqueItems: true - besluittypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE.' - title: zaaktypen - deelzaaktypen: - type: array - items: - type: string - title: '' - description: - De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak - kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. - title: deelzaaktypen - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypenRelatieCreate' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit - ZAAKTYPE. - title: zaaktype van - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - deelzaaktypen - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - - ZaakTypenRelatie: - type: object - properties: - zaaktype: - type: string - format: uri - description: - URL referentie naar het gerelateerde zaaktype, mogelijks in - een extern ZTC. - title: gerelateerd zaaktype - maxLength: 200 - aardRelatie: - allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Omschrijving van de aard van de relatie van zaken van het - ZAAKTYPE tot zaken van het andere ZAAKTYPE - - - Uitleg bij mogelijke waarden: - - - * `vervolg` - Vervolg - - * `bijdrage` - Bijdrage - - * `onderwerp` - Onderwerp' - title: aard relatie - toelichting: - type: string - description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. - title: toelichting - maxLength: 255 - required: - - aardRelatie - - zaaktype - ZaakTypenRelatieCreate: - type: object - properties: - zaaktype: - type: string - description: '`zaaktype.identificatie` naar het ZAAKTYPE.' - title: zaaktype van - aardRelatie: - allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Omschrijving van de aard van de relatie van zaken van het - ZAAKTYPE tot zaken van het andere ZAAKTYPE - - - Uitleg bij mogelijke waarden: - - - * `vervolg` - Vervolg - - * `bijdrage` - Bijdrage - - * `onderwerp` - Onderwerp' - title: aard relatie - toelichting: - type: string - description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. - title: toelichting - maxLength: 255 - required: - - aardRelatie - - zaaktype - securitySchemes: - JWT-Claims: - type: http - bearerFormat: JWT - scheme: bearer -servers: - # Added by API Auto Mocking Plugin - - description: SwaggerHub API Auto Mocking - url: https://virtserver.swaggerhub.com/michielverhoef/Catalogussen_API/1.3.0 - - url: https://catalogi-api.vng.cloud/api/v1 - description: Productie Omgeving -tags: - - name: besluittypen - description: - Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten - API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het - zaakgericht werken van de behandelende organisatie(s). - - name: catalogussen - description: - "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\ - \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\ - \ beheerd wordt." - - name: eigenschappen - description: - Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant - inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen - worden en geen standaard kenmerk is van een zaak. - - name: informatieobjecttypen - description: - Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen - in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van - een document of ander object dat informatie bevat. - - name: resultaattypen - description: - Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft - de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar - hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. - - name: roltypen - description: - Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding - van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. - - name: statustypen - description: - Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding - van de aard van een status. - - name: zaakobjecttypen - description: - "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\ - \ - `zaaktype` behoort tot dezelfde `catalogus`" - - name: zaaktype-informatieobjecttypen - description: - Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft - aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting - is. - - name: zaaktypen - description: - Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een - ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van - eenzelfde soort. \ No newline at end of file From 42c1fb3191f2cde8a87bd9b46372d7bb88dda65a Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 22:54:16 +0100 Subject: [PATCH 06/17] Deprecated StatusEnum als laatste opgenomen in de OneOf --- api-specificatie/drc/1.5.x/1.5.0/openapi.yaml | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml index bdb2de201..8fc8b80ca 100644 --- a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml +++ b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml @@ -5984,9 +5984,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -6293,9 +6293,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -6601,9 +6601,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -6875,9 +6875,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -7174,9 +7174,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -8245,7 +8245,7 @@ components: * `concept` - (Concept) De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die aan derden ter beoordeling kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van - de inhoud van het informatieobject. (_Nieuw vanaf versie 1.5.0_.) + de inhoud van het informatieobject. * `definitief` - (Definitief) De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd @@ -8255,7 +8255,11 @@ components: is betrokken bij een lopend besluitvormingsproces. * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is - bekrachtigd tijdens een besluitvormingsproces. (_Nieuw vanaf versie 1.5.0_.)" + bekrachtigd tijdens een besluitvormingsproces. + + + **Let op:** De waarden `concept` en `vastgesteld` zijn nieuw vanaf versie 1.5.0 + van deze API." enum: - in_bewerking - concept From c544db0e6ea281c642c45386efa7f8e2e942b156 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 7 Feb 2024 23:06:48 +0100 Subject: [PATCH 07/17] Current version ook aangepast --- .../drc/current_version/openapi.yaml | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index bdb2de201..8fc8b80ca 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -5984,9 +5984,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -6293,9 +6293,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -6601,9 +6601,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -6875,9 +6875,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -7174,9 +7174,9 @@ components: duurzaam, niet-wijzigbaar Formaat dient te hebben. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/StatusEnum1_5' - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- Geeft aan in hoeverre het informatieobject duurzaam @@ -8245,7 +8245,7 @@ components: * `concept` - (Concept) De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die aan derden ter beoordeling kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van - de inhoud van het informatieobject. (_Nieuw vanaf versie 1.5.0_.) + de inhoud van het informatieobject. * `definitief` - (Definitief) De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd @@ -8255,7 +8255,11 @@ components: is betrokken bij een lopend besluitvormingsproces. * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is - bekrachtigd tijdens een besluitvormingsproces. (_Nieuw vanaf versie 1.5.0_.)" + bekrachtigd tijdens een besluitvormingsproces. + + + **Let op:** De waarden `concept` en `vastgesteld` zijn nieuw vanaf versie 1.5.0 + van deze API." enum: - in_bewerking - concept From 29eb6c0b1499c42f51fd9abf3ba704f4719fde4f Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 8 Feb 2024 19:46:04 +0100 Subject: [PATCH 08/17] Verwerking feedback Ivo --- api-specificatie/drc/1.5.x/1.5.0/openapi.yaml | 363 +++++++----------- .../drc/current_version/openapi.yaml | 363 +++++++----------- 2 files changed, 262 insertions(+), 464 deletions(-) diff --git a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml index 8fc8b80ca..ca101db5e 100644 --- a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml +++ b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml @@ -5325,6 +5325,28 @@ components: - sha_512 - sha_3 type: string + ArchiefstatusEnum: + description: + "Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk) Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden." + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk AuditTrail: type: object properties: @@ -5682,6 +5704,8 @@ components: - woonplaatsnaam nullable: true BlankEnum: + description: " " + type: string enum: - '' BronEnum: @@ -5977,68 +6001,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -6286,68 +6285,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. - - * `false` De inhoud van het informatieobject is niet vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. - - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -6594,68 +6568,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -6868,68 +6817,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -7167,68 +7091,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -8235,7 +8134,7 @@ components: - gearchiveerd type: string deprecated: true - StatusEnum1_5: + StatusEnumV2: description: "Uitleg bij de enumeratiewaarden: diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index 8fc8b80ca..ca101db5e 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -5325,6 +5325,28 @@ components: - sha_512 - sha_3 type: string + ArchiefstatusEnum: + description: + "Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk) Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden." + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk AuditTrail: type: object properties: @@ -5682,6 +5704,8 @@ components: - woonplaatsnaam nullable: true BlankEnum: + description: " " + type: string enum: - '' BronEnum: @@ -5977,68 +6001,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -6286,68 +6285,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. - - * `false` De inhoud van het informatieobject is niet vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. - - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -6594,68 +6568,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -6868,68 +6817,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -7167,68 +7091,43 @@ components: maxLength: 200 status: description: >- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De - waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het - attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - title: status + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status oneOf: - - $ref: '#/components/schemas/StatusEnum1_5' + - $ref: '#/components/schemas/StatusEnumV2' - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het informatieobject duurzaam + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - - - Uitleg bij de enumeratiewaarden: - - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject - kunnen vrijelijk veranderen. - - * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het - informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk). Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden. - type: string - enum: - - mutabel - - onveranderlijk - - duurzaam_toegankelijk - nullable: true - indicatieInhoudVervallen: + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: description: >- - Geeft aan of de inhoud van het informatieobject al dan niet + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is. - * `true` De inhoud van het informatieobject is vervallen. + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. - * `false` De inhoud van het informatieobject is niet vervallen. - - * `null` Het is niet bekend of de inhoud van het informatieobject - is vervallen of niet. + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen type: boolean nullable: true - indicatiePersoonsgegevensAanwezig: + bevatNietOpenbarePersoonsgegevens: description: >- - Geeft aan of in de inhoud van het informatieobject persoonsgegevens - aanwezig zijn. - - * `true` In het informatieobject zijn persoonsgegevens aanwezig. + Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens + aanwezig zijn die niet openbaar gemaakt mogen worden. - * `false` In het informatieobject zijn geen persoonsgegevens aanwezig. + * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die + niet openbaar gemaakt mogen worden. - * `null` Het is niet bekend of in de inhoud van het inforformatieobject - persoonsgegevens aanwezig zijn. + * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig + die niet openbaar gemaakt mogen worden. + title: Bevat niet-openbare persoonsgegevens type: boolean nullable: true formaat: @@ -8235,7 +8134,7 @@ components: - gearchiveerd type: string deprecated: true - StatusEnum1_5: + StatusEnumV2: description: "Uitleg bij de enumeratiewaarden: From 5046c2f0013266fcb8df5c96365127e6ea14070a Mon Sep 17 00:00:00 2001 From: Ivo Date: Fri, 9 Feb 2024 18:32:58 +0100 Subject: [PATCH 09/17] Consultatiedocumentatie bij versie 1_5_0 toegevoegd --- .../documenten/consultatie-versie-1_5.md | 214 ++++++++++++++++++ 1 file changed, 214 insertions(+) create mode 100644 docs/standaard/documenten/consultatie-versie-1_5.md diff --git a/docs/standaard/documenten/consultatie-versie-1_5.md b/docs/standaard/documenten/consultatie-versie-1_5.md new file mode 100644 index 000000000..684d51197 --- /dev/null +++ b/docs/standaard/documenten/consultatie-versie-1_5.md @@ -0,0 +1,214 @@ +# Consultatie specificaties Documenten API versie 1.5 + +Op initatief van een aantal gemeenten en leveranciers worden onderstaande wijzigingen aan belanghebbenden voorgelegd. Het voornemen is dat het gewijzigd of ongewijzigd doorvoeren van deze aanpassingen leidt tot het uitbrengen van een nieuwe _minorversie_ van de Documenten API (1.5). De user story waarin de discussie die tot deze voorgestelde wijzigen heeft geleid is [#2242](https://github.com/VNG-Realisatie/gemma-zaken/issues/2242). + +De voorgestelde wijzigingen worden hieronder in vier onderdelen nader toegelicht. ['Wat wordt gewijzigd?'](#wat-wordt-gewijzigd) en ['wat is nieuw?'](#wat-is-er-nieuw) beschrijven de voorstelde wijzigingen. ['Wat vervalt (op termijn?')](#wat-vervalt-op-termijn) licht toe op welke manier duidelijk wordt gemaakt dat bepaalde property's bij voorkeur niet meer worden gebruikt en hoe we die uiteindelijk uit de standaard gaan verwijderen. [Aandachtspunten en vragen bij deze consultatie](#aandachtspunten-bij-deze-consultatie) noemt een aantal zaken waarover belanghebbenden naar aanleiding van consultatie specifiek zouden kunnen nadenken. + +## Wat wordt gewijzigd? + +### property 'status' + +Hieronder is ter referentie steeds hetgeen vervalt (of depricated wordt verklaard) doorgehaald. + +#### Beschrijving + +~Aanduiding van de stand van zaken van een informatieobject. De waarden `in bewerking` en `ter vaststelling` komen niet voor als het attribuut ontvangstdatum van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben.~ + +Geeft de status van het informatieobject aan in een proces van bewerking en eventuele vaststelling. + +#### Toegestane waarden + +Waarde | Betekenis +-- | -- +null | +in_bewerking | ~Aan het informatieobject wordt nog gewerkt.~ De inhoud van het informatieobject kan op ieder moment en onaangekondigd veranderen. +concept _(geheel nieuw)_ | De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die aan derden ter beoordeling kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van de inhoud van het informatieobject. +definitief | ~Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.~ De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd kan worden. +ter_vaststelling | ~Informatieobject gereed maar moet nog vastgesteld worden.~ De inhoud van het informatieobject is betrokken bij een lopend besluitvormingsproces. +vastgesteld _(geheel nieuw)_ | De inhoud van het informatieobject is tijdens een besluitvormingsproces bekrachtigd. +~gearchiveerd~ | ~Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.~ + +#### Rationale voor wijzigingen + +Bij gebruik van de bestaande toegestane statuswaarden werden de volgende problemen geconstateerd: + +- het toekennen van de waarde `gearchiveerd` resulteerde in verlies van kennis over bewerking of vaststelling. Was sprake van een gearchiveerd concept (een informatieobject met als voorlaatste status `in_bewerking`) of een definitief informatieobject (met als voorlaatste status `definitief`)? Dit heeft geleid tot het 'lostrekken' van 'archiefstatus' uit 'status'. +- De waarde `definitief` was ambigu. Die kón betekenen dat de inhoud van een informatieobject in een formeel besluitvormingsproces was bekrachtigd, maar ook dat eenvoudigweg sprake was van een door de gemeente ontvangen informatieobject waarin door de gemeente zelf geen wijzigen mogen worden doorgevoerd. Dit heeft geleid tot het toevoegen van de status `vastgesteld` en het aanpassen van de betekenis van `definitief`. +- Er was behoefte aan het middels statussen onderscheid aanbrengen tussen informatieobjecten waaraan in kleine kring wordt gewerkt en informatieobjecten die een zekere mate van volwassenheid hebben bereikt waardoor die aan een groep belanghebbenden ter consultatie kan worden voorgelegd. Dit heeft geleid tot het toevoegen van de status `concept` en het aanpassen van de betekenis van `in_bewerking`. + +#### Toelichting bij de nieuwe set toegestane statuswaarden + +Deze set statussen is feite een samenstelling van twee verzamelingen 'statustypen'. De waarden `in_bewerking`, `concept` en `definitief` representeren punten op de 'bewerkingstijdslijn' die helpen te bepalen hoe de 'volwassenheid' van de inhoud van het informatieobject moet worden beoordeeld. + +`ter_vaststelling` en `vastgesteld` liggen op de 'besluitvormingstijdslijn' en geven aan hoe ver het besluitvormingsproces waarin het informatieobject een rol speelt, gevorderd is. + +Besluitvorming gaat vrijwel altijd over 'definitieve' inhoud van informatieobjecten. Dit betekent dat sprake is van een 'opvolgende' reeks statussen. Hierdoor konden de statussen die horen bij de twee verschillende tijdslijnen in één verzameling worden opgenomen. + +Een informatieobject hoeft zeker niet altijd alle statussen te doorlopen. Al terwijl een informatieobject nog `in voorbereiding` is kan bijvoorbeeld duidelijk worden dat de dienst waaraan de inhoud daarvan bijdroeg niet geleverd hoeft te worden. Bovendien wordt de inhoud van veel informatieobjecten niet in een besluitvormingsproces bekrachtigd. En ontvangen informatieobjecten worden (door de gemeente) niet bewerkt en krijgen dus direct na ontvangst de status `definitief`. + +Voor de betekenis bij de verschillende waarden is getracht consequent het informatieobjectperspectief als uitgangspunt te nemen: + +- bij de betekenis van de eerste drie waarden (`in_voorbereiding`, `concept` en `definitief`) is als uitgangspunt de mate van verandering (of omgekeerd de 'volwassenheid') genomen die van de inhoud van het informatieobject bij het bereiken van een status verwacht mag worden. +- bij de betekenis van de laatste twee waarden (`ter_vaststelling` en `vastgesteld`) is het besluitvormingsproces als uitgangspunt genomen, maar ook geprobeerd (met name bij `vastgesteld`) geprobeerd te beschrijven wat het doorlopen van dit proces betekent voor de inhoud van het informatieobject ("het is bekrachtigd"). + +De Bewerkings- en vaststellingsstatus `definitief` moet niet verward worden met de Archiefstatus `onmuteerbaar`. Die laatste betekent in feite "geen enkele wijziging toegestaan". Voor zover het gaat om door de gemeente gecreëerde informatieobjecten betekent `definitief` daarentegen dat naar aanleiding van overleg, reviews en afspraken een 'overeengekomen' of 'afgestemde' versie van informatieobjectinhoud is ontstaan. Wijzigingen hierin zijn niet verboden, maar zullen in veel gevallen vragen om verantwoording bij doorgevoerde wijzigingen op basis van nieuwe reviews en afspraken. + +Rationale en tabel illustreren dat, door voor te stellen bovenstaande wijzigingen in een minor-versie van de Documenten API te verwerken, een situatie ontstaat waarin sommige waarden meerdere betekenissen kunnen hebben. Onder aandachtspunten wordt uitgelegd waarom hiervoor toch is gekozen. + +### Gedragsregel 'Zetten Zaak.archiefstatus (zrc-022)' + +Link huidige: [Zrc-022](../zaken/index.md/#archiveren) + +De standaardwaarde voor archiefstatus [van de zaak, IH] is `nog_te_archiveren`. Indien een andere waarde gezet wordt, dan MOETEN alle gerelateerde informatieobjecten de status `gearchiveerd` (depricated) EN/OF de archiefstatus `onveranderlijk` of `duurzaam_toegankelijk` hebben (zie [archiefstatus](#property-archiefstatus) hieronder). + +De attributen Zaak.archiefnominatie en Zaak.archiefactiedatum MOETEN een waarde krijgen als de de archiefstatus een waarde krijgt anders dan nog_te_archiveren. + +Indien deze voorwaarden niet voldaan zijn, dan MOET het ZRC met een HTTP 400 foutbericht antwoorden. + +#### Rationale voor wijziging + +Dat informatieobjecten na afsluiten van een zaak niet meer ('zomaar') gewijzigd kunnen worden, is een algemeen geldende eis. Bovenstaande is daarom een uitvoerbare gedragsregel met algemene geldigheid. De wijziging in deze regel ontstaat omdat statussen die te maken hebben met archivering zijn verhuisd van `status` naar `archiefstatus`. Zowel de archiefstatussen `onveranderlijk` of `duurzaam_toegankelijk` geven invulling aan de eis van onmuteerbaarheid. En zolang de bestaande statuswaarden met de toevoeging 'depricated' gebruikt mogen worden blijft ook registratie van `gearchiveerd` bij `status` een geldige manier om aan deze gedragsregel te voldoen. + +### Gedragsregel 'Statuswijzigingen van informatieobjecten (drc-005)' + +Link huidige: [Zrc-022](./index.md/#statuswijzigingen-van-informatieobjecten-drc-005) + +~Wanneer `InformatieObject.ontvangstdatum` een waarde heeft, dan zijn de waarden `in bewerking` en `ter_vaststelling` voor InformatieObject.status NIET TOEGESTAAN. Indien een dergelijke status gezet is voor de verzenddatum opgegeven wordt, dan moet de API een HTTP 400 foutbericht geven met status als veld in de invalid-params. De client MOET dan ontvangstdatum leeg laten of eerst de status wijzingen.~ + +#### Rationale voor wijziging + +Dit is een complexe gedragsregel waarvan moeilijk is vast te stellen dat die altijd geldt. En dat laatste is een voorwaarde voor opname in de standaard. Ja, in veel gevallen (ontvangen bouwtekening voor omgevingsvergunning, ontvangen inkomensverklaring bij aanvraag stadspas) mag een ontvangen informatieobject niet door de gemeente bewerkt worden. Maar als sprake is van informatieobject waarvan de inhoud door (keten)samenwerking tot stand komt, kunnen best wijzigingen in een ontvangen informatieobject worden aangebracht. Bij het voorstel deze regel te schrappen hoort daarom het aandachtspunt dat medewekers van de gemeente ervoor zorgdragen dat in ontvangen informatieobjecten waarin geen wijzigingen mogen worden aangebracht, dit ook niet gebeurt. + +## Wat is nieuw? + +### property 'archiefstatus' + +#### Beschrijving + +Geeft aan in hoeverre het informatieobject duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. + +#### Toegestane waarden + +Waarde | Betekenis +-- | -- +null | +mutabel | Vorm en inhoud van het informatieobject kunnen vrijelijk veranderen. +onveranderlijk | Vorm en inhoud van het informatieobject zijn onveranderlijk geworden zodat authenticiteit en integriteit gewaarborgd zijn. +duurzaam_toegankelijk | Het informatieobject voldoet aan de eisen van duurzame toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, interpreteerbaar, betrouwbaar en toekomstbestendig) en kan op het in de selectielijst voorgeschreven moment vernietigd of overgebracht worden. + +#### Toelichting + +Deze set statussen geeft aan in hoeverre het informatieobject voldoet aan de eisen voor 'duurzaam toegankelijk overheidsinformatie'. Of in andere woorden: in hoeverre het informatieobject als 'gearchiveerd' kan worden beschouwd. + +De waarde `mutabel` geeft aan dat het informatieobject nog vrijelijk bewerkt kan worden. Het informatieobject bevindt zich in wat ook wel de 'dynamische fase' genoemd werd. + +De waarde `onveranderlijk` geeft aan dat het informatieobject is 'bevroren'. Inhoud en vorm liggen nu vast. Hiermee zijn authenticiteit en integriteit van het informatieobject gewaarborgd. Door het uitvoeren van informatiebeheershandelingen kan nog wel de duurzame toegankelijkheid van het informatieobject worden verbeterd. Voor het verkrijgen van deze status is het echter geen eis dat het informatieobject aan alle relevante bijbehorende eisen voldoet. + +De waarde `duurzaam_toegankelijk` geeft aan dat informatiebeheershandelingen ertoe hebben geleid dat het informatieobject voldoet aan relevante eisen voor duurzame toegankelijkheid. Het is, voor zover deze kwaliteiten afhankelijk zijn van de vorm waarin het informatieobject is geregistreerd of de metadata die daarbij zijn vastgelegd, _vindbaar_, _beschikbaar_, _leesbaar_, _interpreteerbaar_, _betrouwbaar_ en _toekomstbestendig_. Concreet betekent dit bijvoorbeeld dat de inhoud van het informatieobject is geregistreerd in een duurzaam bestandsformaat. Deze waarde betekent ook dat bepaald kan worden op welk moment het informatieobject vernietigd of overgebracht moet worden worden (let op: dit hoeft niet te betekenen dat een concrete vernietigings- of overbrengingsdatum bekend is - [die kan immers afhankelijk zijn van een nog niet bekend datumkenmerk bij een procesobject](https://redact.gemmaonline.nl/index.php/4._De_Selectielijst_in_de_praktijk). Informatiebeheeractiviteiten houden niet op bij het bereiken van deze status. Het duurzaam toegankelijk houden van informatieobjecten vereist, zeker bij lange bewaartermijnen, immers voortdurend aandacht. + +Een informatieobject hoeft niet altijd alle archiefstatussen te doorlopen. Ontvangen informatieobjecten worden (door de gemeente) niet bewerkt en krijgen dus direct na ontvangst de status `onveranderlijk` of - als aan de bijbehorende eisen is voldaan - `duurzaam toegankelijk`. En als de daarvoor benodigde informatiebeheeractiviteiten worden uitgevoerd als onderdeel van het primaire proces waarin een informatieobject ontstaat (['archiveren by design'](https://www.nationaalarchief.nl/archiveren/kennisbank/archiving-by-design-en-vernietigen) kan een informatieobject van `mutabel` ineens `duurzaam_toegankelijk` worden. + +#### Rationale voor toevoeging + +- het toekennen van de waarde `gearchiveerd` resulteerde in verlies van kennis over bewerking of vaststelling. Was sprake van een gearchiveerd concept (een informatieobject met als voorlaatste status `in_bewerking`) of een definitief informatieobject (met als voorlaatste status `definitief`)? Dit heeft geleid tot het 'lostrekken' van 'archiefstatus' uit 'status'. +- [Gedragsregel zrc-022](#gedragsregel-zetten-zaakarchiefstatus-zrc-022) vereist dat aan een zaak gerelateerde informatieobjecten bij afsluiten van de zaak de status `gearchiveerd` hebben. In de pratijk is er niet altijd sprake van dat informatieobjecten op dit moment ook zoals de huidige defintie omschrijft 'duurzaam bewaarbaar zijn gemaakt'. Activiteiten die daaraan bijdragen (zoals het omzetten naar een duuzaam bewaarbaar bestandsformaat) kunnen immers ook ná afsluiten van de zaak plaatsvinden. Wél vereist is dat de inhoud van informatieobjecten na afsluiten van de zaak niet zomaar meer kan worden aangepast. Het toestaan van mutaties staat immers verantwoording over het verloop van de zaak in de weg. Dit heeft geleid tot het toevoegen van de archiefstatussen `muteerbaar` (voor gebruik tijdens lopende zaken zolang de inhoud van het informatieobject mag worden aangepast), `onveranderlijk` (wanneer de inhoud van het informatieobject om welke reden dan ook 'onherroepelijk' is geworden) en `duurzaam_toegankelijk` (wanneer het aan alle voor het specifieke informatieobject noodzakelijke eisen ten aanzien van duurzame toegankelijkheid voldoet). + +### property 'inhoudIsVervallen' + +#### Beschrijving + +Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. + +#### Toegestane waarden + +Waarde | Beschrijving +-- | -- +null | +true | De inhoud van het informatieobject is vervallen +False | De inhoud van het informatieobject is niet vervallen. + +#### Rationale voor toevoeging + +- Er was behoefte aan een manier om aan te geven dat informatieobjecten niet langer 'van belang' zijn, bijvoorbeeld omdat ze zijn vervangen door een ander informatieobject dat met andere inhoud gaat over hetzelfde onderwerp. + +#### Toelichting + +Het begrip 'vervallen' in deze indicatie moet gelezen worden als 'ongeldig geworden'. Geldigheid moet in deze context zowel 'breed' als 'eng' gelezen worden. + +- Breed in de zin dat verlies van geldigheid van de inhoud van een informatieobject zowel het gevolg kan zijn van een formele procedure, zoals de herroeping van een besluit, als van informele handelingen, zoals een bouwtekening waarvan de inhoud door het verschijnen van een meer actuele illustratie achterhaald is. Hoewel we in het dagelijks taalgebruik in het laatste geval waarschijnlijk zouden zeggen dat de bouwtekening "niet meer actueel is", benoemen we die in de context van deze indicatie als "niet meer geldig, dus vervallen". + +- Eng in de zin dat verlies van geldigheid niet betekent dat een informatieobject in het geheel geen waarde meer heeft. Een herroepen besluit kan immers aanleiding geven voor aantekenen van bezwaar of beroep. En de 'vervangen' bouwtekening kan vanuit cultuurhistorisch perspectief best heel interessant (blijken te) zijn. + +### property 'bevatNietOpenbarePersoonsgegevens' + +#### Beschrijving + +Geeft aan of in de inhoud van het informatieobject persoonsgegevens aanwezig zijn die niet openbaar gemaakt mogen worden. + +#### Rationale voor toevoeging + +- Er was behoefte aan een manier om aan te geven dat de inhoud van een informatieobject persoonsgegevens omvat die niet openbaar gemaakt mogen worden. + +#### Toegestane waarden + +Waarde | Beschrijving +-- | -- +null | +true | In het informatieobject zijn persoonsgegevens aanwezig die niet openbaar gemaakt mogen worden. +false | In het informatieobject zijn geen persoonsgegevens die niet openbaar gemaakt mogen worden. + +#### Toelichting + +In deze indicatie wordt expliciet verwezen naar "persoonsgegevens die niet openbaar gemaakt mogen worden". Dit betekent niet dat voor ieder informatieobject waarin persoonsgegvens aanwezig zijn de waarde 'ja' gekozen moet worden. Het kan immers gerechtvaardigd zijn persoonsgegevens wél openbaar te maken. + +__Merk op dat de áfwezigheid van persoonsgegevens niet kan worden gezien als vrijbrief voor openbare publicatie. Er kunnen immers andere beperkingsgronden (vertrouwelijk gedeelde bedrijfs- en fabricagegegevens, schending van belangen gediend met opsporing en vervolging van strafbare feiten, ...) of auteursrechtelijke beperkingen gelden.__ + +## Wat vervalt (op termijn)? + +Belanghebbenden gaven aan bovenstaande wijziging bij voorkeur verwerkt te zien in een _minor_ release van de Documenten API. Dit heeft als postief gevolg dat de overgang naar nieuwe property's en waarden niet in één 'big bang' hoeft te gebeuren. Maar het betekent dat het 'oude' niet zonder meer uit de specificatie mag verdwijnen, maar dat sprake moet zijn van een overgangsperiode waarin oud en nieuw naast elkaar kunnen bestaan. Dit kan worden bereikt door middel van 'deprication'. Met name de property `status` vormt hierbij een uitdaging. Daarvoor geldt immers dat sommige toegestane waarden geheel nieuw zijn, sommige een (door introductie van nieuwe waarden) geactualiseerde betekenis hebben gekregen, terwijl één waarde `gearchiveerd` geheel vervalt. Om aan te geven dat we willen dat 'oude' waarden zo min mogelijk worden gebruikt, zagen we drie mogelijkheden: + +1. Het toekennen van het 'depricated'-label aan individuele enum-waarden. Dit is, volgens de OpenAPI-specificaties versie 3.0 die we voor deze standaarden hanteren, [niet mogelijk](https://stackoverflow.com/questions/63963150/with-swagger-2-0-or-even-3-0-is-it-possible-to-mark-an-enum-value-as-deprecat). +2. Het opnemen van een geheel nieuwe property `statusv2` (of iets dergelijks), terwijl aan de bestaande property `status` het 'depricated'-label wordt toegekend. Dit leidt ertoe dat we ofwel tot in lengte van dagen met een lelijke, niet descriptieve propertynaam met daarin een versieaanduiding blijven zitten, ofwel later nog een wijziging moeten doorvoeren om de 'v2'-suffix weer te verwijderen. Om deze reden is hiervoor niet gekozen. +3. Het toevoegen van een nieuwe enum met daarin nieuwe toegestane statuswaarden onder de naam `StatusEnumV2` en het toekennen van het 'depricated'-label aan de bestaande enum `StatusEnum`. Hoewel hierbij dezelfde suffix-problematiek speelt als bij 2. hierboven, hebben we geoordeeld dat dit in de naam van een enum minder erg is dan in de naam van een property. Voor deze oplossing is derhalve gekozen. + +In de volgende _major_ release van de Documenten API kan de enum `StatusEnum` geheel komen te vervallen. + +## Aandachtspunten bij deze consultatie + +### Interacties tussen API-consumers en -providers + +Depricaten van de statuswaarden zoals die versies van Documenten API > 1.5.0 werden gehanteerd heeft een aantal consequenties: + +- API-consumers kunnen (of ze nu kennis hebben van in 1.5.0 doorgevoerde wijzigingen of niet) naast de nieuwe ook de in eerdere versies gehanteerde statuswaarden registeren. +- API-consumers zonder kennis van versies > 1.4.3 kunnen mogelijk in 1.5.0 toegevoegde statuswaarden niet interpreteren. +- API-consumers met kennis van versies > 1.4.3 verwachten kennis over de archiefstatus te kunnen halen uit de waarde van de property `archiefstatus`, terwijl die kennis ook in de vorm van de deprecated waarde `gearchiveerd` bij `status` geregistreerd kan zijn. + +Op basis hiervan verwachten we van API-providers het volgende gedrag: + +- bij `status` wordt, depricated of niet, iedere geldige waarde (`in_bewerking`, `concept`, `definitief`, `ter_vaststelling`, `vastgesteld` of `gearchiveerd`) die een consumer aanbiedt geregistreerd. +- aan consumers die API-versies > 1.4.3 bevragen wordt de geregistreerde statuswaarde, depricated of niet. +- aan consumers die API-versies < 1.5.0 bevragen worden alleen statuswaarden geleverd die in die API-versies geldig waren (`in_bewerking`, `ter_vaststelling`, `definitief` of `gearchiveerd`). Als een andere waarde is geregistreerd wordt de statuswaarde `null` geleverd. +- bij registratie van statuswaarde `gearchiveerd`, wordt door de provider automatisch óók de archiefstatus `onveranderlijk` of eventueel `duurzaam_toegankelijk` geregistreerd. Zo worden consumers bediend die op basis van 1.5-specificaties daar de kennis over de archiefstatus verwachten. + +Van API-consumers verwachten we dat ze zo snel mogelijk overstappen van bestaande naar nieuwe statuswaarden, en dat zij archiefstatussen, geldigheidsinformatie en informmatie over aanwezigheid van persoonsgegevens (laatste twee voor zover relevant) in de bijbehorende nieuwe property's gaan registeren. + +### Gelijke waarde, andere semantiek + +Een ander aandachtspunt is dat statuswaarden `in_bewerking`, `ter_vaststelling` en `definitief` straks in twee enums voorkomen, waarbij de betekenis van dezelfde waarde subtiel kan verschillen. Voor API-providers is echter niet altijd te achterhalen op basis van welke enum, en dus met welke betekenis een API-consumer een statuswaarde registreert. Vanwege het zeer subtiele karakter van de verschillen verwachten we hierdoor in de praktijk echter geen grote problemen. + +De tabel hieronder illustreert hoe 'oude' statuswaarden zich vertalen naar nieuwe (archief)statuswaarden. + + 'oude' waarde | te mappen naar of interpreteren als | te mappen naar of interpreteren als +--|--|-- +_status (1.4.3)_ | _status (1.5.0)_ | _archiefstatus (1.5.0)_ +`in_bewerking` | `in_bewerking (veilig) | + | `concept` (onder voorwaarde van voldoende bestendigheid) | +`ter_vaststelling` | `ter_vaststelling` (veilig) | +`definitief` | `definitief` (veilig) | + | `vastgesteld` (onder voorwaarde van bekrachtiging in besluitvormingsproces) | +`gearchiveerd` | | `onveranderlijk` (veilig) + | | `duurzaam_toegankelijk `(onder voorwaarde dat wordt voldaan aan eisen voor duurzame toegankelijkheid) + +### Derde `archiefstatus` nodig of gewenst? + +[De keuze voor drie mogelijke waarden bij archiefstatus](#property-archiefstatus) is hierboven gemotiveerd. We denken dat het aanvullend bij wat [minimaal nodig is om een zaak af te kunnen sluiten](#gedragsregel-zetten-zaakarchiefstatus-zrc-022) opnemen van de waarde `duurzaam_toegankelijk` alleen al nodig is om informatieobjecten met status `gearchiveerd` waarvoor daadwerkelijk de duurzame toegankelijkheid of opslag geregeld is van de juiste `archiefstatus` te voorzien. We zien ook de mogelijkheid om op basis van `onveranderlijke` informatieobjecten een 'werklijst' voor informatiebeheerders te creëren. Het uitgevoerde werk levert dan een `duurzaam_toegankelijk` informatieobject op. Over nut en noodzaak van het opnemen van deze waarde was tijdens het voorbereiden van bovenstaande wijzigingen echter geen volledige overeenstemming. Inzichten die helpen bepalen of we deze waarde moeten opnemen of niet zijn daarom van harte welkom. \ No newline at end of file From 4a4db829a0273d8ba1f9eba0628a3d8ac7c470f4 Mon Sep 17 00:00:00 2001 From: Ivo Date: Fri, 9 Feb 2024 18:37:25 +0100 Subject: [PATCH 10/17] Revert "Consultatiedocumentatie bij versie 1_5_0 toegevoegd" This reverts commit 5046c2f0013266fcb8df5c96365127e6ea14070a. --- .../documenten/consultatie-versie-1_5.md | 214 ------------------ 1 file changed, 214 deletions(-) delete mode 100644 docs/standaard/documenten/consultatie-versie-1_5.md diff --git a/docs/standaard/documenten/consultatie-versie-1_5.md b/docs/standaard/documenten/consultatie-versie-1_5.md deleted file mode 100644 index 684d51197..000000000 --- a/docs/standaard/documenten/consultatie-versie-1_5.md +++ /dev/null @@ -1,214 +0,0 @@ -# Consultatie specificaties Documenten API versie 1.5 - -Op initatief van een aantal gemeenten en leveranciers worden onderstaande wijzigingen aan belanghebbenden voorgelegd. Het voornemen is dat het gewijzigd of ongewijzigd doorvoeren van deze aanpassingen leidt tot het uitbrengen van een nieuwe _minorversie_ van de Documenten API (1.5). De user story waarin de discussie die tot deze voorgestelde wijzigen heeft geleid is [#2242](https://github.com/VNG-Realisatie/gemma-zaken/issues/2242). - -De voorgestelde wijzigingen worden hieronder in vier onderdelen nader toegelicht. ['Wat wordt gewijzigd?'](#wat-wordt-gewijzigd) en ['wat is nieuw?'](#wat-is-er-nieuw) beschrijven de voorstelde wijzigingen. ['Wat vervalt (op termijn?')](#wat-vervalt-op-termijn) licht toe op welke manier duidelijk wordt gemaakt dat bepaalde property's bij voorkeur niet meer worden gebruikt en hoe we die uiteindelijk uit de standaard gaan verwijderen. [Aandachtspunten en vragen bij deze consultatie](#aandachtspunten-bij-deze-consultatie) noemt een aantal zaken waarover belanghebbenden naar aanleiding van consultatie specifiek zouden kunnen nadenken. - -## Wat wordt gewijzigd? - -### property 'status' - -Hieronder is ter referentie steeds hetgeen vervalt (of depricated wordt verklaard) doorgehaald. - -#### Beschrijving - -~Aanduiding van de stand van zaken van een informatieobject. De waarden `in bewerking` en `ter vaststelling` komen niet voor als het attribuut ontvangstdatum van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben.~ - -Geeft de status van het informatieobject aan in een proces van bewerking en eventuele vaststelling. - -#### Toegestane waarden - -Waarde | Betekenis --- | -- -null | -in_bewerking | ~Aan het informatieobject wordt nog gewerkt.~ De inhoud van het informatieobject kan op ieder moment en onaangekondigd veranderen. -concept _(geheel nieuw)_ | De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die aan derden ter beoordeling kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van de inhoud van het informatieobject. -definitief | ~Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.~ De inhoud van het informatieobject heeft een mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd kan worden. -ter_vaststelling | ~Informatieobject gereed maar moet nog vastgesteld worden.~ De inhoud van het informatieobject is betrokken bij een lopend besluitvormingsproces. -vastgesteld _(geheel nieuw)_ | De inhoud van het informatieobject is tijdens een besluitvormingsproces bekrachtigd. -~gearchiveerd~ | ~Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.~ - -#### Rationale voor wijzigingen - -Bij gebruik van de bestaande toegestane statuswaarden werden de volgende problemen geconstateerd: - -- het toekennen van de waarde `gearchiveerd` resulteerde in verlies van kennis over bewerking of vaststelling. Was sprake van een gearchiveerd concept (een informatieobject met als voorlaatste status `in_bewerking`) of een definitief informatieobject (met als voorlaatste status `definitief`)? Dit heeft geleid tot het 'lostrekken' van 'archiefstatus' uit 'status'. -- De waarde `definitief` was ambigu. Die kón betekenen dat de inhoud van een informatieobject in een formeel besluitvormingsproces was bekrachtigd, maar ook dat eenvoudigweg sprake was van een door de gemeente ontvangen informatieobject waarin door de gemeente zelf geen wijzigen mogen worden doorgevoerd. Dit heeft geleid tot het toevoegen van de status `vastgesteld` en het aanpassen van de betekenis van `definitief`. -- Er was behoefte aan het middels statussen onderscheid aanbrengen tussen informatieobjecten waaraan in kleine kring wordt gewerkt en informatieobjecten die een zekere mate van volwassenheid hebben bereikt waardoor die aan een groep belanghebbenden ter consultatie kan worden voorgelegd. Dit heeft geleid tot het toevoegen van de status `concept` en het aanpassen van de betekenis van `in_bewerking`. - -#### Toelichting bij de nieuwe set toegestane statuswaarden - -Deze set statussen is feite een samenstelling van twee verzamelingen 'statustypen'. De waarden `in_bewerking`, `concept` en `definitief` representeren punten op de 'bewerkingstijdslijn' die helpen te bepalen hoe de 'volwassenheid' van de inhoud van het informatieobject moet worden beoordeeld. - -`ter_vaststelling` en `vastgesteld` liggen op de 'besluitvormingstijdslijn' en geven aan hoe ver het besluitvormingsproces waarin het informatieobject een rol speelt, gevorderd is. - -Besluitvorming gaat vrijwel altijd over 'definitieve' inhoud van informatieobjecten. Dit betekent dat sprake is van een 'opvolgende' reeks statussen. Hierdoor konden de statussen die horen bij de twee verschillende tijdslijnen in één verzameling worden opgenomen. - -Een informatieobject hoeft zeker niet altijd alle statussen te doorlopen. Al terwijl een informatieobject nog `in voorbereiding` is kan bijvoorbeeld duidelijk worden dat de dienst waaraan de inhoud daarvan bijdroeg niet geleverd hoeft te worden. Bovendien wordt de inhoud van veel informatieobjecten niet in een besluitvormingsproces bekrachtigd. En ontvangen informatieobjecten worden (door de gemeente) niet bewerkt en krijgen dus direct na ontvangst de status `definitief`. - -Voor de betekenis bij de verschillende waarden is getracht consequent het informatieobjectperspectief als uitgangspunt te nemen: - -- bij de betekenis van de eerste drie waarden (`in_voorbereiding`, `concept` en `definitief`) is als uitgangspunt de mate van verandering (of omgekeerd de 'volwassenheid') genomen die van de inhoud van het informatieobject bij het bereiken van een status verwacht mag worden. -- bij de betekenis van de laatste twee waarden (`ter_vaststelling` en `vastgesteld`) is het besluitvormingsproces als uitgangspunt genomen, maar ook geprobeerd (met name bij `vastgesteld`) geprobeerd te beschrijven wat het doorlopen van dit proces betekent voor de inhoud van het informatieobject ("het is bekrachtigd"). - -De Bewerkings- en vaststellingsstatus `definitief` moet niet verward worden met de Archiefstatus `onmuteerbaar`. Die laatste betekent in feite "geen enkele wijziging toegestaan". Voor zover het gaat om door de gemeente gecreëerde informatieobjecten betekent `definitief` daarentegen dat naar aanleiding van overleg, reviews en afspraken een 'overeengekomen' of 'afgestemde' versie van informatieobjectinhoud is ontstaan. Wijzigingen hierin zijn niet verboden, maar zullen in veel gevallen vragen om verantwoording bij doorgevoerde wijzigingen op basis van nieuwe reviews en afspraken. - -Rationale en tabel illustreren dat, door voor te stellen bovenstaande wijzigingen in een minor-versie van de Documenten API te verwerken, een situatie ontstaat waarin sommige waarden meerdere betekenissen kunnen hebben. Onder aandachtspunten wordt uitgelegd waarom hiervoor toch is gekozen. - -### Gedragsregel 'Zetten Zaak.archiefstatus (zrc-022)' - -Link huidige: [Zrc-022](../zaken/index.md/#archiveren) - -De standaardwaarde voor archiefstatus [van de zaak, IH] is `nog_te_archiveren`. Indien een andere waarde gezet wordt, dan MOETEN alle gerelateerde informatieobjecten de status `gearchiveerd` (depricated) EN/OF de archiefstatus `onveranderlijk` of `duurzaam_toegankelijk` hebben (zie [archiefstatus](#property-archiefstatus) hieronder). - -De attributen Zaak.archiefnominatie en Zaak.archiefactiedatum MOETEN een waarde krijgen als de de archiefstatus een waarde krijgt anders dan nog_te_archiveren. - -Indien deze voorwaarden niet voldaan zijn, dan MOET het ZRC met een HTTP 400 foutbericht antwoorden. - -#### Rationale voor wijziging - -Dat informatieobjecten na afsluiten van een zaak niet meer ('zomaar') gewijzigd kunnen worden, is een algemeen geldende eis. Bovenstaande is daarom een uitvoerbare gedragsregel met algemene geldigheid. De wijziging in deze regel ontstaat omdat statussen die te maken hebben met archivering zijn verhuisd van `status` naar `archiefstatus`. Zowel de archiefstatussen `onveranderlijk` of `duurzaam_toegankelijk` geven invulling aan de eis van onmuteerbaarheid. En zolang de bestaande statuswaarden met de toevoeging 'depricated' gebruikt mogen worden blijft ook registratie van `gearchiveerd` bij `status` een geldige manier om aan deze gedragsregel te voldoen. - -### Gedragsregel 'Statuswijzigingen van informatieobjecten (drc-005)' - -Link huidige: [Zrc-022](./index.md/#statuswijzigingen-van-informatieobjecten-drc-005) - -~Wanneer `InformatieObject.ontvangstdatum` een waarde heeft, dan zijn de waarden `in bewerking` en `ter_vaststelling` voor InformatieObject.status NIET TOEGESTAAN. Indien een dergelijke status gezet is voor de verzenddatum opgegeven wordt, dan moet de API een HTTP 400 foutbericht geven met status als veld in de invalid-params. De client MOET dan ontvangstdatum leeg laten of eerst de status wijzingen.~ - -#### Rationale voor wijziging - -Dit is een complexe gedragsregel waarvan moeilijk is vast te stellen dat die altijd geldt. En dat laatste is een voorwaarde voor opname in de standaard. Ja, in veel gevallen (ontvangen bouwtekening voor omgevingsvergunning, ontvangen inkomensverklaring bij aanvraag stadspas) mag een ontvangen informatieobject niet door de gemeente bewerkt worden. Maar als sprake is van informatieobject waarvan de inhoud door (keten)samenwerking tot stand komt, kunnen best wijzigingen in een ontvangen informatieobject worden aangebracht. Bij het voorstel deze regel te schrappen hoort daarom het aandachtspunt dat medewekers van de gemeente ervoor zorgdragen dat in ontvangen informatieobjecten waarin geen wijzigingen mogen worden aangebracht, dit ook niet gebeurt. - -## Wat is nieuw? - -### property 'archiefstatus' - -#### Beschrijving - -Geeft aan in hoeverre het informatieobject duurzaam toegankelijk is en op het voorgeschreven moment vernietigd of overgebracht kan worden. - -#### Toegestane waarden - -Waarde | Betekenis --- | -- -null | -mutabel | Vorm en inhoud van het informatieobject kunnen vrijelijk veranderen. -onveranderlijk | Vorm en inhoud van het informatieobject zijn onveranderlijk geworden zodat authenticiteit en integriteit gewaarborgd zijn. -duurzaam_toegankelijk | Het informatieobject voldoet aan de eisen van duurzame toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, interpreteerbaar, betrouwbaar en toekomstbestendig) en kan op het in de selectielijst voorgeschreven moment vernietigd of overgebracht worden. - -#### Toelichting - -Deze set statussen geeft aan in hoeverre het informatieobject voldoet aan de eisen voor 'duurzaam toegankelijk overheidsinformatie'. Of in andere woorden: in hoeverre het informatieobject als 'gearchiveerd' kan worden beschouwd. - -De waarde `mutabel` geeft aan dat het informatieobject nog vrijelijk bewerkt kan worden. Het informatieobject bevindt zich in wat ook wel de 'dynamische fase' genoemd werd. - -De waarde `onveranderlijk` geeft aan dat het informatieobject is 'bevroren'. Inhoud en vorm liggen nu vast. Hiermee zijn authenticiteit en integriteit van het informatieobject gewaarborgd. Door het uitvoeren van informatiebeheershandelingen kan nog wel de duurzame toegankelijkheid van het informatieobject worden verbeterd. Voor het verkrijgen van deze status is het echter geen eis dat het informatieobject aan alle relevante bijbehorende eisen voldoet. - -De waarde `duurzaam_toegankelijk` geeft aan dat informatiebeheershandelingen ertoe hebben geleid dat het informatieobject voldoet aan relevante eisen voor duurzame toegankelijkheid. Het is, voor zover deze kwaliteiten afhankelijk zijn van de vorm waarin het informatieobject is geregistreerd of de metadata die daarbij zijn vastgelegd, _vindbaar_, _beschikbaar_, _leesbaar_, _interpreteerbaar_, _betrouwbaar_ en _toekomstbestendig_. Concreet betekent dit bijvoorbeeld dat de inhoud van het informatieobject is geregistreerd in een duurzaam bestandsformaat. Deze waarde betekent ook dat bepaald kan worden op welk moment het informatieobject vernietigd of overgebracht moet worden worden (let op: dit hoeft niet te betekenen dat een concrete vernietigings- of overbrengingsdatum bekend is - [die kan immers afhankelijk zijn van een nog niet bekend datumkenmerk bij een procesobject](https://redact.gemmaonline.nl/index.php/4._De_Selectielijst_in_de_praktijk). Informatiebeheeractiviteiten houden niet op bij het bereiken van deze status. Het duurzaam toegankelijk houden van informatieobjecten vereist, zeker bij lange bewaartermijnen, immers voortdurend aandacht. - -Een informatieobject hoeft niet altijd alle archiefstatussen te doorlopen. Ontvangen informatieobjecten worden (door de gemeente) niet bewerkt en krijgen dus direct na ontvangst de status `onveranderlijk` of - als aan de bijbehorende eisen is voldaan - `duurzaam toegankelijk`. En als de daarvoor benodigde informatiebeheeractiviteiten worden uitgevoerd als onderdeel van het primaire proces waarin een informatieobject ontstaat (['archiveren by design'](https://www.nationaalarchief.nl/archiveren/kennisbank/archiving-by-design-en-vernietigen) kan een informatieobject van `mutabel` ineens `duurzaam_toegankelijk` worden. - -#### Rationale voor toevoeging - -- het toekennen van de waarde `gearchiveerd` resulteerde in verlies van kennis over bewerking of vaststelling. Was sprake van een gearchiveerd concept (een informatieobject met als voorlaatste status `in_bewerking`) of een definitief informatieobject (met als voorlaatste status `definitief`)? Dit heeft geleid tot het 'lostrekken' van 'archiefstatus' uit 'status'. -- [Gedragsregel zrc-022](#gedragsregel-zetten-zaakarchiefstatus-zrc-022) vereist dat aan een zaak gerelateerde informatieobjecten bij afsluiten van de zaak de status `gearchiveerd` hebben. In de pratijk is er niet altijd sprake van dat informatieobjecten op dit moment ook zoals de huidige defintie omschrijft 'duurzaam bewaarbaar zijn gemaakt'. Activiteiten die daaraan bijdragen (zoals het omzetten naar een duuzaam bewaarbaar bestandsformaat) kunnen immers ook ná afsluiten van de zaak plaatsvinden. Wél vereist is dat de inhoud van informatieobjecten na afsluiten van de zaak niet zomaar meer kan worden aangepast. Het toestaan van mutaties staat immers verantwoording over het verloop van de zaak in de weg. Dit heeft geleid tot het toevoegen van de archiefstatussen `muteerbaar` (voor gebruik tijdens lopende zaken zolang de inhoud van het informatieobject mag worden aangepast), `onveranderlijk` (wanneer de inhoud van het informatieobject om welke reden dan ook 'onherroepelijk' is geworden) en `duurzaam_toegankelijk` (wanneer het aan alle voor het specifieke informatieobject noodzakelijke eisen ten aanzien van duurzame toegankelijkheid voldoet). - -### property 'inhoudIsVervallen' - -#### Beschrijving - -Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. - -#### Toegestane waarden - -Waarde | Beschrijving --- | -- -null | -true | De inhoud van het informatieobject is vervallen -False | De inhoud van het informatieobject is niet vervallen. - -#### Rationale voor toevoeging - -- Er was behoefte aan een manier om aan te geven dat informatieobjecten niet langer 'van belang' zijn, bijvoorbeeld omdat ze zijn vervangen door een ander informatieobject dat met andere inhoud gaat over hetzelfde onderwerp. - -#### Toelichting - -Het begrip 'vervallen' in deze indicatie moet gelezen worden als 'ongeldig geworden'. Geldigheid moet in deze context zowel 'breed' als 'eng' gelezen worden. - -- Breed in de zin dat verlies van geldigheid van de inhoud van een informatieobject zowel het gevolg kan zijn van een formele procedure, zoals de herroeping van een besluit, als van informele handelingen, zoals een bouwtekening waarvan de inhoud door het verschijnen van een meer actuele illustratie achterhaald is. Hoewel we in het dagelijks taalgebruik in het laatste geval waarschijnlijk zouden zeggen dat de bouwtekening "niet meer actueel is", benoemen we die in de context van deze indicatie als "niet meer geldig, dus vervallen". - -- Eng in de zin dat verlies van geldigheid niet betekent dat een informatieobject in het geheel geen waarde meer heeft. Een herroepen besluit kan immers aanleiding geven voor aantekenen van bezwaar of beroep. En de 'vervangen' bouwtekening kan vanuit cultuurhistorisch perspectief best heel interessant (blijken te) zijn. - -### property 'bevatNietOpenbarePersoonsgegevens' - -#### Beschrijving - -Geeft aan of in de inhoud van het informatieobject persoonsgegevens aanwezig zijn die niet openbaar gemaakt mogen worden. - -#### Rationale voor toevoeging - -- Er was behoefte aan een manier om aan te geven dat de inhoud van een informatieobject persoonsgegevens omvat die niet openbaar gemaakt mogen worden. - -#### Toegestane waarden - -Waarde | Beschrijving --- | -- -null | -true | In het informatieobject zijn persoonsgegevens aanwezig die niet openbaar gemaakt mogen worden. -false | In het informatieobject zijn geen persoonsgegevens die niet openbaar gemaakt mogen worden. - -#### Toelichting - -In deze indicatie wordt expliciet verwezen naar "persoonsgegevens die niet openbaar gemaakt mogen worden". Dit betekent niet dat voor ieder informatieobject waarin persoonsgegvens aanwezig zijn de waarde 'ja' gekozen moet worden. Het kan immers gerechtvaardigd zijn persoonsgegevens wél openbaar te maken. - -__Merk op dat de áfwezigheid van persoonsgegevens niet kan worden gezien als vrijbrief voor openbare publicatie. Er kunnen immers andere beperkingsgronden (vertrouwelijk gedeelde bedrijfs- en fabricagegegevens, schending van belangen gediend met opsporing en vervolging van strafbare feiten, ...) of auteursrechtelijke beperkingen gelden.__ - -## Wat vervalt (op termijn)? - -Belanghebbenden gaven aan bovenstaande wijziging bij voorkeur verwerkt te zien in een _minor_ release van de Documenten API. Dit heeft als postief gevolg dat de overgang naar nieuwe property's en waarden niet in één 'big bang' hoeft te gebeuren. Maar het betekent dat het 'oude' niet zonder meer uit de specificatie mag verdwijnen, maar dat sprake moet zijn van een overgangsperiode waarin oud en nieuw naast elkaar kunnen bestaan. Dit kan worden bereikt door middel van 'deprication'. Met name de property `status` vormt hierbij een uitdaging. Daarvoor geldt immers dat sommige toegestane waarden geheel nieuw zijn, sommige een (door introductie van nieuwe waarden) geactualiseerde betekenis hebben gekregen, terwijl één waarde `gearchiveerd` geheel vervalt. Om aan te geven dat we willen dat 'oude' waarden zo min mogelijk worden gebruikt, zagen we drie mogelijkheden: - -1. Het toekennen van het 'depricated'-label aan individuele enum-waarden. Dit is, volgens de OpenAPI-specificaties versie 3.0 die we voor deze standaarden hanteren, [niet mogelijk](https://stackoverflow.com/questions/63963150/with-swagger-2-0-or-even-3-0-is-it-possible-to-mark-an-enum-value-as-deprecat). -2. Het opnemen van een geheel nieuwe property `statusv2` (of iets dergelijks), terwijl aan de bestaande property `status` het 'depricated'-label wordt toegekend. Dit leidt ertoe dat we ofwel tot in lengte van dagen met een lelijke, niet descriptieve propertynaam met daarin een versieaanduiding blijven zitten, ofwel later nog een wijziging moeten doorvoeren om de 'v2'-suffix weer te verwijderen. Om deze reden is hiervoor niet gekozen. -3. Het toevoegen van een nieuwe enum met daarin nieuwe toegestane statuswaarden onder de naam `StatusEnumV2` en het toekennen van het 'depricated'-label aan de bestaande enum `StatusEnum`. Hoewel hierbij dezelfde suffix-problematiek speelt als bij 2. hierboven, hebben we geoordeeld dat dit in de naam van een enum minder erg is dan in de naam van een property. Voor deze oplossing is derhalve gekozen. - -In de volgende _major_ release van de Documenten API kan de enum `StatusEnum` geheel komen te vervallen. - -## Aandachtspunten bij deze consultatie - -### Interacties tussen API-consumers en -providers - -Depricaten van de statuswaarden zoals die versies van Documenten API > 1.5.0 werden gehanteerd heeft een aantal consequenties: - -- API-consumers kunnen (of ze nu kennis hebben van in 1.5.0 doorgevoerde wijzigingen of niet) naast de nieuwe ook de in eerdere versies gehanteerde statuswaarden registeren. -- API-consumers zonder kennis van versies > 1.4.3 kunnen mogelijk in 1.5.0 toegevoegde statuswaarden niet interpreteren. -- API-consumers met kennis van versies > 1.4.3 verwachten kennis over de archiefstatus te kunnen halen uit de waarde van de property `archiefstatus`, terwijl die kennis ook in de vorm van de deprecated waarde `gearchiveerd` bij `status` geregistreerd kan zijn. - -Op basis hiervan verwachten we van API-providers het volgende gedrag: - -- bij `status` wordt, depricated of niet, iedere geldige waarde (`in_bewerking`, `concept`, `definitief`, `ter_vaststelling`, `vastgesteld` of `gearchiveerd`) die een consumer aanbiedt geregistreerd. -- aan consumers die API-versies > 1.4.3 bevragen wordt de geregistreerde statuswaarde, depricated of niet. -- aan consumers die API-versies < 1.5.0 bevragen worden alleen statuswaarden geleverd die in die API-versies geldig waren (`in_bewerking`, `ter_vaststelling`, `definitief` of `gearchiveerd`). Als een andere waarde is geregistreerd wordt de statuswaarde `null` geleverd. -- bij registratie van statuswaarde `gearchiveerd`, wordt door de provider automatisch óók de archiefstatus `onveranderlijk` of eventueel `duurzaam_toegankelijk` geregistreerd. Zo worden consumers bediend die op basis van 1.5-specificaties daar de kennis over de archiefstatus verwachten. - -Van API-consumers verwachten we dat ze zo snel mogelijk overstappen van bestaande naar nieuwe statuswaarden, en dat zij archiefstatussen, geldigheidsinformatie en informmatie over aanwezigheid van persoonsgegevens (laatste twee voor zover relevant) in de bijbehorende nieuwe property's gaan registeren. - -### Gelijke waarde, andere semantiek - -Een ander aandachtspunt is dat statuswaarden `in_bewerking`, `ter_vaststelling` en `definitief` straks in twee enums voorkomen, waarbij de betekenis van dezelfde waarde subtiel kan verschillen. Voor API-providers is echter niet altijd te achterhalen op basis van welke enum, en dus met welke betekenis een API-consumer een statuswaarde registreert. Vanwege het zeer subtiele karakter van de verschillen verwachten we hierdoor in de praktijk echter geen grote problemen. - -De tabel hieronder illustreert hoe 'oude' statuswaarden zich vertalen naar nieuwe (archief)statuswaarden. - - 'oude' waarde | te mappen naar of interpreteren als | te mappen naar of interpreteren als ---|--|-- -_status (1.4.3)_ | _status (1.5.0)_ | _archiefstatus (1.5.0)_ -`in_bewerking` | `in_bewerking (veilig) | - | `concept` (onder voorwaarde van voldoende bestendigheid) | -`ter_vaststelling` | `ter_vaststelling` (veilig) | -`definitief` | `definitief` (veilig) | - | `vastgesteld` (onder voorwaarde van bekrachtiging in besluitvormingsproces) | -`gearchiveerd` | | `onveranderlijk` (veilig) - | | `duurzaam_toegankelijk `(onder voorwaarde dat wordt voldaan aan eisen voor duurzame toegankelijkheid) - -### Derde `archiefstatus` nodig of gewenst? - -[De keuze voor drie mogelijke waarden bij archiefstatus](#property-archiefstatus) is hierboven gemotiveerd. We denken dat het aanvullend bij wat [minimaal nodig is om een zaak af te kunnen sluiten](#gedragsregel-zetten-zaakarchiefstatus-zrc-022) opnemen van de waarde `duurzaam_toegankelijk` alleen al nodig is om informatieobjecten met status `gearchiveerd` waarvoor daadwerkelijk de duurzame toegankelijkheid of opslag geregeld is van de juiste `archiefstatus` te voorzien. We zien ook de mogelijkheid om op basis van `onveranderlijke` informatieobjecten een 'werklijst' voor informatiebeheerders te creëren. Het uitgevoerde werk levert dan een `duurzaam_toegankelijk` informatieobject op. Over nut en noodzaak van het opnemen van deze waarde was tijdens het voorbereiden van bovenstaande wijzigingen echter geen volledige overeenstemming. Inzichten die helpen bepalen of we deze waarde moeten opnemen of niet zijn daarom van harte welkom. \ No newline at end of file From 060c2061dde1d85f77b5038fd0fb966191092e59 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 12 Feb 2024 11:36:58 +0100 Subject: [PATCH 11/17] Update aanvullende specificaties zrc en drc --- docs/standaard/documenten/index.md | 11 +++++++++++ docs/standaard/zaken/index.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/standaard/documenten/index.md b/docs/standaard/documenten/index.md index 8a205c5bd..b556b8a02 100644 --- a/docs/standaard/documenten/index.md +++ b/docs/standaard/documenten/index.md @@ -213,6 +213,17 @@ Er MOET gevalideerd worden dat de relatie tussen het `object` en het `informatie Wanneer `InformatieObject.ontvangstdatum` een waarde heeft, dan zijn de waarden `in bewerking` en `ter vaststelling` voor `InformatieObject.status` NIET TOEGESTAAN. Indien een dergelijke status gezet is _voor_ de verzenddatum opgegeven wordt, dan moet de API een HTTP 400 foutbericht geven met `status` als veld in de `invalid-params`. De client MOET dan `ontvangstdatum` leeg laten of eerst de status wijzingen. +#### **Statuswijzigingen van informatieobjecten ([drc-005](#drc-005))** + +Wanneer `InformatieObject.ontvangstdatum` een waarde heeft, dan zijn de waarden `in bewerking` en `ter vaststelling` voor `InformatieObject.status` NIET TOEGESTAAN. Indien een dergelijke status gezet is _voor_ de verzenddatum opgegeven wordt, dan moet de API een HTTP 400 foutbericht geven met `status` als veld in de `invalid-params`. De client MOET dan `ontvangstdatum` leeg laten of eerst de status wijzingen. + + + gewijzigd in 1.5.0 + +

+ +~~Wanneer `InformatieObject.ontvangstdatum` een waarde heeft, dan zijn de waarden `in bewerking` en `ter vaststelling` voor `InformatieObject.status` NIET TOEGESTAAN. Indien een dergelijke status gezet is _voor_ de verzenddatum opgegeven wordt, dan moet de API een HTTP 400 foutbericht geven met `status` als veld in de `invalid-params`. De client MOET dan `ontvangstdatum` leeg laten of eerst de status wijzingen.~~ + #### **Gebruiksrechten op informatieobjecten ([drc-006](#drc-006))** Indien er geen gebruiksrechtenvoorwaarden van toepassing zijn op een informatieobject, dan moet `InformatieObject.indicatieGebruiksrechten` op de waarde `false` gezet worden. Indien de voorwaarden (nog) niet bekend zijn, dan moet de indicatie op `null` gezet worden. diff --git a/docs/standaard/zaken/index.md b/docs/standaard/zaken/index.md index 764b65410..79eaee173 100644 --- a/docs/standaard/zaken/index.md +++ b/docs/standaard/zaken/index.md @@ -370,6 +370,17 @@ De attributen `Zaak.archiefnominatie` en `Zaak.archiefactiedatum` MOETEN een waa Indien deze voorwaarden niet voldaan zijn, dan MOET het ZRC met een `HTTP 400` foutbericht antwoorden. + + Nieuw in 1.5.2 + +

+ +De standaardwaarde voor archiefstatus van de zaak is `nog_te_archiveren`. Indien een andere waarde gezet wordt, dan MOETEN alle gerelateerde informatieobjecten de status `gearchiveerd` (deprecated) EN/OF de archiefstatus `onveranderlijk` of `duurzaam_toegankelijk` hebben. + +De attributen `Zaak.archiefnominatie` en `Zaak.archiefactiedatum` MOETEN een waarde krijgen als de archiefstatus een waarde krijgt anders dan `nog_te_archiveren`. + +Indien aan deze voorwaarden niet is voldaan, dan MOET het ZRC met een `HTTP 400` foutbericht antwoorden. + **Vernietigen van zaken ([zrc-023](#zrc-023))** Bij het verwijderen van een `Zaak` MOETEN de zaak en gerelateerde objecten daadwerkelijk uit de opslag verwijderd worden. Zogenaamde "soft-deletes" zijn NIET TOEGESTAAN. Onder gerelateerde objecten wordt begrepen: From f455e08fd0f9d8fd555e8b38f7a8d4d7131557cd Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 12 Feb 2024 11:51:19 +0100 Subject: [PATCH 12/17] Update index.md van zrc --- docs/standaard/zaken/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/standaard/zaken/index.md b/docs/standaard/zaken/index.md index 79eaee173..e0f2e0f42 100644 --- a/docs/standaard/zaken/index.md +++ b/docs/standaard/zaken/index.md @@ -371,7 +371,7 @@ De attributen `Zaak.archiefnominatie` en `Zaak.archiefactiedatum` MOETEN een waa Indien deze voorwaarden niet voldaan zijn, dan MOET het ZRC met een `HTTP 400` foutbericht antwoorden. - Nieuw in 1.5.2 + Nieuw in 1.6.0

From a2e8e8485b050af57d680706e92dd515d888d842 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 26 Feb 2024 20:47:22 +0100 Subject: [PATCH 13/17] Check op "status NIET definitief" verwijderd --- api-specificatie/drc/1.5.x/1.5.0/openapi.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml index ca101db5e..6924236a6 100644 --- a/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml +++ b/api-specificatie/drc/1.5.x/1.5.0/openapi.yaml @@ -1204,7 +1204,6 @@ paths: - correcte `lock` waarde - - status NIET `definitief` summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. parameters: - in: path @@ -1397,7 +1396,7 @@ paths: **Er wordt gevalideerd op** - correcte `lock` waarde - - status NIET `definitief` + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. parameters: - in: path From 96db825534698afb0720c5831bcbfe801466c2ce Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 29 Feb 2024 13:32:16 +0100 Subject: [PATCH 14/17] Update OAS n.a.v. consultatie --- api-specificatie/drc/2.0.x/2.0.0/openapi.yaml | 8513 +++++++++++++++++ 1 file changed, 8513 insertions(+) create mode 100644 api-specificatie/drc/2.0.x/2.0.0/openapi.yaml diff --git a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml new file mode 100644 index 000000000..2408451d5 --- /dev/null +++ b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml @@ -0,0 +1,8513 @@ +openapi: 3.0.3 +info: + title: Documenten API + version: 2.0.0 + description: > + Een API om een documentregistratiecomponent (DRC) te benaderen. + + + In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. + Een + + INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. + + INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten + worden + + gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben. + + + GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het + INFORMATIEOBJECT + + (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API + gevalideerd + + of gehandhaafd. + + + De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht + in + + de vorm van INFORMATIEOBJECTTYPEn. + + + **Uploaden van bestanden** + + + Binnen deze API bestaan een aantal endpoints die binaire data ontvangen, al + + dan niet base64-encoded. Webservers moeten op deze endpoints een minimale + + request body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de + + metadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de + + overhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit + + betekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot + + mag zijn. + + + _Nieuw in 1.1.0_ + + + Bestanden kunnen groter zijn dan de minimale die door providers + + ondersteund moet worden. De consumer moet dan: + + + 1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale + bestandsgrootte + meegestuurd wordt en de inhoud leeggelaten wordt. + De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer + en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT. + 2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben + zoals dit aangegeven werd in de response bij 1. + 3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige + BESTANDSDEEL-url gestuurd worden, samen met het lock ID. + 4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat + alle + bestandsdelen correct opgestuurd werden, en voegt deze samen tot het + resulterende bestand. + + Het bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop. + + + De 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden + die + + niet gesplitst hoeven te worden. + + + **Afhankelijkheden** + + + Deze API is afhankelijk van: + + + * Catalogi API + + * Notificaties API + + * Autorisaties API *(optioneel)* + + * Zaken API *(optioneel)* + + + **Autorisatie** + + + Deze API vereist autorisatie. Je kan de + + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + + genereren. + + + ### Notificaties + + + Deze API publiceert notificaties op het kanaal `documenten`. + + + **Main resource** + + + `enkelvoudiginformatieobject` + + + + + **Kenmerken** + + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de + organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en + als eerste in een samenwerkingsketen heeft vastgelegd. + + * `informatieobjecttype`: URL-referentie naar het INFORMATIEOBJECTTYPE (in + de Catalogi API). + + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het + INFORMATIEOBJECT voor de openbaarheid bestemd is. + + + **Resources en acties** + + + + **Handige links** + + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /bestandsdelen/{uuid}: + put: + operationId: bestandsdeel_update + description: based on DRF mixin but without partial_update + summary: Upload een bestandsdeel. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/x-www-form-urlencoded + - multipart/form-data + description: Content type van de verzoekinhoud. + required: true + tags: + - bestandsdelen + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/BestandsDeelRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/BestandsDeelRequest' + required: true + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/BestandsDeelResponse' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten: + get: + operationId: enkelvoudiginformatieobject_list + description: >- + Deze lijst kan gefilterd wordt met query-string parameters. + + De objecten bevatten metadata over de documenten en de downloadlink + (`inhoud`) naar de binary data. Alleen de laatste versie van + elk(ENKELVOUDIG) INFORMATIEOBJECT wordt getoond. Specifieke versies + kunnen alleen + summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. + parameters: + - name: identificatie + required: false + in: query + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + schema: + type: string + - name: bronorganisatie + required: false + in: query + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Een lijst van trefwoorden gescheiden door comma's. + schema: + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + style: form + explode: false + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobjecttype + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEnkelvoudigInformatieObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: enkelvoudiginformatieobject_create + description: |- + **Er wordt gevalideerd op** + - geldigheid `informatieobjecttype` URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben. + - publicatie `informatieobjecttype` - `concept` moet `false` zijn + summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLock' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail: + get: + operationId: audittrail_list + description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. + summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT. + parameters: + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid}: + get: + operationId: audittrail_retrieve + description: Een specifieke audit trail regel opvragen. + summary: Een specifieke audit trail regel opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}: + get: + operationId: enkelvoudiginformatieobject_retrieve + description: ' Het object bevat metadata over het document en de downloadlink (`inhoud`) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.' + summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: >- + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobjecttype + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: enkelvoudiginformatieobject_update + description: >- + Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) + INFORMATIEOBJECT. + + **Er wordt gevalideerd op** + + - correcte `lock` waarde + + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest' + required: true + security: + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLock' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: enkelvoudiginformatieobject_partial_update + description: >- + Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) + INFORMATIEOBJECT. + + + **Er wordt gevalideerd op** + - correcte `lock` waarde + + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest + security: + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLock' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: enkelvoudiginformatieobject_destroy + description: >- + Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende + versies, samen met alle gerelateerde resources binnen deze API. Dit is + alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan + het (ENKELVOUDIG) INFORMATIEOBJECT. + + + **Gerelateerde resources** + + - GEBRUIKSRECHTen + + - audit trail regels + summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: enkelvoudiginformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - enkelvoudiginformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /enkelvoudiginformatieobjecten/{uuid}/download: + get: + operationId: enkelvoudiginformatieobject_download + description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. + summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: >- + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/octet-stream: + schema: + type: string + format: binary + description: OK + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}/lock: + post: + operationId: enkelvoudiginformatieobject_lock + description: >- + Voert een 'checkout' uit waardoor het (ENKELVOUDIG) + INFORMATIEOBJECTvergrendeld wordt met een `lock` waarde. Alleen met deze + waarde kan het(ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) + en weerontgrendeld worden. + summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lock + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/LockEnkelvoudigInformatieObject' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Bad request + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}/unlock: + post: + operationId: enkelvoudiginformatieobject_unlock + description: >- + Heft de 'checkout' op waardoor het (ENKELVOUDIG) + INFORMATIEOBJECTontgrendeld wordt. + summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest' + security: + - JWT-Claims: + - (documenten.lock | documenten.geforceerd-unlock) + responses: + '204': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: No content + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Bad request + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/_zoek: + post: + operationId: enkelvoudiginformatieobject__zoek + description: >- + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet + geschikt voor zoekopdrachten met UUIDs. + summary: Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EIOZoekRequest' + required: true + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEnkelvoudigInformatieObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /gebruiksrechten: + get: + operationId: gebruiksrechten_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle GEBRUIKSRECHTen opvragen. + parameters: + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: startdatum__lt + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__lte + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__gt + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__gte + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: einddatum__lt + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__lte + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gt + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gte + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GebruiksrechtenExpanded' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: gebruiksrechten_create + description: |- + Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. + **Opmerkingen** + - Het toevoegen van gebruiksrechten zorgt ervoor dat de `indicatieGebruiksrecht` op het informatieobject op `true` gezet wordt. + summary: Maak een GEBRUIKSRECHT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenRequest' + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /gebruiksrechten/{uuid}: + get: + operationId: gebruiksrechten_retrieve + description: Een specifieke GEBRUIKSRECHT opvragen. + summary: Een specifieke GEBRUIKSRECHT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: gebruiksrechten_update + description: Werk een GEBRUIKSRECHT in zijn geheel bij. + summary: Werk een GEBRUIKSRECHT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenRequest' + required: true + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: gebruiksrechten_partial_update + description: Werk een GEBRUIKSRECHT relatie deels bij. + summary: Werk een GEBRUIKSRECHT relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedGebruiksrechtenRequest' + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: gebruiksrechten_destroy + description: |- + + **Opmerkingen** + - Indien het laatste GEBRUIKSRECHT van een INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht` van het INFORMATIEOBJECT op`null` gezet. + summary: Verwijder een GEBRUIKSRECHT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: gebruiksrechten_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: >- + De headers voor een specifiek(e) GEBRUIKSRECHT INFORMATIEOBJECT + opvragen + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - gebruiksrechten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /objectinformatieobjecten: + get: + operationId: objectinformatieobject_list + description: ' Deze lijst kan gefilterd wordt met query-string parameters.' + summary: Alle OBJECT-INFORMATIEOBJECT relaties opvragen. + parameters: + - name: object + required: false + in: query + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: objectinformatieobject_create + description: >- + **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit + endpoint bij het synchroniseren van relaties. **Er wordt gevalideerd + op** - geldigheid `informatieobject` URL - de combinatie + `informatieobject` en `object` moet uniek zijn - bestaan van `object` + URL + summary: Maak een OBJECT-INFORMATIEOBJECT relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - objectinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObjectRequest' + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /objectinformatieobjecten/{uuid}: + get: + operationId: objectinformatieobject_retrieve + description: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. + summary: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: objectinformatieobject_destroy + description: >- + **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit + endpoint bij het synchroniseren van relaties. + summary: Verwijder een OBJECT-INFORMATIEOBJECT relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: objectinformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) OOBJECT-INFORMATIEOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - objectinformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /verzendingen: + get: + operationId: verzending_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle VERZENDINGen opvragen. + parameters: + - name: aardRelatie + required: false + in: query + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + schema: + type: string + enum: + - afzender + - geadresseerde + - name: informatieobject + required: false + in: query + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + schema: + type: string + format: uri + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - verzendingen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVerzendingList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: verzending_create + description: Voeg VERZENDINGen toe voor een INFORMATIEOBJECT en een BETROKKENE. + summary: Maak een VERZENDING aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingRequest' + required: true + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /verzendingen/{uuid}: + get: + operationId: verzending_retrieve + description: Een specifieke VERZENDING opvragen. + summary: Een specifieke VERZENDING opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - verzendingen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: verzending_update + description: Werk een VERZENDING in zijn geheel bij. + summary: Werk een VERZENDING in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingRequest' + required: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: verzending_partial_update + description: Werk een VERZENDING relatie deels bij. + summary: Werk een VERZENDING relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVerzendingRequest' + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: verzending_destroy + description: Verwijder een VERZENDING. + summary: Verwijder een VERZENDING + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - verzendingen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: verzending_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) VERZENDING opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - verzendingen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - afzender + - geadresseerde + type: string + AlgoritmeEnum: + enum: + - crc_16 + - crc_32 + - crc_64 + - fletcher_4 + - fletcher_8 + - fletcher_16 + - fletcher_32 + - hmac + - md5 + - sha_1 + - sha_256 + - sha_512 + - sha_3 + type: string + ArchiefstatusEnum: + description: + "Uitleg bij de enumeratiewaarden: + + * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + kunnen vrijelijk veranderen. + + * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het + informatieobject zijn onveranderlijk geworden zodat authenticiteit + en integriteit gewaarborgd zijn. + + * `duurzaam_toegankelijk` (Duurzaam toegankelijk) Het + informatieobject voldoet aan de eisen van duurzame + toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, + interpreteerbaar, betrouwbaar en toekomstbestendig) en kan + op het in de selectielijst voorgeschreven moment vernietigd + of overgebracht worden." + type: string + enum: + - mutabel + - onveranderlijk + - duurzaam_toegankelijk + AuditTrail: + type: object + properties: + uuid: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + bron: + allOf: + - $ref: '#/components/schemas/BronEnum' + description: |- + De naam van het component waar de wijziging in is gedaan. + + Uitleg bij mogelijke waarden: + + * `ac` - Autorisaties API + * `nrc` - Notificaties API + * `zrc` - Zaken API + * `ztc` - Catalogi API + * `drc` - Documenten API + * `brc` - Besluiten API + * `cmc` - Contactmomenten API + * `kc` - Klanten API + * `vrc` - Verzoeken API + title: bron + applicatieId: + type: string + description: Unieke identificatie van de applicatie, binnen de organisatie. + title: applicatie id + maxLength: 100 + applicatieWeergave: + type: string + description: Vriendelijke naam van de applicatie. + title: applicatie weergave + maxLength: 200 + gebruikersId: + type: string + description: >- + Unieke identificatie van de gebruiker die binnen de organisatie + herleid kan worden naar een persoon. + title: gebruikers id + maxLength: 255 + gebruikersWeergave: + type: string + description: Vriendelijke naam van de gebruiker. + title: gebruikers weergave + maxLength: 255 + actie: + type: string + description: >- + De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder + aangegeven, maar andere waardes zijn ook + toegestaan + + + Uitleg bij mogelijke waarden: + + + * `create` - Object aangemaakt + + * `list` - Lijst van objecten opgehaald + + * `retrieve` - Object opgehaald + + * `destroy` - Object verwijderd + + * `update` - Object bijgewerkt + + * `partial_update` - Object deels bijgewerkt + title: actie + maxLength: 50 + actieWeergave: + type: string + description: Vriendelijke naam van de actie. + title: actie weergave + maxLength: 200 + resultaat: + type: integer + maximum: 599 + minimum: 100 + description: HTTP status code van de API response van de uitgevoerde handeling. + title: resultaat + hoofdObject: + type: string + format: uri + description: De URL naar het hoofdobject van een component. + title: hoofd object + maxLength: 1000 + resource: + type: string + description: Het type resource waarop de actie gebeurde. + title: resource + maxLength: 50 + resourceUrl: + type: string + format: uri + description: De URL naar het object. + title: resource url + maxLength: 1000 + toelichting: + type: string + description: Toelichting waarom de handeling is uitgevoerd. + title: toelichting + resourceWeergave: + type: string + description: Vriendelijke identificatie van het object. + title: resource weergave + maxLength: 200 + aanmaakdatum: + type: string + format: date-time + readOnly: true + description: De datum waarop de handeling is gedaan. + title: aanmaakdatum + wijzigingen: + allOf: + - $ref: '#/components/schemas/Wijzigingen' + title: wijzigingen + required: + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen + BestandsDeel: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + volgnummer: + type: integer + readOnly: true + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + omvang: + type: integer + readOnly: true + description: De grootte van dit specifieke bestandsdeel. + title: omvang + voltooid: + type: boolean + readOnly: true + description: >- + Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: + het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen. + title: voltooid + lock: + type: string + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + required: + - lock + - omvang + - url + - volgnummer + - voltooid + BestandsDeelRequest: + type: object + properties: + inhoud: + type: string + format: binary + writeOnly: true + description: De (binaire) bestandsinhoud van dit specifieke bestandsdeel. + title: inhoud + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + required: + - lock + BestandsDeelResponse: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + lock: + type: string + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + omvang: + type: integer + description: De grootte van dit specifieke bestandsdeel. + title: omvang + inhoud: + type: string + format: uri + description: De URL naar de bestandsinhoud van dit specifieke bestandsdeel. + title: inhoud + voltooid: + type: boolean + description: >- + Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: + het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen. + title: voltooid + volgnummer: + type: integer + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + required: + - lock + - url + BinnenlandsCorrespondentieadresVerzending: + type: object + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van de + BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het + reguliere binnenlandse correspondentieadres van BETROKKENE. + properties: + huisletter: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende toevoeging aan een huisnummer in + de vorm van een alfanumeriek teken. + title: huisletter + maxLength: 1 + huisnummer: + type: integer + maximum: 99999 + minimum: 1 + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nummering. + title: huisnummer + huisnummerToevoeging: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nadere toevoeging aan een + huisnummer of een combinatie van huisnummer en huisletter. + title: huisnummer toevoeging + maxLength: 4 + naamOpenbareRuimte: + type: string + description: >- + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE + OPENBARE RUIMTE toegekende benaming. + title: naam openbare ruimte + maxLength: 80 + postcode: + type: string + description: >- + De door TNT Post vastgestelde code behorende bij een bepaalde + combinatie van een naam van een woonplaats, naam van een openbare + ruimte en een huisnummer. + title: postcode + maxLength: 6 + woonplaatsnaam: + type: string + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam + nullable: true + BinnenlandsCorrespondentieadresVerzendingRequest: + type: object + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van de + BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het + reguliere binnenlandse correspondentieadres van BETROKKENE. + properties: + huisletter: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende toevoeging aan een huisnummer in + de vorm van een alfanumeriek teken. + title: huisletter + maxLength: 1 + huisnummer: + type: integer + maximum: 99999 + minimum: 1 + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nummering. + title: huisnummer + huisnummerToevoeging: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nadere toevoeging aan een + huisnummer of een combinatie van huisnummer en huisletter. + title: huisnummer toevoeging + maxLength: 4 + naamOpenbareRuimte: + type: string + minLength: 1 + description: >- + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE + OPENBARE RUIMTE toegekende benaming. + title: naam openbare ruimte + maxLength: 80 + postcode: + type: string + description: >- + De door TNT Post vastgestelde code behorende bij een bepaalde + combinatie van een naam van een woonplaats, naam van een openbare + ruimte en een huisnummer. + title: postcode + maxLength: 6 + woonplaatsnaam: + type: string + minLength: 1 + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam + nullable: true + BlankEnum: + description: " " + type: string + enum: + - '' + BronEnum: + enum: + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc + type: string + BuitenlandsCorrespondentieadresVerzending: + type: object + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden + INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens + van BETROKKENE. + properties: + adresBuitenland1: + type: string + description: >- + Het eerste deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 1 + maxLength: 35 + adresBuitenland2: + type: string + description: >- + Het tweede deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 2 + maxLength: 35 + adresBuitenland3: + type: string + description: >- + Het derde deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 3 + maxLength: 35 + landPostadres: + type: string + format: uri + description: >- + Het LAND dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: land postadres + maxLength: 200 + required: + - adresBuitenland1 + - landPostadres + nullable: true + BuitenlandsCorrespondentieadresVerzendingRequest: + type: object + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden + INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens + van BETROKKENE. + properties: + adresBuitenland1: + type: string + minLength: 1 + description: >- + Het eerste deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 1 + maxLength: 35 + adresBuitenland2: + type: string + description: >- + Het tweede deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 2 + maxLength: 35 + adresBuitenland3: + type: string + description: >- + Het derde deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 3 + maxLength: 35 + landPostadres: + type: string + format: uri + minLength: 1 + description: >- + Het LAND dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: land postadres + maxLength: 200 + required: + - adresBuitenland1 + - landPostadres + nullable: true + BuitenlandsCorrespondentiepostadresVerzending: + type: object + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen + van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: >- + De numerieke aanduiding zoals deze door de Nederlandse PTT is + vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: + type: string + description: >- + De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: + type: string + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + BuitenlandsCorrespondentiepostadresVerzendingRequest: + type: object + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen + van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: >- + De numerieke aanduiding zoals deze door de Nederlandse PTT is + vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: + type: string + minLength: 1 + description: >- + De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: + type: string + minLength: 1 + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + EIOZoekRequest: + type: object + properties: + uuid__in: + type: array + items: + type: string + format: uuid + title: '' + description: Array of unieke resource identifiers (UUID4) + title: uuid__in + identificatie: + title: Identificatie + description: + Een binnen een gegeven context ondubbelzinnige referentie naar + het INFORMATIEOBJECT. + type: string + example: "Document123" + bronorganisatie: + title: Bronorganisatie + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." + type: string + example: "000000000" + expand: + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + type: string + example: informatieobjecttype + required: + - uuid__in + EnkelvoudigInformatieObject: + type: object + description: Serializer for the EnkelvoudigInformatieObject model + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status + oneOf: + - $ref: '#/components/schemas/StatusEnumV2' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + DEPRECATED Dit attribuut is verplaatst naar resource + Verzending. De datum waarop het INFORMATIEOBJECT ontvangen is. + Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + DEPRECATED Dit attribuut is verplaatst naar resource + Verzending. De datum waarop het INFORMATIEOBJECT verzonden is, zoals + deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel + inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde + informatieobject kan niet tegelijk inkomend en uitgaand zijn. + Ontvangst en verzending is voorbehouden aan documenten die van of + naar andere personen ontvangen of verzonden zijn waarbij die + personen niet deel uit maken van de behandeling van de zaak waarin + het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectCreateLock: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status + oneOf: + - $ref: '#/components/schemas/StatusEnumV2' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + lock: + type: string + readOnly: true + description: >- + Lock id generated if the large file is created and should be used + while updating the document. Documents with base64 encoded files are + created without lock + title: lock + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectCreateLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status + oneOf: + - $ref: '#/components/schemas/StatusEnumV2' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - taal + - titel + EnkelvoudigInformatieObjectWithLock: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status + oneOf: + - $ref: '#/components/schemas/StatusEnumV2' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectWithLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. + title: Status + oneOf: + - $ref: '#/components/schemas/StatusEnumV2' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + archiefstatus: + description: >- + Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam + toegankelijk is en op het voorgeschreven moment vernietigd of + overgebracht kan worden. + title: Archiefstatus + oneOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: Inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` + veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde + hebben. + title: lock + required: + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - taal + - titel + EnkelvoudigInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/EnkelvoudigInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectEmbedded' + EnkelvoudigInformatieObjectEmbedded: + type: object + properties: + informatieobjecttype: + $ref: >- + https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/InformatieObjectType + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: >- + URI met referentie naar dit specifiek voorkomen van de fout. Deze + kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + Gebruiksrechten: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + required: + - informatieobject + - omschrijvingVoorwaarden + - startdatum + - url + GebruiksrechtenExpanded: + allOf: + - $ref: '#/components/schemas/Gebruiksrechten' + - properties: + _expand: + $ref: '#/components/schemas/GebruiksrechtenEmbedded' + GebruiksrechtenEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + GebruiksrechtenRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + minLength: 1 + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + required: + - informatieobject + - omschrijvingVoorwaarden + - startdatum + Integriteit: + type: object + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal + bestand. + properties: + algoritme: + allOf: + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. + + Uitleg bij mogelijke waarden: + + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 + * `sha_3` - SHA-3 + title: integriteit algoritme + waarde: + type: string + description: De waarde van de checksum. + title: integriteit waarde + maxLength: 128 + datum: + type: string + format: date + description: Datum waarop de checksum is gemaakt. + title: integriteit datum + required: + - algoritme + - datum + - waarde + nullable: true + IntegriteitRequest: + type: object + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal + bestand. + properties: + algoritme: + allOf: + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. + + Uitleg bij mogelijke waarden: + + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 + * `sha_3` - SHA-3 + title: integriteit algoritme + waarde: + type: string + minLength: 1 + description: De waarde van de checksum. + title: integriteit waarde + maxLength: 128 + datum: + type: string + format: date + description: Datum waarop de checksum is gemaakt. + title: integriteit datum + required: + - algoritme + - datum + - waarde + nullable: true + LockEnkelvoudigInformatieObject: + type: object + description: |- + Serializer for the lock action of EnkelvoudigInformatieObjectCanonical + model + properties: + lock: + type: string + readOnly: true + description: Hash string, wordt gebruikt als ID voor de lock + title: lock + required: + - lock + ObjectInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + object: + type: string + format: uri + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + title: object + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + title: Objecttype + description: |- + Het type van het gerelateerde OBJECT. + + Uitleg bij mogelijke waarden: + + * `besluit` - Besluit + * `zaak` - Zaak + required: + - informatieobject + - object + - objectType + - url + ObjectInformatieObjectRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + object: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + title: object + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + title: Objecttype + description: |- + Het type van het gerelateerde OBJECT. + + Uitleg bij mogelijke waarden: + + * `besluit` - Besluit + * `zaak` - Zaak + required: + - informatieobject + - object + - objectType + ObjectTypeEnum: + enum: + - besluit + - zaak + - verzoek + type: string + Ondertekening: + type: object + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet van + een waarde zijn voorzien als de `status` de waarde 'in bewerking' of + 'ter vaststelling' heeft. + properties: + soort: + allOf: + - $ref: '#/components/schemas/SoortEnum' + title: Ondertekeningsoort + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + + Uitleg bij mogelijke waarden: + + * `analoog` - Analoog + * `digitaal` - Digitaal + * `pki` - PKI + datum: + type: string + format: date + title: Ondertekeningdatum + description: >- + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + plaatsgevonden. + required: + - datum + - soort + nullable: true + OndertekeningRequest: + type: object + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet van + een waarde zijn voorzien als de `status` de waarde 'in bewerking' of + 'ter vaststelling' heeft. + properties: + soort: + allOf: + - $ref: '#/components/schemas/SoortEnum' + title: Ondertekeningsoort + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + + Uitleg bij mogelijke waarden: + + * `analoog` - Analoog + * `digitaal` - Digitaal + * `pki` - PKI + datum: + type: string + format: date + title: Ondertekeningdatum + description: >- + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + plaatsgevonden. + required: + - datum + - soort + nullable: true + PaginatedEnkelvoudigInformatieObjectList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' + PaginatedVerzendingList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/VerzendingExpanded' + PatchedEnkelvoudigInformatieObjectWithLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` + veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde + hebben. + title: lock + PatchedGebruiksrechtenRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + minLength: 1 + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + PatchedVerzendingRequest: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + betrokkene: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + minLength: 1 + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + PostadresTypeEnum: + enum: + - antwoordnummer + - postbusnummer + type: string + SoortEnum: + enum: + - analoog + - digitaal + - pki + type: string + StatusEnum: + description: + "Uitleg bij mogelijke waarden: + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element." + enum: + - in_bewerking + - ter_vaststelling + - definitief + - gearchiveerd + type: string + deprecated: true + StatusEnumV2: + description: + "Uitleg bij de enumeratiewaarden: + + * `in_bewerking` - (In bewerking) De inhoud van het informatieobject kan + op ieder moment en onaangekondigd veranderen. + + * `concept` - (Concept) De inhoud van het informatieobject heeft een + mate van bestendigheid bereikt waardoor die aan derden ter beoordeling + kan worden voorgelegd. Deze beoordeling kan leiden tot verandering van + de inhoud van het informatieobject. + + * `definitief` - (Definitief) De inhoud van het informatieobject heeft een + mate van bestendigheid bereikt waardoor die niet (langer) zomaar veranderd + kan worden. + + * `ter_vaststelling` - (Ter vaststelling) De inhoud van het informatieobject + is betrokken bij een lopend besluitvormingsproces. + + * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is + bekrachtigd tijdens een besluitvormingsproces. + + + **Let op:** De waarden `concept` en `vastgesteld` zijn nieuw vanaf versie 1.5.0 + van deze API." + enum: + - in_bewerking + - concept + - definitief + - ter_vaststelling + - vastgesteld + type: string + UnlockEnkelvoudigInformatieObjectRequest: + type: object + description: |- + Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical + model + properties: + lock: + type: string + description: Hash string, wordt gebruikt als ID voor de lock + title: lock + maxLength: 100 + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: >- + URI met referentie naar dit specifiek voorkomen van de fout. Deze + kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + Verzending: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzending + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + required: + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + - url + VerzendingExpanded: + allOf: + - $ref: '#/components/schemas/Verzending' + - properties: + _expand: + $ref: '#/components/schemas/VerzendingEmbedded' + VerzendingEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + VerzendingRequest: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + betrokkene: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + minLength: 1 + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + required: + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + Wijzigingen: + type: object + properties: + oud: + type: object + additionalProperties: {} + description: >- + Volledige JSON body van het object zoals dat bestond voordat de + actie heeft plaatsgevonden. + title: oud + nieuw: + type: object + additionalProperties: {} + description: Volledige JSON body van het object na de actie. + title: nieuw + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + # - description: SwaggerHub API Auto Mocking + # url: https://virtserver.swaggerhub.com/michielverhoef/Documenten_API/1.4.2 + - url: https://documenten-api.vng.cloud/api/v2 + description: Productie Omgeving + - url: https://documenten-api.test.vng.cloud/api/v2 + description: Test Omgeving +tags: + - name: enkelvoudiginformatieobjecten + description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). + - name: gebruiksrechten + description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. + - name: objectinformatieobjecten + description: >- + Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft + een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de + Zaken API, en een INFORMATIEOBJECT. + - name: verzendingen + description: Opvragen en bewerken van VERZENDINGen. From dd2b1bd45bc61d937657233f6bbabbbf6a810a34 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 29 Feb 2024 13:33:00 +0100 Subject: [PATCH 15/17] Update --- api-specificatie/drc/2.0.x/2.0.0/openapi.yaml | 36 ++---- .../drc/current_version/openapi.yaml | 110 +++--------------- 2 files changed, 21 insertions(+), 125 deletions(-) diff --git a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml index 2408451d5..b1da3cd24 100644 --- a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml +++ b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml @@ -5328,24 +5328,16 @@ components: description: "Uitleg bij de enumeratiewaarden: - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + * `veranderlijk` - (Veranderlijk) Vorm en inhoud van het informatieobject kunnen vrijelijk veranderen. * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk) Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden." + en integriteit gewaarborgd zijn." type: string enum: - - mutabel + - veranderlijk - onveranderlijk - - duurzaam_toegankelijk AuditTrail: type: object properties: @@ -6008,9 +6000,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6279,9 +6269,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6549,9 +6537,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6785,9 +6771,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -7046,9 +7030,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -8493,8 +8475,6 @@ components: bearerFormat: JWT scheme: bearer servers: - # - description: SwaggerHub API Auto Mocking - # url: https://virtserver.swaggerhub.com/michielverhoef/Documenten_API/1.4.2 - url: https://documenten-api.vng.cloud/api/v2 description: Productie Omgeving - url: https://documenten-api.test.vng.cloud/api/v2 diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index ca101db5e..b1da3cd24 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Documenten API - version: 1.5.0 + version: 2.0.0 description: > Een API om een documentregistratiecomponent (DRC) te benaderen. @@ -1204,7 +1204,6 @@ paths: - correcte `lock` waarde - - status NIET `definitief` summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. parameters: - in: path @@ -1397,7 +1396,7 @@ paths: **Er wordt gevalideerd op** - correcte `lock` waarde - - status NIET `definitief` + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. parameters: - in: path @@ -5329,24 +5328,16 @@ components: description: "Uitleg bij de enumeratiewaarden: - * `mutabel` - (Mutabel) Vorm en inhoud van het informatieobject + * `veranderlijk` - (Veranderlijk) Vorm en inhoud van het informatieobject kunnen vrijelijk veranderen. * `onveranderlijk` - (Onveranderlijk) Vorm en inhoud van het informatieobject zijn onveranderlijk geworden zodat authenticiteit - en integriteit gewaarborgd zijn. - - * `duurzaam_toegankelijk` (Duurzaam toegankelijk) Het - informatieobject voldoet aan de eisen van duurzame - toegankelijkheid (het is vindbaar, beschikbaar, leesbaar, - interpreteerbaar, betrouwbaar en toekomstbestendig) en kan - op het in de selectielijst voorgeschreven moment vernietigd - of overgebracht worden." + en integriteit gewaarborgd zijn." type: string enum: - - mutabel + - veranderlijk - onveranderlijk - - duurzaam_toegankelijk AuditTrail: type: object properties: @@ -6009,9 +6000,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6027,19 +6016,6 @@ components: title: Inhoud is vervallen type: boolean nullable: true - bevatNietOpenbarePersoonsgegevens: - description: >- - Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens - aanwezig zijn die niet openbaar gemaakt mogen worden. - - * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die - niet openbaar gemaakt mogen worden. - - * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig - die niet openbaar gemaakt mogen worden. - title: Bevat niet-openbare persoonsgegevens - type: boolean - nullable: true formaat: type: string description: >- @@ -6293,9 +6269,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6311,19 +6285,6 @@ components: title: Inhoud is vervallen type: boolean nullable: true - bevatNietOpenbarePersoonsgegevens: - description: >- - Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens - aanwezig zijn die niet openbaar gemaakt mogen worden. - - * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die - niet openbaar gemaakt mogen worden. - - * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig - die niet openbaar gemaakt mogen worden. - title: Bevat niet-openbare persoonsgegevens - type: boolean - nullable: true formaat: type: string description: >- @@ -6576,9 +6537,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6594,19 +6553,6 @@ components: title: Inhoud is vervallen type: boolean nullable: true - bevatNietOpenbarePersoonsgegevens: - description: >- - Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens - aanwezig zijn die niet openbaar gemaakt mogen worden. - - * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die - niet openbaar gemaakt mogen worden. - - * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig - die niet openbaar gemaakt mogen worden. - title: Bevat niet-openbare persoonsgegevens - type: boolean - nullable: true formaat: type: string description: >- @@ -6825,9 +6771,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6843,19 +6787,6 @@ components: title: Inhoud is vervallen type: boolean nullable: true - bevatNietOpenbarePersoonsgegevens: - description: >- - Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens - aanwezig zijn die niet openbaar gemaakt mogen worden. - - * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die - niet openbaar gemaakt mogen worden. - - * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig - die niet openbaar gemaakt mogen worden. - title: Bevat niet-openbare persoonsgegevens - type: boolean - nullable: true formaat: type: string description: >- @@ -7099,9 +7030,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan in hoeverre het INFORMATIEOBJECT duurzaam - toegankelijk is en op het voorgeschreven moment vernietigd of - overgebracht kan worden. + Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -7117,19 +7046,6 @@ components: title: Inhoud is vervallen type: boolean nullable: true - bevatNietOpenbarePersoonsgegevens: - description: >- - Geeft aan of in de inhoud van het INFORMATIEOBJECT persoonsgegevens - aanwezig zijn die niet openbaar gemaakt mogen worden. - - * `true` In het INFORMATIEOBJECT zijn persoonsgegevens aanwezig die - niet openbaar gemaakt mogen worden. - - * `false` In het INFORMATIEOBJECT zijn geen persoonsgegevens aanwezig - die niet openbaar gemaakt mogen worden. - title: Bevat niet-openbare persoonsgegevens - type: boolean - nullable: true formaat: type: string description: >- @@ -8559,10 +8475,10 @@ components: bearerFormat: JWT scheme: bearer servers: - - description: SwaggerHub API Auto Mocking - url: https://virtserver.swaggerhub.com/michielverhoef/Documenten_API/1.4.2 - - url: https://documenten-api.vng.cloud/api/v1 + - url: https://documenten-api.vng.cloud/api/v2 description: Productie Omgeving + - url: https://documenten-api.test.vng.cloud/api/v2 + description: Test Omgeving tags: - name: enkelvoudiginformatieobjecten description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). From 6ce76ec636dae1718456541dfaff46f290a74f26 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Fri, 1 Mar 2024 14:58:29 +0100 Subject: [PATCH 16/17] Update openapi.yaml --- api-specificatie/drc/2.0.x/2.0.0/openapi.yaml | 10 +++++----- api-specificatie/drc/current_version/openapi.yaml | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml index b1da3cd24..c9f2148dd 100644 --- a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml +++ b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml @@ -6000,7 +6000,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6269,7 +6269,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6537,7 +6537,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6771,7 +6771,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -7030,7 +7030,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index b1da3cd24..c9f2148dd 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -6000,7 +6000,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6269,7 +6269,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6537,7 +6537,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -6771,7 +6771,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' @@ -7030,7 +7030,7 @@ components: - $ref: '#/components/schemas/StatusEnum' archiefstatus: description: >- - Geeft aan of het INFORMATIEOBJECT veranderlijk of onveranderlijk is. + Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. title: Archiefstatus oneOf: - $ref: '#/components/schemas/ArchiefstatusEnum' From 081b28cbbc5b4ab907ea781748a66dc8ea631724 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 4 Mar 2024 10:13:21 +0100 Subject: [PATCH 17/17] Update OAS --- api-specificatie/drc/2.0.x/2.0.0/openapi.yaml | 65 ++++++++----------- .../drc/current_version/openapi.yaml | 65 ++++++++----------- 2 files changed, 56 insertions(+), 74 deletions(-) diff --git a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml index c9f2148dd..ebb4aab85 100644 --- a/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml +++ b/api-specificatie/drc/2.0.x/2.0.0/openapi.yaml @@ -5995,9 +5995,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -6264,9 +6263,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -6532,9 +6530,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -6766,9 +6763,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -7025,9 +7021,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -8028,29 +8023,29 @@ components: - digitaal - pki type: string + # StatusEnum: + # description: + # "Uitleg bij mogelijke waarden: + + # * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + # gewerkt. + + # * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + # maar moet nog vastgesteld worden. + + # * `definitief` - (Definitief) Informatieobject door bevoegd iets of + # iemand vastgesteld dan wel ontvangen. + + # * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + # bewaarbaar gemaakt; een gearchiveerd informatie-element." + # enum: + # - in_bewerking + # - ter_vaststelling + # - definitief + # - gearchiveerd + # type: string + # deprecated: true StatusEnum: - description: - "Uitleg bij mogelijke waarden: - - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element." - enum: - - in_bewerking - - ter_vaststelling - - definitief - - gearchiveerd - type: string - deprecated: true - StatusEnumV2: description: "Uitleg bij de enumeratiewaarden: @@ -8070,11 +8065,7 @@ components: is betrokken bij een lopend besluitvormingsproces. * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is - bekrachtigd tijdens een besluitvormingsproces. - - - **Let op:** De waarden `concept` en `vastgesteld` zijn nieuw vanaf versie 1.5.0 - van deze API." + bekrachtigd tijdens een besluitvormingsproces." enum: - in_bewerking - concept diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index c9f2148dd..ebb4aab85 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -5995,9 +5995,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -6264,9 +6263,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -6532,9 +6530,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -6766,9 +6763,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -7025,9 +7021,8 @@ components: Geeft de status van het INFORMATIEOBJECT aan in een proces van bewerking en eventuele vaststelling. title: Status oneOf: - - $ref: '#/components/schemas/StatusEnumV2' - - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' archiefstatus: description: >- Geeft aan of vorm en inhoud van het INFORMATIEOBJECT nog aanpast mogen worden, of dat deze het in het kader van archivering zijn bevroren. @@ -8028,29 +8023,29 @@ components: - digitaal - pki type: string + # StatusEnum: + # description: + # "Uitleg bij mogelijke waarden: + + # * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + # gewerkt. + + # * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + # maar moet nog vastgesteld worden. + + # * `definitief` - (Definitief) Informatieobject door bevoegd iets of + # iemand vastgesteld dan wel ontvangen. + + # * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + # bewaarbaar gemaakt; een gearchiveerd informatie-element." + # enum: + # - in_bewerking + # - ter_vaststelling + # - definitief + # - gearchiveerd + # type: string + # deprecated: true StatusEnum: - description: - "Uitleg bij mogelijke waarden: - - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog - gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed - maar moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of - iemand vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam - bewaarbaar gemaakt; een gearchiveerd informatie-element." - enum: - - in_bewerking - - ter_vaststelling - - definitief - - gearchiveerd - type: string - deprecated: true - StatusEnumV2: description: "Uitleg bij de enumeratiewaarden: @@ -8070,11 +8065,7 @@ components: is betrokken bij een lopend besluitvormingsproces. * `vastgesteld` - (Vastgesteld) De inhoud van het informatieobject is - bekrachtigd tijdens een besluitvormingsproces. - - - **Let op:** De waarden `concept` en `vastgesteld` zijn nieuw vanaf versie 1.5.0 - van deze API." + bekrachtigd tijdens een besluitvormingsproces." enum: - in_bewerking - concept