Function: submitMessage

Direct transmission of an electronic message (peer to peer) via an API.

Usage: submitMessage

The function submitMessage can be used for direct data exchange between parties without the need for an intermediary service like a message exchange platform.
Depending on the role in the value chain, a party can be the provider of an API, the user, or both.

Technical specifications: submitMessage

Input: submitMessage

Name Occur. Type Description
message Individual message in direct exchange, or part of a container for a message exchange platform.
commonTechnical Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
senderAliasType all APIALIA Code indicating the category of senderId, can be used for specific check and verification of the senderId.
senderId all string The unique identification on the message exchange platform of the party that submits a container to the platform.
receiverAliasType all APIALIA Code indicating the category of receiverId, can be used for specific check and verification of the receiverId.
receiverId all string The unique identification on the message exchange platform of the party that receives a container from the platform.
creationDate all date Date of the creation of the message.
creationTime all time Time of the creation of the message.
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion all ADNAFM Version of the data catalog on which the message is based.
dataCatalogType all string Type of datacatalog.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
messageSubject string Description of the subject.
messageContext APICON Code indicating the type of context of the message.
messageFunction APIFUN Code indicating the type of function of the message.
document array
partyStructure array
policyStructure array
claimStructure array

Output: submitMessage

There are three basic types of output which are described in the Output section of the Design principles chapter.
For the submitMessage it is not expected that a body section is added to the response, the HTTP status code is enough since it is a ‘fire and forget’ function without change and retrieve functions.

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.

The Open Api Specification (3.0.0)

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment