Skip to content

ZEDAL SOAP Webservice: Explicit acknowledgement of Transport Document reception via AcknowledgeTransportDocument() / PeekNextAcknowledgableTransportDocument()

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

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

Description

Usually, deliveries done internally by ZEDAL systems (without transmission via ZKS, for example) do not need to be acknowledged by the recipient, because the replication process guarantees a successful transmission. Sometimes, there may be an additional need to communicate the results of a content-based validation after reception, though. This may be addressed by the usage of AcknowledgeTransportDocuments().

Acknowledgement may happen directly while reading newly received documents by e.g. looping over PeekNextTransportDocument() and using the ids output by this call. Alternatively, it may happen as a seperate step afterwards. To find the next delivery yet to be acknowledged, PeekNextAcknowledgableTransportDocument() is available.

Note

For the described functionality to work, the receiving ZEDAL subscriber has to opt-in to its usage. Please email erp-tools@zedal.de for inquiries. There are no additional requirements for the sending ZEDAL subscriber.

Attention

When a subscriber has opted in for the explicit acknowledgement, all transport documents received by ZEDAL internal delivery have to be explicitly acknowledged. Otherwise, the sender will never see a sucessful transmission.

Only transport documents delivered internally by ZEDAL may be acknowledged using the described functionality. It is not available for file-contained documents, neither for documents received in the inbox (e.g. via ZKS).

Identification of the delivery (<docid>, <logid>):

A single delivery to be acknowledged is identified by the individual combination of document and log ids. Both values are output by PeekNextAcknowledgableTransportDocument(), as well as e.g. PeekNextTransportDocument(), and are mandatory to include in the query.

Possible results (<result>):

The result of the validation is mandatory and may either be positive or negative.

Optional: Human-readable message (<message>):

May contain a message to be shown to the sender (up to 1.000 characters). Can be queried via GetDeliveryDetails().