Koppelprofiel StUF-ZKN

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken

Algemeen

LET OP: Sinds 2020 willen we het StUF-ZKN koppelprofiel niet meer gebruiken. Dit wordt nog wel ondersteund voor 'oude' klanten. Alle nieuwe aansluitingen gaan via de API met Koppel.app (of desgewenst een andere partij). Neem bij onduidelijkheden contact op met de Product Owner van Zaaksysteem.nl.

De StUF-ZKN koppeling stelt andere systemen instaat om wijzigen op zaken aan te brengen. Zie ook het koppelprofiel StUF-ZKN Client voor het versturen van berichten aan andere applicaties.

De volgende acties worden ondersteund:

  • Genereer zaakidentificatie
  • Creëer zaak
  • Actualiseer zaakstatus
  • Update zaak
  • Geef zaakdetails, geef lijst zaakdocumenten
  • Geef zaakdocumenten lezen
  • Genereer documentidentificatie
  • Voeg zaakdocument toe

Instellingen

Instelling Omschrijving
Gemeentecode Moet gelijk zijn aan de instelling 'Gemeentecode' in StUF configuratie
Registreren van nieuwe zaken accepteren Staat de actie 'Creëer zaak' toe
Afronden fase accepteren Staat de actie 'Actualiseer zaakstatus' toe
Certificaat (public key) Het certificaat van de software die de SOAP-interface van deze koppeling zal aanroepen
Zaaktypes De zaaktypen die gebruikt worden voor het registreren van zaken*
Endpoint URL https://unconfigured.services.zaaksysteem.nl/sysin/interface/<interface_id>/soap
Simulatietool https://<omgeving>/stuf-zkn/simulator

* Zorg dat de geselecteerde zaaktypen een unieke waarde in het veld 'identificatie' hebben. Deze identificatiecode wordt door StUF-ZKN gebruikt om het zaaktype te selecteren

Acties

Genereer zaakidentificatie

De actie 'genereer zaakidentifciatie' reserveert een zaaknummer dat gebruikt kan worden om een zaak aan te maken.

Creëer zaak

De actie 'Creëer zaak' maakt een zaak aan met het gereserveerde zaaknummer.

Actualiseer zaakstatus

De actie 'Actualiseer zaakstatus' verhoogt de fase van een bestaande zaak.

Update zaak

De actie 'Update zaak' kan gebruikt worden om waarden in een bestaande zaak te wijzgen of toe te voegen.

Geef zaakdetails, geef lijst zaakdocumenten

De actie 'Geef zaakdetails, geef lijst zaakdocumenten' geeft een antwoordbericht dat de details van een bestaande zaak en een lijst met zaakdocumenten bevat.

Geef zaakdocumenten lezen

De actie 'Geef zaakdocumenten lezen' download een document uit een bestaande zaak.

Genereer documentidentificatie

De actie 'Genereer documentidentificatie' reserveert een documentidentificatienummr dat gebruikt kan worden om een document toe te voegen aan een bestaande zaak.

Voeg zaakdocument toe

De actie 'Voeg zaakdocument toe' plaatst één of meerdere documenten aan de documentenwachtrij van een zaak toe.