Koppelprofiel Zaaksysteem API: verschil tussen versies

Uit ZaaksysteemWiki
Ga naar: navigatie, zoeken
Regel 1: Regel 1:
 
__TOC__
 
__TOC__
Met deze koppeling kunnen
+
Met deze koppeling kan een externe partij gegevens uit het zaaksysteem uitlezen en/of het zaaksysteem berichten aan een externe partij sturen.
  
 
= Instellingen =
 
= Instellingen =
Regel 15: Regel 15:
 
|-
 
|-
 
|Medewerker
 
|Medewerker
|De gebruiker namens wie de acties uitgevoerd worden. Bijvoorbeeld bij het wijzigen van een waarde binnen een zaak.
+
|De externe partij heeft hetzelfde toegangsniveau als de geselecteerde gebruiker: Zaken raadplegen en wijzigingen aan zaken aanbrengen. Eventuele wijzigingen die de externe partij binnen zaaksysteem uitvoert zullen namens deze gebruiker gedaan worden.
 
 
Let op: Deze gebruiker moet voldoende rechten hebben om de acties uit te kunnen voeren.
 
 
|-
 
|-
 
|Toegangsniveau
 
|Toegangsniveau
Regel 24: Regel 22:
 
<li>Raadplegen: De externe partij mag gegevens uitlezen</li>
 
<li>Raadplegen: De externe partij mag gegevens uitlezen</li>
 
<li>Behandelen: De externe partij mag gegevens uitlezen en wijzigingen uitvoeren</li>
 
<li>Behandelen: De externe partij mag gegevens uitlezen en wijzigingen uitvoeren</li>
</lu>
+
</ul>
 
|-
 
|-
 
|Zoekopdracht
 
|Zoekopdracht
 
|Standaard verschaft de API toegang tot de volgende metainformatie van een zaak:
 
|Standaard verschaft de API toegang tot de volgende metainformatie van een zaak:
 +
{|
 +
|-
 +
|case.number
 +
|Zaaknummer
 +
|-
 +
|case.status
 +
|Zaakstatus
 +
|-
 +
|case.subject_external
 +
|Extra informatie PIP
 +
|-
 +
|case.phase
 +
|Zaakfase
 +
|-
 +
|case.result
 +
|Zaakresultaat
 +
|-
 +
|case.date_of_registration
 +
|Registratiedatum
 +
|-
 +
|case.date_target
 +
|Streefafhandeldatum
 +
|}
  
 
Deze informatieset wordt uitgebreid met alle informatie die zichtbaar is binnen de geselecteerde zoekopdracht (dus op basis van de geselecteerde filters en kolommen).
 
Deze informatieset wordt uitgebreid met alle informatie die zichtbaar is binnen de geselecteerde zoekopdracht (dus op basis van de geselecteerde filters en kolommen).
 
|-
 
|-
 
|Trigger URL
 
|Trigger URL
|
+
|De URL waar de externe partij berichtgeving van zaaksysteem op moet ontvangen. Zie ook: [http://wiki.zaaksysteem.nl/Zaaktypebeheer_Regels#Zaaksysteem_API:_Api-Zaken Regel - Extern systeembericht]
 +
 
 +
Let op: Dit moet een https:// zijn.
 
|-
 
|-
 
|Trigger CA Certificaat
 
|Trigger CA Certificaat
|
+
|Eventueel het certificaat voor de trigger URL
 
|-
 
|-
 
|API URI
 
|API URI
 
|
 
|
 
|}
 
|}

Versie van 8 mei 2015 om 09:24

Met deze koppeling kan een externe partij gegevens uit het zaaksysteem uitlezen en/of het zaaksysteem berichten aan een externe partij sturen.

Instellingen

Titel Omschrijving
Versie De versie van dit koppelprofiel
API sleutel De unieke API sleutel waarmee de externe partij kan authenticeren
Medewerker De externe partij heeft hetzelfde toegangsniveau als de geselecteerde gebruiker: Zaken raadplegen en wijzigingen aan zaken aanbrengen. Eventuele wijzigingen die de externe partij binnen zaaksysteem uitvoert zullen namens deze gebruiker gedaan worden.
Toegangsniveau Het toegangsniveau dat deze API verschaft:
  • Raadplegen: De externe partij mag gegevens uitlezen
  • Behandelen: De externe partij mag gegevens uitlezen en wijzigingen uitvoeren
Zoekopdracht Standaard verschaft de API toegang tot de volgende metainformatie van een zaak:
case.number Zaaknummer
case.status Zaakstatus
case.subject_external Extra informatie PIP
case.phase Zaakfase
case.result Zaakresultaat
case.date_of_registration Registratiedatum
case.date_target Streefafhandeldatum

Deze informatieset wordt uitgebreid met alle informatie die zichtbaar is binnen de geselecteerde zoekopdracht (dus op basis van de geselecteerde filters en kolommen).

Trigger URL De URL waar de externe partij berichtgeving van zaaksysteem op moet ontvangen. Zie ook: Regel - Extern systeembericht

Let op: Dit moet een https:// zijn.

Trigger CA Certificaat Eventueel het certificaat voor de trigger URL
API URI