Hoe werkt API0028 raadpleegverzoek documentHow does API0028, a document consultation request, work?
Voor het raadpleegverzoek API0028 wordt de XML samengesteld zoals hieronder wordt getoond.
For the API0028 consultation request, the XML is composed as shown below.
De volgende optionele opties zijn beschikbaar:
The following optional settings are available:
moz_inddocdownloadlink (J/N) | 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.if this option is set to J AND the document is on external S3 storage, a temporary download URL is offered in the response with the tag moz_externe_url instead of the base64. If it is absent or set to N, the BASE64 variant is shown in the koppelverzoek's response. |
moz_indorigineelformaat (J/N) | 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).if this option is set to J, the document is delivered in its original format. If it is absent or set to N, the document is delivered in converted PDF format (if present). |
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.
It is also possible to change the download link's validity period through moz_geldigheiddownloadlink. The maximum value for AWS is 604800. That is 7 days.
XMLXML
<?xml version="1.0" encoding="UTF-8"?>
<moz_koppelverzoek>
<moz_generiek>
<moz_koppelverzoekreferentie><![CDATA[Document]]></moz_koppelverzoekreferentie>
<moz_koppelverzoekxxb>JOUW_HASHCODE</moz_koppelverzoekxxb>
<moz_koppelverzoekxxc>1</moz_koppelverzoekxxc>
<moz_koppelverzoekxxd>20220908JVD007</moz_koppelverzoekxxd>
<moz_koppelverzoekxxe>JOUW_BEREKENDE_SHA1</moz_koppelverzoekxxe>
<moz_koppelverzoektype>28</moz_koppelverzoektype>
</moz_generiek>
<moz_sleutel>
<moz_dd_volgnr>123456</moz_dd_volgnr>
<moz_inddocdownloadlink>J</moz_inddocdownloadlink>
</moz_sleutel>
</moz_koppelverzoek>
moz_koppelverzoekxxb en moz_koppelverzoekxxe zijn inloggegevens van de koppelinfrastructuur; in het voorbeeld hierboven staan JOUW_HASHCODE en JOUW_BEREKENDE_SHA1 op hun plaats. Zie Hoe configureer ik een koppelinfrastructuur? voor het berekenen van je eigen xxe.
moz_koppelverzoekxxb and moz_koppelverzoekxxe are credentials of the koppelinfrastructuur; in the example above, JOUW_HASHCODE and JOUW_BEREKENDE_SHA1 stand in their place. See Hoe configureer ik een koppelinfrastructuur? for calculating your own xxe.