Function: retrieveMessage

Client request to the platform to obtain a list of all available messages.

Usage: retrieveMessage

The retrieveMessage function is provided by a message exchange platform to enable clients to get an overview of the messages from their PO box.
It will return the meta-data of the messages which meet the criteria of the query, or of all available messages.
The payload from the messages is not included when using retrieveMessage. To obtain the full message, the retrieveContainer with the request variant can be used.

# Variant Description
1 range Client request to the platform to obtain a selection of available messages.
2 list Client request to the platform to obtain a list of all available messages.

The range variant will produce an overview of all messages in the client PO box that meet the query criteria.
The fields of the property object can be used to create a query, either by using them separately, or in any combination. See the Input section for further details.

The list variant will compile a complete list of all messages in the client PO box.

Technical specifications: retrieveMessage

Input: retrieveMessage

The message specific parameters from the commonFunctional entity can be used to create a query to select a specific set of messages. A single parameter can be used, or a combination of parameters. For GRS compatibility only the three standard options listed in the table below are currently supported. Other additional properties can be proposed by the message exchange platform provider.

Name Variant Type Description
messageSubject all string Topic of the message, free input.
messageContext all string Type of request.
messageFunction all string Type of process.

Examples:

…/messages/?messageSubject=autoverzekering (all messages with car insurance as subject)
…/messages/?messageContext=offerte&function=polis aanvragen (all policy applications)
…/messages/?messageSubject=autoverzekering&context=offerte&function=offerte aanvragen (all car insurance offers)

Output: retrieveMessage

Name Variant 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’.
messageId all string The unique identification, provided by the message exchange platform after initial reception of a message.
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 APIDCT 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.

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