Zum Inhalt

ZEDAL-SOAP-Webservice: Ausdrückliche Empfangsbestätigung von Transportdokumenten über AcknowledgeTransportDocument() / PeekNextAcknowledgableTransportDocument()

<AcknowledgeTransportDocument>
    <sessionid>...</sessionid>
    <docid>...</docid>
    <logid>...</logid>
    <result>...</result>
    <!-- Optional: -->
    <message>...</message>
</AcknowledgeTransportDocument>

<PeekNextAcknowledgableTransportDocument>
    <sessionid>...</sessionid>
</PeekNextAcknowledgableTransportDocument>

Beschreibung

Zustellungen, die ZEDAL intern abwickelt (also zum Beispiel ohne Übermittlung über die ZKS), muss der Empfänger in der Regel nicht bestätigen, weil ZEDAL die Zustellung selbst sicherstellt. Manchmal soll nach dem Empfang aber zusätzlich das Ergebnis einer inhaltlichen Prüfung zurückgemeldet werden. Dafür gibt es AcknowledgeTransportDocument().

Die Bestätigung kann direkt beim Lesen neu eingegangener Dokumente erfolgen, etwa in einer Schleife über PeekNextTransportDocument() mit den Kennungen, die dieser Aufruf liefert. Sie kann aber auch in einem eigenen Schritt danach erfolgen. Die nächste noch zu bestätigende Zustellung liefert PeekNextAcknowledgableTransportDocument().

Hinweis

Damit die beschriebene Funktion greift, muss der empfangende ZEDAL-Subscriber ihre Nutzung ausdrücklich aktivieren lassen. Anfragen bitte per E-Mail an erp-tools@zedal.de. Für den sendenden ZEDAL-Subscriber gibt es keine zusätzlichen Voraussetzungen.

Achtung

Hat ein Subscriber die ausdrückliche Bestätigung aktiviert, müssen alle Transportdokumente, die ihm ZEDAL intern zustellt, ausdrücklich bestätigt werden. Sonst sieht der Absender nie eine erfolgreiche Übertragung.

Bestätigen lassen sich nur Transportdokumente, die ZEDAL intern zugestellt hat. Für Dokumente in Akten und für Dokumente, die in der Inbox eingehen (z. B. über die ZKS), gibt es die Funktion nicht.

Kennzeichnung der Zustellung (<docid>, <logid>):

Eine einzelne zu bestätigende Zustellung wird durch die Kombination aus Dokument- und Log-Kennung bestimmt. Beide Werte liefern PeekNextAcknowledgableTransportDocument() und zum Beispiel auch PeekNextTransportDocument(); beide sind Pflichtangaben in der Anfrage.

Mögliche Ergebnisse (<result>):

Das Ergebnis der Prüfung ist Pflicht und lautet entweder positive oder negative.

Optional: Lesbare Nachricht (<message>):

Kann eine Nachricht an den Absender enthalten (bis zu 1.000 Zeichen). Abfragbar über GetDeliveryDetails().