Naar hoofdinhoud
Wiki

Hoe werkt API0028 opvragen document

Beheer binnenkomend koppelverzoek (API)

Mozard heeft koppelvlakken om geautomatiseerd gegevens te kunnen uitwisselen met andere toepassingen. Zo is er een koppelvlak om vanuit een pc-toepassing documenten in Mozard te plaatsen of bestaande documenten te bewerken en een nieuwe versie op te slaan. Er is ook een koppelvlak om vanuit een andere toepassing geautomatiseerd acties uit te voeren met betrekking tot zaken of zaakdossiers.

Hoe werkt API0028 raadpleegverzoek document

Voor het raadpleegverzoek API0028 wordt de XML samengesteld zoals huieronder wordt getoond

De volgende optionele opties zijn beschikbaar:

  • moz_inddocdownloadlink (J/N) beschikbaar met de volgende instellingen:
    • indien deze optie op J staat EN het document bevindt zich op externe s3 opslag dan wordt in plaats van de base64 in het antwoord een tijdelijke download url aangeboden met tag moz_externe_url.
    • indien deze ontbreekt of op N staat, dan wordt de BASE64 variant in het antwoord van het koppelverzoek getoond.
  • moz_indorigineelformaat (J/N) beschikbaar met de volgende instellingen:
    • indien deze optie op J staat, wordt het document aangeleverd in het originele formaat.
    • indien deze ontbreekt of op N staat, dan wordt het document aangeleverd in geconverteerd pdf formaat (mits aanwezig)

Het is ook mogelijk om de geldigheidsduur van de downloadlink aan te passen via moz_geldigheiddownloadlink. De max waarde voor aws is 604800. Dat zijn 7 dagen.

XML

<?xml version="1.0" encoding="UTF-8"?>
<moz_koppelverzoek>
<moz_generiek>
<moz_koppelverzoekreferentie><![CDATA[Document]]></moz_koppelverzoekreferentie>
<moz_koppelverzoekxxb>SCHN1S2DYSILMJW5TNFBI7TGF1Q5OM2U9YML09ERS2CI749281G5ZUS8D8TPE</moz_koppelverzoekxxb>
<moz_koppelverzoekxxc>1</moz_koppelverzoekxxc> 
<moz_koppelverzoekxxd>20220908JVD007</moz_koppelverzoekxxd>
<moz_koppelverzoekxxe>f859a515b45b80c7ba2ab1f640a0e97fbab53178</moz_koppelverzoekxxe>
<moz_koppelverzoektype>28</moz_koppelverzoektype>
</moz_generiek>
<moz_sleutel>
<moz_dd_volgnr>123456</moz_dd_volgnr>
<moz_inddocdownloadlink>J</moz_inddocdownloadlink> -- optie moz_inddocdownloadlink 
</moz_sleutel>
</moz_koppelverzoek>