Merge pull request #1475 from open-zaak/feature/1423-zaaktype-identif…

…icatie

add 'zaaktypeIdentificatie' property to catalogi resources

src/openzaak/components/catalogi/api/serializers/eigenschap.py

@@ -1,5 +1,7 @@
 # SPDX-License-Identifier: EUPL-1.2
 # Copyright (C) 2019 - 2020 Dimpact
+from django.utils.translation import gettext_lazy as _
+
 from drf_writable_nested import NestedCreateMixin, NestedUpdateMixin
 from rest_framework import serializers
 from vng_api_common.serializers import add_choice_values_help_text
@@ -44,6 +46,14 @@ class EigenschapSerializer(
         lookup_field="uuid",
         help_text=get_help_text("catalogi.ZaakType", "catalogus"),
     )
+    zaaktype_identificatie = serializers.SlugRelatedField(
+        source="zaaktype",
+        read_only=True,
+        slug_field="identificatie",
+        help_text=_(
+            "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt."
+        ),
+    )
 
     class Meta:
         model = Eigenschap
@@ -54,6 +64,7 @@ class Meta:
             "specificatie",
             "toelichting",
             "zaaktype",
+            "zaaktype_identificatie",
             "catalogus",
         )
         extra_kwargs = {

src/openzaak/components/catalogi/api/serializers/relatieklassen.py

@@ -27,12 +27,21 @@ class ZaakTypeInformatieObjectTypeSerializer(serializers.HyperlinkedModelSeriali
         lookup_field="uuid",
         help_text=get_help_text("catalogi.ZaakType", "catalogus"),
     )
+    zaaktype_identificatie = serializers.SlugRelatedField(
+        source="zaaktype",
+        read_only=True,
+        slug_field="identificatie",
+        help_text=_(
+            "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt."
+        ),
+    )
 
     class Meta:
         model = ZaakTypeInformatieObjectType
         fields = (
             "url",
             "zaaktype",
+            "zaaktype_identificatie",
             "informatieobjecttype",
             "volgnummer",
             "richting",

src/openzaak/components/catalogi/api/serializers/resultaattype.py

@@ -66,12 +66,21 @@ class ResultaatTypeSerializer(
         lookup_field="uuid",
         help_text=get_help_text("catalogi.ZaakType", "catalogus"),
     )
+    zaaktype_identificatie = serializers.SlugRelatedField(
+        source="zaaktype",
+        read_only=True,
+        slug_field="identificatie",
+        help_text=_(
+            "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt."
+        ),
+    )
 
     class Meta:
         model = ResultaatType
         fields = (
             "url",
             "zaaktype",
+            "zaaktype_identificatie",
             "omschrijving",
             "resultaattypeomschrijving",
             "omschrijving_generiek",

src/openzaak/components/catalogi/api/serializers/roltype.py

@@ -1,5 +1,7 @@
 # SPDX-License-Identifier: EUPL-1.2
 # Copyright (C) 2019 - 2020 Dimpact
+from django.utils.translation import gettext_lazy as _
+
 from drf_writable_nested import NestedCreateMixin
 from rest_framework import serializers
 from vng_api_common.constants import RolOmschrijving
@@ -18,12 +20,21 @@ class RolTypeSerializer(NestedCreateMixin, serializers.HyperlinkedModelSerialize
         lookup_field="uuid",
         help_text=get_help_text("catalogi.ZaakType", "catalogus"),
     )
+    zaaktype_identificatie = serializers.SlugRelatedField(
+        source="zaaktype",
+        read_only=True,
+        slug_field="identificatie",
+        help_text=_(
+            "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt."
+        ),
+    )
 
     class Meta:
         model = RolType
         fields = (
             "url",
             "zaaktype",
+            "zaaktype_identificatie",
             "omschrijving",
             "omschrijving_generiek",
             "catalogus",

src/openzaak/components/catalogi/api/serializers/statustype.py

@@ -25,6 +25,14 @@ class StatusTypeSerializer(serializers.HyperlinkedModelSerializer):
         lookup_field="uuid",
         help_text=get_help_text("catalogi.ZaakType", "catalogus"),
     )
+    zaaktype_identificatie = serializers.SlugRelatedField(
+        source="zaaktype",
+        read_only=True,
+        slug_field="identificatie",
+        help_text=_(
+            "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt."
+        ),
+    )
 
     class Meta:
         model = StatusType
@@ -34,6 +42,7 @@ class Meta:
             "omschrijving_generiek",
             "statustekst",
             "zaaktype",
+            "zaaktype_identificatie",
             "volgnummer",
             "is_eindstatus",
             "informeren",

src/openzaak/components/catalogi/openapi.yaml

@@ -5003,6 +5003,12 @@ components:
             EIGENSCHAP van belang is.
           type: string
           format: uri
+        zaaktypeIdentificatie:
+          title: Zaaktype identificatie
+          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+            het ZAAKTYPE voorkomt.
+          type: string
+          readOnly: true
         catalogus:
           title: Catalogus
           description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort.
@@ -5293,6 +5299,12 @@ components:
             van dit RESULTAATTYPE bereikt kunnen worden.
           type: string
           format: uri
+        zaaktypeIdentificatie:
+          title: Zaaktype identificatie
+          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+            het ZAAKTYPE voorkomt.
+          type: string
+          readOnly: true
         omschrijving:
           title: Omschrijving
           description: Omschrijving van de aard van resultaten van het RESULTAATTYPE.
@@ -5391,6 +5403,12 @@ components:
             kunnen zijn.
           type: string
           format: uri
+        zaaktypeIdentificatie:
+          title: Zaaktype identificatie
+          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+            het ZAAKTYPE voorkomt.
+          type: string
+          readOnly: true
         omschrijving:
           title: Omschrijving
           description: Omschrijving van de aard van de ROL.
@@ -5470,6 +5488,12 @@ components:
             van dit STATUSTYPE bereikt kunnen worden.
           type: string
           format: uri
+        zaaktypeIdentificatie:
+          title: Zaaktype identificatie
+          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+            het ZAAKTYPE voorkomt.
+          type: string
+          readOnly: true
         volgnummer:
           title: Volgnummer
           description: Een volgnummer voor statussen van het STATUSTYPE binnen een
@@ -5589,6 +5613,12 @@ components:
           description: URL-referentie naar het ZAAKTYPE.
           type: string
           format: uri
+        zaaktypeIdentificatie:
+          title: Zaaktype identificatie
+          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+            het ZAAKTYPE voorkomt.
+          type: string
+          readOnly: true
         informatieobjecttype:
           title: Informatie object type
           description: URL-referentie naar het INFORMATIEOBJECTTYPE.

src/openzaak/components/catalogi/resources.md

@@ -72,6 +72,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Rgbz_1.0/doc/o
 | definitie | De beschrijving van de betekenis van deze EIGENSCHAP | string | ja | C​R​U​D |
 | toelichting | Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE. | string | nee | C​R​U​D |
 | zaaktype | URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is. | string | ja | C​R​U​D |
+| zaaktypeIdentificatie | Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | catalogus | URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 
 ## InformatieObjectType
@@ -107,6 +108,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Rgbz_1.0/doc/o
 | --- | --- | --- | --- | --- |
 | url | URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | zaaktype | URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten van dit RESULTAATTYPE bereikt kunnen worden. | string | ja | C​R​U​D |
+| zaaktypeIdentificatie | Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | omschrijving | Omschrijving van de aard van resultaten van het RESULTAATTYPE. | string | ja | C​R​U​D |
 | resultaattypeomschrijving | 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' | string | ja | C​R​U​D |
 | omschrijvingGeneriek | Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) | string | nee | ~~C~~​R​~~U~~​~~D~~ |
@@ -129,6 +131,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Rgbz_1.0/doc/o
 | --- | --- | --- | --- | --- |
 | url | URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | zaaktype | URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken kunnen zijn. | string | ja | C​R​U​D |
+| zaaktypeIdentificatie | Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | omschrijving | Omschrijving van de aard van de ROL. | string | ja | C​R​U​D |
 | omschrijvingGeneriek | Algemeen gehanteerde omschrijving van de aard van de ROL.
 
@@ -155,6 +158,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Rgbz_1.0/doc/o
 | omschrijvingGeneriek | Algemeen gehanteerde omschrijving van de aard van STATUSsen van het STATUSTYPE | string | nee | C​R​U​D |
 | statustekst | De tekst die wordt gebruikt om de Initiator te informeren over het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. | string | nee | C​R​U​D |
 | zaaktype | URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen van dit STATUSTYPE bereikt kunnen worden. | string | ja | C​R​U​D |
+| zaaktypeIdentificatie | Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | volgnummer | Een volgnummer voor statussen van het STATUSTYPE binnen een zaak. | integer | ja | C​R​U​D |
 | isEindstatus | Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. | boolean | nee | ~~C~~​R​~~U~~​~~D~~ |
 | informeren | Aanduiding die aangeeft of na het zetten van een STATUS van dit STATUSTYPE de Initiator moet worden geïnformeerd over de statusovergang. | boolean | nee | C​R​U​D |
@@ -184,6 +188,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Rgbz_1.0/doc/o
 | --- | --- | --- | --- | --- |
 | url | URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | zaaktype | URL-referentie naar het ZAAKTYPE. | string | ja | C​R​U​D |
+| zaaktypeIdentificatie | Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. | string | nee | ~~C~~​R​~~U~~​~~D~~ |
 | informatieobjecttype | URL-referentie naar het INFORMATIEOBJECTTYPE. | string | ja | C​R​U​D |
 | volgnummer | Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het ZAAKTYPE. | integer | ja | C​R​U​D |
 | richting | Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.

src/openzaak/components/catalogi/swagger2.0.json

@@ -6434,6 +6434,12 @@
                     "type": "string",
                     "format": "uri"
                 },
+                "zaaktypeIdentificatie": {
+                    "title": "Zaaktype identificatie",
+                    "description": "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.",
+                    "type": "string",
+                    "readOnly": true
+                },
                 "catalogus": {
                     "title": "Catalogus",
                     "description": "URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort.",
@@ -6622,6 +6628,12 @@
                     "type": "string",
                     "format": "uri"
                 },
+                "zaaktypeIdentificatie": {
+                    "title": "Zaaktype identificatie",
+                    "description": "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.",
+                    "type": "string",
+                    "readOnly": true
+                },
                 "omschrijving": {
                     "title": "Omschrijving",
                     "description": "Omschrijving van de aard van resultaten van het RESULTAATTYPE.",
@@ -6708,6 +6720,12 @@
                     "type": "string",
                     "format": "uri"
                 },
+                "zaaktypeIdentificatie": {
+                    "title": "Zaaktype identificatie",
+                    "description": "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.",
+                    "type": "string",
+                    "readOnly": true
+                },
                 "omschrijving": {
                     "title": "Omschrijving",
                     "description": "Omschrijving van de aard van de ROL.",
@@ -6781,6 +6799,12 @@
                     "type": "string",
                     "format": "uri"
                 },
+                "zaaktypeIdentificatie": {
+                    "title": "Zaaktype identificatie",
+                    "description": "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.",
+                    "type": "string",
+                    "readOnly": true
+                },
                 "volgnummer": {
                     "title": "Volgnummer",
                     "description": "Een volgnummer voor statussen van het STATUSTYPE binnen een zaak.",
@@ -6913,6 +6937,12 @@
                     "type": "string",
                     "format": "uri"
                 },
+                "zaaktypeIdentificatie": {
+                    "title": "Zaaktype identificatie",
+                    "description": "Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.",
+                    "type": "string",
+                    "readOnly": true
+                },
                 "informatieobjecttype": {
                     "title": "Informatie object type",
                     "description": "URL-referentie naar het INFORMATIEOBJECTTYPE.",

src/openzaak/components/catalogi/tests/test_eigenschap.py

@@ -97,6 +97,7 @@ def test_list_eigenschappen(self):
                 "naam": "objecttype",
                 "definitie": "",
                 "zaaktype": f"http://testserver{zaaktype_url}",
+                "zaaktypeIdentificatie": zaaktype.identificatie,
                 "toelichting": "",
                 "specificatie": {
                     "formaat": FormaatChoices.tekst,
@@ -157,6 +158,7 @@ def test_get_detail(self):
             },
             "toelichting": "",
             "zaaktype": "http://testserver{}".format(zaaktype_url),
+            "zaaktypeIdentificatie": zaaktype.identificatie,
             "catalogus": f"http://testserver{reverse(zaaktype.catalogus)}",
         }
         self.assertEqual(expected, response.json())

src/openzaak/components/catalogi/tests/test_relatieklassen.py

@@ -60,6 +60,7 @@ def test_get_detail(self):
         expected = {
             "url": f"http://testserver{url}",
             "zaaktype": f"http://testserver{zaaktype_url}",
+            "zaaktypeIdentificatie": ztiot.zaaktype.identificatie,
             "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
             "volgnummer": ztiot.volgnummer,
             "richting": ztiot.richting,

src/openzaak/components/catalogi/tests/test_resultaattype.py

@@ -128,6 +128,7 @@ def test_get_detail(self):
             {
                 "url": f"http://testserver{url}",
                 "zaaktype": f"http://testserver{zaaktype_url}",
+                "zaaktypeIdentificatie": resultaattype.zaaktype.identificatie,
                 "omschrijving": resultaattype.omschrijving,
                 "resultaattypeomschrijving": resultaattype.resultaattypeomschrijving,
                 "omschrijvingGeneriek": resultaattype.omschrijving_generiek,

src/openzaak/components/catalogi/tests/test_roltype.py

@@ -49,9 +49,8 @@ def test_get_detail(self):
 
         expected = {
             "url": f"http://testserver{rol_type_detail_url}",
-            # 'ingangsdatumObject': '2018-01-01',
-            # 'einddatumObject': None,
             "zaaktype": f"http://testserver{zaaktype_url}",
+            "zaaktypeIdentificatie": rol_type.zaaktype.identificatie,
             "omschrijving": "Vergunningaanvrager",
             "omschrijvingGeneriek": RolOmschrijving.initiator,
             "catalogus": f"http://testserver{reverse(zaaktype.catalogus)}",

src/openzaak/components/catalogi/tests/test_statustype.py

@@ -55,6 +55,7 @@ def test_get_detail(self):
             "omschrijvingGeneriek": "",
             "statustekst": "",
             "zaaktype": "http://testserver{}".format(zaaktype_url),
+            "zaaktypeIdentificatie": zaaktype.identificatie,
             "volgnummer": statustype.statustypevolgnummer,
             "isEindstatus": True,
             "informeren": False,