You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 19
Next »
Table of contents
Used documentation
DeleteMessage
The DeleteMessage method enables the user to delete physically and definitely one or more messages from
the inbox, sent box or bin. This can be used to clean up the eHealthBox when reaching the size limit. Be
cautious when using this method. Best is to show a warning message to the user before deleting the messages.
Request
In MessageId you specify where the messages to delete from the bin or directly from the inbox or sent box. This
method can only delete 100 messages at a time; consequently, you must use it multiple times if necessary.
Response
The response contains a success status code or a business error. The business error
enables you to identify which messages where not successfully deleted, even though all other have been deleted
successfully.
Basic flow
| Flow | Specifications |
|---|
| | ID | AP-UC09-BF | | Name | Delete a message from the message list view | | Description | / | | Actor(s) | One healthcare professional | | Requirements | - Atleast one message in one of the message boxes.
| | Trigger | A healthcare professional wants to delete a message. | | Precondition(s) | - The user is logged in.
- The user wants to delete a message.
| | Flow | - See use case: login.
- The user wants to view the contents of one of his message boxes.
The user will see a list with all of his message for the specific folder he/she requested.
See use case: consultation for more information about the GetMessageList method. - The user selects a message. The user wants to delete this message.
- The user gets automatically returned to the list view of the message box he/she was in.
The list gets updated automatically.
| | Postcondition(s) | - The message is no longer available in the message box it was consulted in.
- The message is available in the message box it was moved to.
| | Test Data | GetMessagesList DeleteMessage | | Endpoint(s) | |
|
Alternative flow 1
| Flow | Specifications |
|---|
| | ID | AP-UC08-AF01 | | Name | Delete a message from the full message view | | Description | / | | Actor(s) | One healthcare professional | | Requirements | - Atleast one message in one of the message boxes.
| | Trigger | A healthcare professional wants to delete a message. | | Precondition(s) | - The user is logged in.
- The user wants to delete a message.
| | Flow | - See use case: login.
- The user wants to view the contents of one of his message boxes.
The user will see a list with all of his message for the specific folder he/she requested.
See use case: consultation for more information about the GetMessageList method. - The user selects one message to read. The message will be opened.
See use case: read message for more information about the GetFullMessage method. - The user moves this message to a different message box.
- The user gets automatically returned to the list view of the message box he/she was in.
The list gets updated automatically.
| | Postcondition(s) | - The message is no longer available in the message box it was consulted in.
- The message is available in the message box it was moved to.
| | Test Data | GetMessagesList GetFullMessage DeleteMessage | | Endpoint(s) | |
|
to do