Function: changeContainer

Informing the message exchange platform on the status of a container with regard to the processing outcome.

Usage

This function offers the sender of a container the option to request a change of the status of the container. The content itself cannot be changed.
A change of status is used to adjust the container status on the message exchange platform according to the outcome of the processing of the container by the client. The table below shows the available variants.

# Variant Description
1 retract A client action to withdraw a previously submitted container from the platform.
2 confirm Client notification of successful processing of a previously requested container.
3 cancel Client notification of unsuccessful processing of a previously requested container.

Retract

If a party submits a container and for some reason discovers the content not to be correct, the retractContainer function may be used by the party that submitted the container to correct the content. If the messages from the container have not been distributed and not yet retrieved by the receivers, a full retraction is possible.
A different procedure applies if the message exchange platform provider has already processed the content of the container by distributing it to the PO boxes of the receivers. The receiver(s) may in turn already have collected their message(s). In this case a full retraction is no longer possible for the messages concerned. Instead, a copy of the meta-data from these messages will be attached to the response of the retracting request. This informs the sender of the container that not all messages from the container could be retracted, and enables the sender of the container to take appropriate action.

Confirm

Once a requested container is received, the client will extract the messages in order to process them. Once the container has been processed successfully, the confirm variant is used to notify the message exchange platform that the process is complete. This allows the message exchange platform to release the individual messages that were delivered in the container and/or change their individual status.

Cancel

When the client has extracted the messages from the container, and the processing fails for some reason, the cancel variant is used to inform the message exchange platform that the content of the requested container has not been processed successfully. This allows the message exchange platform to release the individual messages that were delivered in the container and/or change their individual status.
Once the requested container is cancelled and the cause of failure has been established and corrected, a new request can be sent in order to retry the operation. This is the only way to deal with a container that could not be processed properly. It is not possible to change the content of the container in order to fix any problems and retrieve the same container a second time.

Technical specifications: changeContainer

Input: changeContainer

The changeContainer function uses the base-url and endpoint to address a specific cpntainer, the unique container identification makes up the last part of the endpoint.
The request body section is used to provide a new value for the containerStatus attribute. This is the only attribute to be changed on a container, the content cannot be changed.

Name Variant Type Description
containerStructure Collection of individual messages, transported to or from a message exchange platform (MEP)
commonTechnical General entity for process/handling support.
entityType all string Set to ‘default’.
containerId all string The unique registration/identification of the container on a message exchange platform.
mepId all string The unique registration/identification issued by SIVI, to identify a message exchange platform (MEP).
containerStatus all APICST Indication of the new status (input) or present status (output) of the container.
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.

Output: changeContainer

Name Variant Type Description
containerStructure Collection of individual messages, transported to or from a message exchange platform (MEP)
commonTechnical General entity for process/handling support.
entityType all string Set to ‘default’.
containerId all string The unique registration/identification of the container on a message exchange platform.
mepId all string The unique registration/identification issued by SIVI, to identify a message exchange platform (MEP).
containerStatus all APICST Indication of the new status (input) or present status (output) of the container.
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
error Entity for error handling and support.
entityType 1..1 string Set to ‘default’.
errorCode all AFDERR Error code.
errorDescription all string Descriptions of the error.
messageStructure A copy of the meta-data from a message in a container which could not be distributed or retracted.

Errors

When a negative response is generated, it follows the general rules as described in the Error section of the Status codes and error handling chapter.

Click below to see the Open Api Specification (3.0.0)

Under construction.

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment