General properties

Data can be exchanged in a synchronous or asynchronous manner, depending on specific processes and circumstances. The most common methods for asynchronous exchange are via File Transfer Protocol and message exchange platforms (MEP), often used in bulk processes. In order to avoid overhead when transporting individual messages, the container structure offers the possibility to transport a set of messages.

Mandatory components

The main structure of a container is made up of the following elements:

  1. commonTechnical; among others the identification of the message exchange platform provider, the sender of the container, date and time of creation. The commonTechnical is always mandatory within a message structure.
  2. commonFunctional; a set of fields that can be used for the routing and handling/workflow of the container without the need to consult the content.
  3. message; the collection of messages of a container. This is a temporary assembly of messages which only exist for logistical purposes, and by itself has no business meaning. Once the individual messages are processed, the container notion which was used to fetch or deliver them becomes obsolete.

The table below contains the mandatory entities and attributes of the container. Please note: these are only the mandatory components. For specific details of the message structure, reference is made to the chapter on the message structure. See below in this section for a more detailed example.

Name Occur. Type Description
container 1..1 entity Collection of individual messages, transported to or from a message exchange platform (MEP).
commonTechnical 1..1 entity Covers all information about sending or storing the message.
entityType 1..1 string Set to ‘default’.
containerId 1..1 string Unique registration of the container on the Message Exchange Platform.
mepId 0..1 string The unique registration/identification issued by SIVI, to identify a message exchange platform (MEP). Only required for MEP environments.
senderId 1..1 string Technical reference to the sender of the message.
containerStatus 1..1 APICST Indication of the new status (input) or present status (output) of the container.
creationDate 1..1 date Creation date of the (for example) message, system or file.
creationTime 1..1 time Creation time of the (for example) message, system or file.
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
functionVariant all string The function variant is used to determine the additional set of required and optional input and output data.
message 1..* entity An array of messages (as message structures) sent in a container (see message for details).

JSON example

Below is an example of a container, including an example message. Note that at the top level within JSON, the container entity is not explicitly mentioned. When the container is nested within other structures, the container is given an explicit tag. In XML, the structure is always explicitly defined at the highest level as well.

{
	"commonTechnical": [ {
		"entityType": "default",
		"containerId": "c4eef3a3-8f6d-440b-8b34-8b785fa1301f",
		"mepId": "MEP2020",
		"senderId": "I095678905678901",
		"recipientId": "A610895101792",
		"containerStatus": "Submitted",
		"creationDate": "2020-01-01",
		"creationTime": "08:00:00",
		"hashType": "04",
		"hash": "12345678"
	} ],
       "commonFunctional": [ {
		"entityType": "default",
		"functionVariant": "CoSu01",
	} ],
	"message": [ {
		"commonTechnical": [ {
			"entityType": "default",
			"messageId": "c4eef3a3-8f6d-440b-8b34-8b785fa1301f",
			"mepId": "MEP2020",
			"senderAliasType": "poBox",
			"senderId": "I095678905678901",
			"receiverAliasType": "poBox",
			"receiverId": "I095678905678901",
			"creationDate": "2020-01-01",
			"creationTime": "08:00:00"
		} ],
		"commonFunctional": [ {
			"entityType": "default",
                      "dataCatalogVersion": "35C",
                      "dataCatalogType": "AFD",
                      "messageSubject": "autoverzekering",
                      "messageContext": "200",
                      "messageFunction": "2000"
		} ],
		"document": [ {
			"entityType": "default",
			"contentEncoding": "base64",
			"contentType": "text/xml; charset=cp858",
			"fileName": "afd001.xml",
			"fileExtension": "xml",
			"content": "VGhpcyBpcyBhIGJhc2U2NCBlbmNvZGVkIGV4YW1wbGUg"
		} ]
	} ]
}

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment