API - Get Document

Use a docid to get or download a file / bestand downloaden of ophalen


Resource:
/acumulus/stable/documents/document_get.php
Since API:
Available for authenticated: (Limited)
API invoerder
Available for authenticated:
API gebruiker
Available for authenticated:
API beheerder
Communication:
Basic submit, including below structure


Submit

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    ...
    <docid></docid>
    <docasbase64></docasbase64>
</myxml>

docid Mandatory
Unique identifier for the registered Acumulus document. The docid can be retrieved as part of the response from Get Entry Details.


Please note that depending on the role used in authentication the response may be limited to documents which are marked as internally shared only.

docasbase64 (optional)

Description
0
Direct download (default)
1
XML-response including document embedded in base64 encoded format

Response

There is no XML-Structure in response, but a direct file download when docasbase64 is not set or when there are no errors to be reported. Upon success the document file served over https protocol.


When docasbase64 is set to 1 below response structure will apply:
<?xml version="1.0" encoding="UTF-8"?>
    <response>
        <document>
            <docid></docid>
            <docfilename></docfilename>
            <docbase64></docbase64>
        </document>
    </response>
Please note that base64 encoded documents provide some data overhead.