public interface EhealthBoxServiceV3
The Business Connector for General Practitioners provides a simplified interface to access the eHealth Box by providing the following functionality:
Pre-Requisites:
An active and valid eHealth-platform session (initiated via the Session Management component)
EhealthBoxServiceV3Impl
Modifier and Type | Method and Description |
---|---|
DeleteMessageResponse |
deleteMessage(DeleteMessageRequest request)
delete specific message.
|
DeleteOoOResponse |
deleteOoO(DeleteOoORequest request)
delete specific OoO périod.
|
GetAllEhboxesMessagesListResponse |
getAllEhboxesMessagesList(GetAllEhboxesMessagesListRequest request)
retrieves all messages from all mailboxes for user.
|
GetBoxInfoResponse |
getBoxInfo(GetBoxInfoRequest getBoxInfoRequest)
To retrieve general information relation to the eHealth Box of the General Practitioner: number of messages, total size of all
available messages, etc.).
|
GetFullMessageResponse |
getFullMessage(GetFullMessageRequest request)
Retrieves the entire message from the eHealth Box based on its unique identifier.
|
GetFullMessageResponse |
getFullMessage(MessageRequestType request)
Deprecated.
|
GetMessageAcknowledgmentsStatusResponse |
getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request)
Gets the acknowlegment status.
|
GetHistoryResponse |
getMessageHistory(GetHistoryRequest request)
With the 'Get History' operation, a messages history can be consulted.
|
GetHistoryResponse |
getMessageHistory(MessageRequestType request)
Deprecated.
|
GetMessagesListResponse |
getMessageList(GetMessagesListRequest request)
The �Get message List� operation retrieves the list of messages in one of the available folders (inbox, bin or sent).
|
GetOoOListResponse |
getOoOList(GetOoOListRequest request)
get list of periods of OoO for specific user.
|
InsertOoOResponse |
insertOoO(InsertOoORequest request)
insert Out Of Office period.
|
MoveMessageResponse |
moveMessage(MoveMessageRequest request)
Moves a message back to the inbox.
|
SendMessageResponse |
sendMessage(SendMessageRequest sendMessageRequest)
The �Send Message� operation allows a message to be sent to one or more recipients.
|
SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws ConnectorException
The �Send Message� operation allows a message to be sent to one or more recipients. The sender has to be option to:
sendMessageRequest
- ConnectorException
GetBoxInfoResponse getBoxInfo(GetBoxInfoRequest getBoxInfoRequest) throws ConnectorException
To retrieve general information relation to the eHealth Box of the General Practitioner: number of messages, total size of all available messages, etc.).
getBoxInfoRequest
- ConnectorException
GetMessagesListResponse getMessageList(GetMessagesListRequest request) throws ConnectorException
The �Get message List� operation retrieves the list of messages in one of the available folders (inbox, bin or sent). The result contains a list of available messages, but only with partial information. To retrieve the entire message contents, the 'Get Full Message' operation must be invoked.
request
- Indicates the folder for which the list of messages is returned (inbox, bin, sent).ConnectorException
@Deprecated GetFullMessageResponse getFullMessage(MessageRequestType request) throws ConnectorException
Retrieves the entire message from the eHealth Box based on its unique identifier. Typically, first a list of new messages is retrieved via the 'Get Message List' operation and afterwards the individual message is claimed via this operation.
request
- The message id.ConnectorException
GetFullMessageResponse getFullMessage(GetFullMessageRequest request) throws ConnectorException
Retrieves the entire message from the eHealth Box based on its unique identifier. Typically, first a list of new messages is retrieved via the 'Get Message List' operation and afterwards the individual message is claimed via this operation.
request
- The message id.ConnectorException
MoveMessageResponse moveMessage(MoveMessageRequest request) throws ConnectorException
Moves a message back to the inbox. The unique message identifier must be provided as input parameter.
request
- The message id.ConnectorException
@Deprecated GetHistoryResponse getMessageHistory(MessageRequestType request) throws ConnectorException
With the 'Get History' operation, a messages history can be consulted.
request
- The message id.ConnectorException
GetHistoryResponse getMessageHistory(GetHistoryRequest request) throws ConnectorException
With the 'Get History' operation, a messages history can be consulted.
request
- The message id.ConnectorException
GetMessageAcknowledgmentsStatusResponse getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request) throws ConnectorException
Gets the acknowlegment status.
request
- the message id.ConnectorException
DeleteMessageResponse deleteMessage(DeleteMessageRequest request) throws ConnectorException
delete specific message.
request
- the message idConnectorException
InsertOoOResponse insertOoO(InsertOoORequest request) throws ConnectorException
insert Out Of Office period.
request
- user and period of OoOConnectorException
GetOoOListResponse getOoOList(GetOoOListRequest request) throws ConnectorException
get list of periods of OoO for specific user.
request
- user idConnectorException
DeleteOoOResponse deleteOoO(DeleteOoORequest request) throws ConnectorException
delete specific OoO périod.
request
- period OoO idConnectorException
GetAllEhboxesMessagesListResponse getAllEhboxesMessagesList(GetAllEhboxesMessagesListRequest request) throws ConnectorException
request
- TechnicalConnectorException
EhboxBusinessConnectorException
SessionManagementException
ConnectorException
Connector Packaging PERSPHYSICIAN 4.5.4 API
Copyright © {inceptionYear}-2024 eHealth. All Rights Reserved.