Verplaats sleutelWaarde en URN naar body van melding en uit gegevens

Logius-standaarden · Apr 5, 2024 · 3c49654 · 3c49654
1 parent e796ba1
commit 3c49654
Show file tree

Hide file tree

Showing 3 changed files with 118 additions and 101 deletions.
diff --git a/Ontwerp/TerugMelden spec.json b/Ontwerp/TerugMelden spec.json
@@ -60,14 +60,27 @@
       "TerugMelding": {
         "type": "object",
         "properties": {
-          "TerugMeldingHeader": {
+          "terugMeldingHeader": {
             "$ref": "#/components/schemas/TerugMeldingHeader"
           },
-          "TerugMeldingBody": {
-            "type": "array",
-            "minItems": 1,
-            "items": {
-              "$ref": "#/components/schemas/TerugMeldingGegeven"
+          "terugMeldingBody": {
+            "type": "object",
+            "properties": {
+              "gegevensElementSleutelUrn": {
+                "description": "De unieke verwijzing naar de sleutel van het hoofdelement waar de wijziging in plaats moet vinden. (bijv: urn:brp:persoon:bsn).",
+                "type": "string"
+              },
+              "gegevensElementSleutelWaarde": {
+                "description": "De inhoud van het veld gespecificeerd in gegevensElementSleutelUrn.",
+                "type": "string"
+              },
+              "terugMeldingGegevens": {
+                "type": "array",
+                "minItems": 1,
+                "items": {
+                  "$ref": "#/components/schemas/TerugMeldingGegeven"
+                }
+              }
             }
           }
         }
@@ -146,14 +159,6 @@
       "TerugMeldingGegeven": {
         "type": "object",
         "properties": {
-          "gegevensElementSleutelUrn": {
-            "description": "De unieke verwijzing naar de sleutel van het hoofdelement waar de wijziging in plaats moet vinden. (bijv: urn:brp:persoon:bsn).",
-            "type": "string"
-          },
-          "gegevensElementSleutelWaarde": {
-            "description": "De inhoud van het veld gespecificeerd in gegevensElementSleutelUrn.",
-            "type": "string"
-          },
           "gegevensElementNaam": {
             "description": "Een eventueel subelement/object waar de wijziging in plaats moet vinden. Gebruik dit als de gegevensElementSleutel hoort bij een ander element dan waar de wijziging moet plaats vinden. (bijv: sleutel hoort bij bedrijf, melding heeft betrekking op bedrijf/adres)",
             "type": "string"

diff --git a/Ontwerp/TerugMelden spec.yaml b/Ontwerp/TerugMelden spec.yaml
@@ -1,63 +1,78 @@
-
 openapi: 3.1.0
 info:
-  title: Terugmeldingen Standaard 
-  description: Specificatie voor terugmelden op overheidsregistraties 
+  title: Terugmeldingen Standaard
+  description: Specificatie voor terugmelden op overheidsregistraties
   version: '0.1'
 paths:
   /terugmelding:
     get:
-      parameters: 
+      parameters:
         - name: terugMeldingReferentie
           schema:
             type: string
             format: uuid
       responses:
-        '200': 
+        '200':
           description: ''
           content:
-            application/json: 
-              schema:          
+            application/json:
+              schema:
                 $ref: '#/components/schemas/Ontvangen'
     post:
-      requestBody: 
+      requestBody:
         content:
-          application/json: 
-            schema:          
+          application/json:
+            schema:
               $ref: '#/components/schemas/TerugMelding'
       responses:
-        '200': 
+        '200':
           description: ''
           content:
-            application/json: 
-              schema:          
+            application/json:
+              schema:
                 $ref: '#/components/schemas/Ontvangen'
 components:
   schemas:
     TerugMelding:
       type: object
-      properties: 
-        TerugMeldingHeader:
+      properties:
+        terugMeldingHeader:
           $ref: '#/components/schemas/TerugMeldingHeader'
-        TerugMeldingBody:
-          type: array
-          minItems: 1
-          items:
-            $ref: '#/components/schemas/TerugMeldingGegeven'
+        terugMeldingBody:
+          type: object
+          properties:
+            gegevensElementSleutelUrn:
+              description: >-
+                De unieke verwijzing naar de sleutel van het hoofdelement waar
+                de wijziging in plaats moet vinden. (bijv: urn:brp:persoon:bsn).
+              type: string
+            gegevensElementSleutelWaarde:
+              description: >-
+                De inhoud van het veld gespecificeerd in
+                gegevensElementSleutelUrn.
+              type: string
+            terugMeldingGegevens:
+              type: array
+              minItems: 1
+              items:
+                $ref: '#/components/schemas/TerugMeldingGegeven'
     TerugMeldingHeader:
       type: object
-      properties: 
+      properties:
         RegistratieNaam:
           type: string
         BasisRegistratieCode:
-          description: 'Code (maximaal 3 letterig) waarmee de basisregistratie wordt aangeduid wanneer de houder van een landelijke voorziening meer dan 1 basisregistratie beheert (bv BRT, BGT).'
+          description: >-
+            Code (maximaal 3 letterig) waarmee de basisregistratie wordt
+            aangeduid wanneer de houder van een landelijke voorziening meer dan
+            1 basisregistratie beheert (bv BRT, BGT).
           type: string
           oneOf:
             - title: Basisregistratie Personen
               const: BRP
             - title: Basisregistratie Adressen en Gebouwen
               const: BAG
-            - title: Handelsregister 
+            - title: Handelsregister
               const: HR
             - title: Basisregistratie Kadaster
               const: BRK
@@ -73,44 +88,45 @@ components:
               const: BRO
             - title: Basisregistratie Inkomen
               const: BRI
-        melder: 
+        melder:
           type: object
           $ref: '#/components/schemas/ContactInformatie'
         datumMelding:
           type: string
           format: date
         peilmoment:
-          description: 'Datum en tijd waarop de waarneming is gedaan.'
+          description: Datum en tijd waarop de waarneming is gedaan.
           type: string
           format: date-time
         referentiekenmerk:
-          description: 'Een eigen kenmerk voor de terugmelding van de melder.'
+          description: Een eigen kenmerk voor de terugmelding van de melder.
           type: string
     TerugMeldingGegeven:
       type: object
-      properties: 
-        gegevensElementSleutelUrn:
-          description: 'De unieke verwijzing naar de sleutel van het hoofdelement waar de wijziging in plaats moet vinden. (bijv: urn:brp:persoon:bsn).'
-          type: string 
-        gegevensElementSleutelWaarde:
-          description: 'De inhoud van het veld gespecificeerd in gegevensElementSleutelUrn.'
-          type: string 
+      properties:
         gegevensElementNaam:
-          description: 'Een eventueel subelement/object waar de wijziging in plaats moet vinden. Gebruik dit als de gegevensElementSleutel hoort bij een ander element dan waar de wijziging moet plaats vinden. (bijv: sleutel hoort bij bedrijf, melding heeft betrekking op bedrijf/adres)'
-          type: string 
+          description: >-
+            Een eventueel subelement/object waar de wijziging in plaats moet
+            vinden. Gebruik dit als de gegevensElementSleutel hoort bij een
+            ander element dan waar de wijziging moet plaats vinden. (bijv:
+            sleutel hoort bij bedrijf, melding heeft betrekking op
+            bedrijf/adres)
+          type: string
         attribuut:
-          description: 'De naam van het attribuut (huisnummer, beschrijving, achternaam).'
+          description: De naam van het attribuut (huisnummer, beschrijving, achternaam).
           type: string
         attribuutUrn:
-          description: 'De unieke verwijzing naar het attribuut wat gewijzigd moet worden (bijv. urn:brp:persoon:binnenlands-adres-ingezetene:huisnummer).'
+          description: >-
+            De unieke verwijzing naar het attribuut wat gewijzigd moet worden
+            (bijv. urn:brp:persoon:binnenlands-adres-ingezetene:huisnummer).
           type: string
         betwijfeldeWaarde:
           type: string
         voorgesteldeWaarde:
           type: string
         bijlages:
           type: array
-          items: 
+          items:
             $ref: '#/components/schemas/Bijlage'
     ContactInformatie:
       type: object
@@ -119,10 +135,10 @@ components:
           type: string
         telefoon:
           type: string
-          pattern: '^[0-9+-]{8,20}$'
+          pattern: ^[0-9+-]{8,20}$
         email:
           type: string
-          pattern: '^.+@.+\..+$'
+          pattern: ^.+@.+\..+$
         bedrijf:
           type: string
     Bijlage:
@@ -134,35 +150,38 @@ components:
           type: string
         mimeType:
           type: string
-          oneOf: 
-            - title: 'application/pdf'
-            - title: 'image/jpeg'
+          oneOf:
+            - title: application/pdf
+            - title: image/jpeg
         bijlageData:
-          description: 'Het bestand zelf in Base64-binary encoding.'
+          description: Het bestand zelf in Base64-binary encoding.
           type: string
     Ontvangen:
-      description: 'Terugmelding ontvangen'
+      description: Terugmelding ontvangen
       type: object
       properties:
         terugMeldingReferentie:
-          description: 'Een door de ontvangende partij gegenereerde referentie van de TerugMelding'
+          description: >-
+            Een door de ontvangende partij gegenereerde referentie van de
+            TerugMelding
           type: string
           format: uuid
         referentieKenmerk:
-          description: 'De door de meldende partij opgegeven referentie'
+          description: De door de meldende partij opgegeven referentie
           type: string
-        status: 
-          description: 'Code (maximaal 3 letterig) waarmee de basisregistratie wordt aangeduid wanneer de houder van een landelijke voorziening meer dan 1 basisregistratie beheert (bv BRT, BGT).'
+        status:
+          description: >-
+            Code (maximaal 3 letterig) waarmee de basisregistratie wordt
+            aangeduid wanneer de houder van een landelijke voorziening meer dan
+            1 basisregistratie beheert (bv BRT, BGT).
           type: string
-          oneOf: 
+          oneOf:
             - title: Gemeld
             - title: In Behandeling
             - title: Ingepland
             - title: Ingetrokken
             - title: Onvoldoende ContactInformatie
             - title: Afgehandeld
         beschrijving:
-          description: 'Aanvullende informatie over de terugmelding'
+          description: Aanvullende informatie over de terugmelding
           type: string
-
-
diff --git a/Ontwerp/TerugMelden voorbeeld.json b/Ontwerp/TerugMelden voorbeeld.json
@@ -1,5 +1,5 @@
 {
-  "TerugMeldingHeader": {
+  "terugMeldingHeader": {
     "RegistratieNaam": "Basisregistratie Personen",
     "BasisRegistratieCode": "BRP",
     "melder": {
@@ -12,40 +12,33 @@
     "referentiekenmerk": "DGM001",
     "peilmoment": "2024-04-03T10:42:37.146Z"
   },
-  "TerugMeldingBody": [
-    {
+  "terugMeldingBody": {
       "gegevensElementSleutelUrn": "urn:brp:persoon:bsn",
       "gegevensElementSleutelWaarde": "987463264",
-      "gegevensElementNaam": "Binnenlands adres ingezetene",
-      "attribuut": "huisnummer",
-      "attribuutUrn": "urn:brp:persoon:binnenlands-adres-ingezetene:huisnummer",
-      "betwijfeldeWaarde": "23",
-      "voorgesteldeWaarde": "21",
-      "bijlages": [
-        {
-          "bestandsnaam": "image001.jpg",
-          "mimeType": "image/jpeg",
-          "bijlageData": "2984a720393290b4d2390",
-          "beschrijving": "screenshot"
-        }
-      ]
-    },
-    {
-      "gegevensElementSleutelUrn": "urn:brp:persoon:bsn",
-      "gegevensElementSleutelWaarde": "987463264",
-      "gegevensElementNaam": "Nationaliteit ingezetene",
-      "attribuut": "nationaliteit",
-      "attribuutUrn": "urn:brp:persoon:nationaliteit-ingezetene:huisnummer",
-      "betwijfeldeWaarde": "DE",
-      "voorgesteldeWaarde": "NL",
-      "bijlages": []
-    }
-  ],
-  "TerugMeldingResponse":
-  {
-    "terugMeldingReferentie": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-    "referentiekenmerk": "DGM001",
-    "status": "Gemeld",
-    "beschrijving": "Uw melding wordt binnen 5 werkdagen in behandeling genomen."
+      "terugMeldingGegevens": [
+      {
+        "gegevensElementNaam": "Binnenlands adres ingezetene",
+        "attribuut": "huisnummer",
+        "attribuutUrn": "urn:brp:persoon:binnenlands-adres-ingezetene:huisnummer",
+        "betwijfeldeWaarde": "23",
+        "voorgesteldeWaarde": "21",
+        "bijlages": [
+          {
+            "bestandsnaam": "image001.jpg",
+            "mimeType": "image/jpeg",
+            "bijlageData": "2984a720393290b4d2390",
+            "beschrijving": "screenshot"
+          }
+        ]
+      },
+      {
+        "gegevensElementNaam": "Nationaliteit ingezetene",
+        "attribuut": "nationaliteit",
+        "attribuutUrn": "urn:brp:persoon:nationaliteit-ingezetene:huisnummer",
+        "betwijfeldeWaarde": "DE",
+        "voorgesteldeWaarde": "NL",
+        "bijlages": []
+      }
+    ]
   }
 }