Specifications

Specifications about  retrieving messages from EUCARIS, as well as other general EUCARIS v8 specifications, can be downloaded here (credentials required).

The MessageRetrievalService described on this page, is specified in detail in EUCARIS 8.0 Core UC-02 Retrieve Message to EUCARIS.

Scope

The MessageRetrievalService is part of the EUCARIS v8 architecture, so it is not used in services implemented in the v7 architecture.

In message processing, EUCARIS marks messages as retrievable if there is a requirement that messages can be retrieved from outside EUCARIS. By default, messages processed within EUCARIS, are not retrievable. The EUCARIS MessageRetrievalService offers an interface to client applications and legacy services to browse for and retrieve messages.

Authentication and authorisation

In the MessageRetrievalService, no authentication or authorisation is implemented. This means that access control to the service has to be implemented in the national domain, e.g. by applying authentication and authorisation at or before the access point to the EUCARIS platform.

Methods

The MessageRetrievalService offers two methods:

  1. Index – Browse for available workflows and messages
  2. Retrieve – Retrieve workflow messages by providing a workflow identifier, or retrieve one specific message by providing a message identifier

Method Index

This method is used to retrieve a list of workflows, for browsing. This method can be used prior to using the method Retrieve.

Any subset of the following search criteria can be given as input:

  • A workflow identification (ExternalWorkflowId), to retrieve the info of one specific workflow
  • Initiating Member State, to retrieve workflows initiated by a specific Member State
  • Initiator of a workflow (SenderName), to retrieve workflow initiated by a specific person
  • A reacting Member State, to retrieve workflows to which a specific Member State reacted
  • The name of a MessageService, to retrieve workflows executing a specific service
  • A timeframe, to retrieve workflows initiated within a specific timeframe
  • Indication ‘not retrieved’, to retrieve workflows not retrieved before.

The list returned consist of workflow info, and metadata of the retrievable messages within the workflow. Via the method Index, no content is returned.

Method Retrieve

This method is used to either retrieve all retrievable messages of a workflow, or to retrieve one specific message.

To retrieve all retrievable messages of a workflow, a workflow identifier is provided (ExternalWorkflowId or WorkflowId). To retrieve one specific message, besides a workflow identifier, also a message identifier is provided (MessageId, ExternalMessageId, ReferencedMessageId or ReferencedExternalMessageId).

In both cases, it is mandatory to provide the UserName of the person responsible for retrieval (in other words: The person who will be seeing the message content retrieved).

The result of retrieval is provided in a response envelope (for more info about the EUCARIS Envelope, visit this page). The activity of retrieval is logged within EUCARIS, including the UserName from the input, so that the logging reflects who retrieved content.