Function: retrieveContainer

The retrieveContainerfunction can be used by message exchange platform clients to retrieve messages from their PO box.

Usage: retrieveContainer

The following variants are available for the retrieveContainer function:

# Variant Description
1 list Client demand to the platform to obtain a list of all active containers.
2 request Client demand to the platform to create and send a container based on a query.

List

This variant provides an overview of all active containers which are linked to the client. Query and authentication information is passed on in the header parameters of the request.
The autorization will limit access from an ‘all messages’ request (no query) to the messages that the requesting client is entitled to. The query to request ‘all’ messages from the message exchange platform does not contain a “receiverId=…” statement. This is implicitly arranged by the authorization setup which confines any interaction with the message exchange platform to the collection of messages that belongs to the identified user of the message exchange platform.

When there are no containers available that comply with the query (request), or none at all (list) the return will be ’204 No Content’, and not an empty container or a ’404 Not Found’ error.

To get an overview of all active messages which are linked to the client, the variant list of retrieveMessage can be used.

Request

The request variant specifies which messages are required by the client by means of a query. The message exchange platform processes the request, puts the result in a container and adds it to the response.
The containerStatus will be set to ‘Delivered’ and will stay that way until the receiver confirms that the container has been processed, either successfully or without success.
In case of a requested, outgoing container, the senderId on container level is not used, the sender of the container is always the message exchange platform provider.
The messages in the container will all have the same receiver (the party that made the request) and different senders.

Technical specifications: retrieveContainer

Input: retrieveContainer

The request of a container consists of the HTTP GET command, with optional query parameters to determine the content;

Name Variant Type Description
containerId 2 array The unique registration/identification of the container on a message exchange platform.
messageSubject all string Topic of the message.
messageContext all APICON Type of request – See also the explanation in the ‘properties’ section of the message structure.
messageFunction all APIFUN Type of process – See also the explanation in the ‘properties’ section of the message structure.

Parameters may be used individually, or in combination.

Output: retrieveContainer

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).
receiverId string The unique identification on the message exchange platform of the party that receives a container from the platform.
containerStatus all APICST Indication of the new status (input) or present status (output) of the container.
dateTime all date Date and time of the creation 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.
messageStructure 2 A set of messages sent in a container (see message structure for details)

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