Verschillen
Dit geeft de verschillen weer tussen de geselecteerde revisie en de huidige revisie van de pagina.
| Beide kanten vorige revisie Vorige revisie | |||
| stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_rol [2026/07/15 10:16] – ↷ Pagina verplaatst van stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_rol naar dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_rol Kars Gottschal | stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_rol [2026/07/15 11:07] (huidige) – aangemaakt - Externe bewerking 127.0.0.1 | ||
|---|---|---|---|
| Regel 1: | Regel 1: | ||
| + | ===== Creëer rol en contactadres conform OpenZaak API ===== | ||
| + | {{tag> | ||
| + | Op het endpoint // | ||
| + | De // | ||
| + | |||
| + | Gebaseerd op versie Open Zaak API 1.2 | ||
| + | |||
| + | <adm warning Whitelist> | ||
| + | De zender die hier een creëer rolbericht POST zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel [[stable: | ||
| + | In de tabel tbendpointlist zal minimaal het endpoint /// | ||
| + | </ | ||
| + | |||
| + | ===== Authorisation Token ===== | ||
| + | |||
| + | In de Authorization header van dit POST bericht moet een valide JWT-token worden meegegeven onder Bearer Token. | ||
| + | Zie voorbeeld bij [[stable: | ||
| + | |||
| + | Voor het verkrijgen van een token (met beperkte geldigheidsduur!) zie: [[stable: | ||
| + | |||
| + | De token wordt opgezocht in de tabel tbaccesstoken en het tijdstip van aanvraag wordt getoetst aan de geldigheidsduur van de gevonden rij. | ||
| + | |||
| + | <adm warning (robot) Medewerker moet gelinkt zijn aan endpoint> | ||
| + | De gevonden token is gelinkt aan een (robot)-medewerker (degene onder wiens credentials het token is gecreëerd). Bij de betreffende medewerkers kaart moet de kolom //Endpoint (robotmedewerker is gedefinieerd voor binnenkomende berichten op endpoint)// (dnkeyendpointlist) in blok login verwijzen naar een kaart in // | ||
| + | </ | ||
| + | |||
| + | ===== Headers ===== | ||
| + | |||
| + | De enige verplichte header variabele is: Content-Type met als waarde // | ||
| + | |||
| + | ===== Body ===== | ||
| + | |||
| + | In application/ | ||
| + | <adm example voorbeeld natuurlijk persoon> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | <adm example voorbeeld vestiging> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | |||
| + | </ | ||
| + | |||
| + | <adm example voorbeeld niet natuurlijk persoon> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | Zie Github: zie POST //Maak een ROL aan bij een ZAAK// op [[https:// | ||
| + | |||
| + | De verwerking van het bericht door OpenWave wordt gelogd in tbmessagelog indien | ||
| + | * de instelling //Sectie: ZGW en Item: Messagelog// | ||
| + | * EN de instelling //Sectie: OWB en Item: MessageLog// | ||
| + | |||
| + | In principe leidt de inhoud van de body tot de aanmaak van een nieuwe contactpersoon of het koppelen van een bestaande contactpersoon onder een rol (tbomgvergcontactennn of tbovcontactennn) bij een omgevingzaak of APV/Overige zaak die eerder is aangemaakt en voorzien is van een gevulde kolom dvzgwuuid. Dit, mits aan de nodige voorwaarden in de OpenWave implementatie is voldaan: | ||
| + | * de waarde van item: // | ||
| + | * Er moet tenminste één valide kaart zijn in de OpenWave roltype tabel (tbzgwroltypes) met een gevulde unieke UUID-code in de kolom // | ||
| + | * De robotmedewerker die verbonden is aan de uitgereikte token moet gekoppeld zijn aan de rechtengroep die het functionele recht tbomgrechten.dlbomgins dan wel tbovrechten.dlbovvins (insertrecht op de omgevingstabel of APV/Overige tabel) aangevinkt heeft staan. | ||
| + | * Er moet een unieke kaart zijn in tbomgvergunning waarvoor geldt dat tbomgvergunning.dvzgwuuid gelijk is aan de waarde (een UUID-code) vanaf de laatste slash van item // | ||
| + | * Indien de instelling //Sectie: ZGW en Item: CheckEenRolContactPerZaak// | ||
| + | * De instelling //Getal1// van //Sectie: ZGW en Item: KeyAnoniemContactadres// | ||
| + | * De adresrol AVR (initiator, aanvrager) mag in OpenWave maar één keer voorkomen bij een zaak. Hierop wordt gecontroleerd. | ||
| + | |||
| + | <adm warning UUID van roltype> | ||
| + | In de koppeltabel tbzgwroltypes (zaakbeheerportaal, | ||
| + | </ | ||
| + | |||
| + | De zaak wordt opgezocht in tbomgvergunning dan wel in tbovvergunningen in de kolom dvzgwuuid op basis van de waarde van item //zaak// vanaf de laatste slash. | ||
| + | Er wordt dan een nieuwe kaart gemaakt in tbomgvergcontactennn of tbovcontactennn met | ||
| + | * dnkeyomgvergunningen = de dnkey van de gevonden rij uit tbomgvergunning OF dnkeyovvergunningen is die uit tbovvergunningen | ||
| + | * dvcodeadressoort = de dvcodeadressoort uit de gevonden rij in tbzgwroltypes | ||
| + | * dnkeycontactadressen = de dnkey van een rij in tbcontactadressen (zie hieronder voor de bepaling hiervan daarvan). | ||
| + | Er wordt een unieke UUID-code uitgetrokken voor de aangemaakte rij en deze code komt in kolom // | ||
| + | |||
| + | **Bepaling contactadreskaart** | ||
| + | In de OpenZaak API hoeven de items “contactpersoonRol” en “betrokkeneIdentificatie” niet in de body zijn opgenomen en de onderliggende items daarvan hoeven ook niet opgenomen te zijn en de waardes daarvan mogen leeg zijn. | ||
| + | OpenWave redeneert daarom als volgt voor de bepaling van het contactadres: | ||
| + | |||
| + | Indien | ||
| + | * item // | ||
| + | * EN binnen item // | ||
| + | * item //naam// leeg of bestaat niet | ||
| + | * EN/OF item // | ||
| + | dan zoekt OpenWave naar de dnkey van de contactadreskaart (tbcontactadressen) gedefinieerd door //Getal1// van de instelling //Sectie: ZGW en Item: KeyAnoniemContactadres// | ||
| + | |||
| + | Anders, indien | ||
| + | * item // | ||
| + | * EN binnen item // | ||
| + | dan zoekt OpenWave naar een geldige kaart in tbcontacadressen met dvemail = // | ||
| + | |||
| + | Anders, - item // | ||
| + | Anders (nog geen kandidaat gevonden) dan zoekt OpenWave naar een geldige kaart in tbcontactadressen met respectievelijk dvnpnanp = // | ||
| + | Anders (en nog niet gevonden dus) dan zoekt OpenWave naar een geldige kaart in tbcontactadressen met dvemail = // | ||
| + | Anders (en nog niet gevonden dus) dan zoekt OpenWave naar een geldige kaart in tbcontactadressen met dvemail = contactpersoonRol emailadres (indien gevuld) EN dvbedrijfsnaam = betrokkeneIdentificatie handelsnaam (indien gevuld en wel de eerste indien gevuld met een rij van handelsnamen). | ||
| + | |||
| + | Voor deze zoekopdrachten geldt dat als er meerdere kandidaten zijn dan dan de eerste de beste de gevonden kaart is.\\ | ||
| + | |||
| + | Indien GEEN contactadreskaart is gevonden dan wordt een nieuwe contactadreskaart aangemaakt met de voorhanden gegevens. | ||
| + | |||
| + | OpenWave maakt nu een kaart aan in tbomgvergcontactennn of in tbovcontactennn bij de zaak met een verwijzing naar de dnkey van de (gevonden of aangemaakte) contactadreskaart en de rol. Voor de combinatie wordt ook een UUID-code uitgetrokken en bij deze regel in de kolom tbomgvergcontactennn.dvzgwuuid dan wel tbovcontactennn.dvzgwuuid geplaatst. | ||
| + | |||
| + | De statutaire naam en de handelsnaam worden zonodig overgenomen in de kolom dvbedrijfsnaam van het contactadres in OpenWave. | ||
| + | |||
| + | Indien de instelling //Sectie: ZGW// met //Item: ContactpersoonOverschrijven// | ||
| + | |||
| + | <adm warning Contactgegevens naar StUF ZAAK/ | ||
| + | Zie betreffende kopje bij [[vereiste_minimale_instellingen|]] | ||
| + | </ | ||
| + | |||
| + | ====== Responsebericht ===== | ||
| + | |||
| + | Indien de rol niet kon worden aangemaakt wordt een responsecode anders dan 200/201 geretourneerd met in de body de oorzaak van het falen. | ||
| + | Indien de rol succesvol is aangemaakt wordt onder de responsecode 201 het oorspronkelijke bericht geretourneerd aangevuld met de verplichte items, waarbij | ||
| + | * in het item //uuid// de code wordt geretourneerd die opgeslagen is in de nieuwe rol (= combinatie zaak, roltype en contactadres) (tbomgvercontactennn.dvzgwuuid of tbovcontactennn.dvzgwuuid). | ||
| + | |||
| + | <adm example Voorbeeld response body> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||