Bestätigung des erfolgten Abrufes eines Bündels von Dokumenten für gemeinsame Verarbeitung per ScanPDF

Über idCase wird das Dokumentenbündel referenziert.

Für die gemeinsame Verarbeitung mehrerer Dokumente per ScanPDF müssen die Dokumente wie gewohnt per Schnittstelle angeliefert werden. Zusätzlich zu den üblichen Daten wird auch bei den Dokumenten "idCase" angegeben, um die Dokumente dem Bündel zuzuweisen. Nach erfolgter Zuweisung aller Dateien muss das Bündel abgeschlossen werden, damit es verarbeitet werden kann. Zusätzlich zur externen Referenz "idCase" liefert die Schnittstelle auch die interne ID des Vorgangs "idBundle" zurück. Diese ID wird nur zum Zwecke der Nachverfolgbarkeit geliefert und wird nicht als Referenz von außen benötigt.

Diese Aktion bestätigt den erfolgreichen Abruf der Daten des Vorganges und verschiebt die gebündelten Dateien in den Papierkorb. Der bereits bestätigte Vorgang kann im Nachgang noch abgerufen werden, solange die Dateien im Papierkorb liegen. Dateien im Papierkorb werden nach 4 Wochen automatisch gelöscht.

Folgender Parameter muss übergeben werden:

• idCase - die externe ID des Vorganges, welche als Referenz bei allen diesbezüglichen Aktionen verwendet wird.

Request (PHP-Beispiel):

$UpdateParams = array (
    "dataUser" => array (
        'token' => '****************',
    ),
    "content"  => array (
        'pdf' => array (
            'acknowledgeBundle' => array (
                array (
                    'idCase' => 'Vorgang_14915',
                ),
            ),
        ),
    )
);

Request (JSON-Beispiel):

{
    "dataUser": {
        "token": "****************"
    },
    "content": {
        "pdf": {
            "acknowledgeBundle": [{
                "idCase": "Vorgang_14915"
            }]
        }
    }
}

Response (PHP-Beispiel):

array (
  'response' =>
  array (
    'pdf' =>
    array (
      'acknowledgeBundle' => 
      array (
        0 => 
        array (
          'idCase' => 'Vorgang_14915',
          'idBundle' => 18,
          'filesMovedToTrash' => array (
            '20191',
            '20192'
          ),
        ),
      ),
    ),
  ),
)

Response (JSON-Beispiel):

{
    "response": {
        "pdf": {
            "acknowledgeBundle": [{
                "idCase": "Vorgang_14915",
                "idBundle": 18,
                "isAcknowledged": true,
                "filesMovedToTrash": ["20191", "20192"]
            }]
        }
    }
}