|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EhealthBoxServiceV2
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)
EhealthBoxServiceV2Impl
Factory : ServiceFactory
Method Summary | |
---|---|
DeleteMessageResponse |
deleteMessage(DeleteMessageRequest request)
|
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(MessageRequestType request)
Retrieves the entire message from the eHealth Box based on its unique identifier. |
GetMessageAcknowledgmentsStatusResponse |
getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request)
Gets the acknowlegment status. |
GetHistoryResponse |
getMessageHistory(MessageRequestType request)
With the 'Get History' operation, a messages history can be consulted. |
GetMessageListResponseType |
getMessageList(GetMessagesListRequest request)
The �Get message List� operation retrieves the list of messages in one of the available folders (inbox, bin or sent). |
ResponseType |
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. |
Method Detail |
---|
SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
The �Send Message� operation allows a message to be sent to one or more recipients. The sender has to be option to:
sendMessageRequest
-
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
GetBoxInfoResponse getBoxInfo(GetBoxInfoRequest getBoxInfoRequest) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
To retrieve general information relation to the eHealth Box of the General Practitioner: number of messages, total size of all available messages, etc.).
getBoxInfoRequest
-
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
GetMessageListResponseType getMessageList(GetMessagesListRequest request) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
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).
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
GetFullMessageResponse getFullMessage(MessageRequestType request) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
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.
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
ResponseType moveMessage(MoveMessageRequest request) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
Moves a message back to the inbox. The unique message identifier must be provided as input parameter.
request
- The message id.
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
GetHistoryResponse getMessageHistory(MessageRequestType request) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
With the 'Get History' operation, a messages history can be consulted.
request
- The message id.
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
GetMessageAcknowledgmentsStatusResponse getMessageAcknowledgmentsStatusRequest(GetMessageAcknowledgmentsStatusRequest request) throws TechnicalConnectorException, EhboxBusinessConnectorException, SessionManagementException
Gets the acknowlegment status.
request
- the message id.
TechnicalConnectorException
- the technical connector exception
EhboxBusinessConnectorException
- the business connector exception
SessionManagementException
DeleteMessageResponse deleteMessage(DeleteMessageRequest request) throws SessionManagementException, TechnicalConnectorException, EhboxBusinessConnectorException
SessionManagementException
TechnicalConnectorException
EhboxBusinessConnectorException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |