The operation new in case of a message will transmit an electronic message to a party (peer to peer) directly without the need of an intermediary service.

How to use variants

If you want to transmit a new message, choose the operation new. Only one variant is applicable for new message (the variant default).

A positive response to the operation new contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.


The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

Variant Description message
<default> Transmit a new message Yes

<default> – Transmit a new message

The variant default transmits a new message and the messagestructure is used. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition
Method Endpoint Request Query
Response Remarks
POST { uri } /messages/new messageStructure N/A messageStructure

Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks
commonFunctional dataCatalogVersion I Version of the data catalog on which the message is based.
commonFunctional functionVariant I The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional afdDefinitionName I Name of the AFD-definition.
commonFunctional afdDefinitionVersion I Version of the AFD-definition.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.


Thanks for your feedback.

Post your comment on this topic.

Post Comment