@@ -4087,6 +4087,62 @@ paths:
4087
4087
$ref : ' #/components/headers/X-Is-Form-Designer'
4088
4088
Content-Language :
4089
4089
$ref : ' #/components/headers/Content-Language'
4090
+ /api/v2/registration/plugins/zgw-api/role-types :
4091
+ get :
4092
+ operationId : registration_plugins_zgw_api_role_types_list
4093
+ description : |-
4094
+ Fetch and serialize a list of objects.
4095
+
4096
+ Alternative to :class:`rest_framework.mixins.ListModelMixin` for non-database
4097
+ backed collections of objects.
4098
+ summary : List the available role types bound to a case type within a catalogue
4099
+ (ZGW APIs)
4100
+ parameters :
4101
+ - in : query
4102
+ name : case_type_identification
4103
+ schema :
4104
+ type : string
4105
+ minLength : 1
4106
+ description : Filter case types against this identification.
4107
+ required : true
4108
+ - in : query
4109
+ name : catalogue_url
4110
+ schema :
4111
+ type : string
4112
+ format : uri
4113
+ title : catalogus URL
4114
+ minLength : 1
4115
+ description : Filter case types against this catalogue URL.
4116
+ required : true
4117
+ - in : query
4118
+ name : zgw_api_group
4119
+ schema :
4120
+ type : integer
4121
+ description : The primary key of the ZGW API group to use. The informatieobjecttypen
4122
+ from the Catalogi API in this group will be returned.
4123
+ required : true
4124
+ tags :
4125
+ - registration
4126
+ security :
4127
+ - cookieAuth : []
4128
+ responses :
4129
+ ' 200 ' :
4130
+ content :
4131
+ application/json :
4132
+ schema :
4133
+ type : array
4134
+ items :
4135
+ $ref : ' #/components/schemas/RoleType'
4136
+ description : ' '
4137
+ headers :
4138
+ X-Session-Expires-In :
4139
+ $ref : ' #/components/headers/X-Session-Expires-In'
4140
+ X-CSRFToken :
4141
+ $ref : ' #/components/headers/X-CSRFToken'
4142
+ X-Is-Form-Designer :
4143
+ $ref : ' #/components/headers/X-Is-Form-Designer'
4144
+ Content-Language :
4145
+ $ref : ' #/components/headers/Content-Language'
4090
4146
/api/v2/service-fetch-configurations :
4091
4147
get :
4092
4148
operationId : service_fetch_configurations_list
@@ -9728,6 +9784,21 @@ components:
9728
9784
required :
9729
9785
- x
9730
9786
- y
9787
+ RoleType :
9788
+ type : object
9789
+ properties :
9790
+ description :
9791
+ type : string
9792
+ description : The description/label given to the role type in the Catalogi
9793
+ API. It identifies the role type within a case type.
9794
+ descriptionGeneric :
9795
+ type : string
9796
+ title : generic description
9797
+ description : One of the pre-determined generic descriptions, such as 'behandelaar'
9798
+ or 'belanghebbende'.
9799
+ required :
9800
+ - description
9801
+ - descriptionGeneric
9731
9802
Service :
9732
9803
type : object
9733
9804
properties :
0 commit comments