You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 55
Next »
Table of contents
Used documentation
MoveMessage
The MoveMessage method enables the user to move a message from a Source (“INBOX”, “SENTBOX”,
“BININBOX”, “BINSENTBOX”) to a Destination (“INBOX”, “SENTBOX”, “BININBOX”, “BINSENTBOX”). Only some
combinations are allowed as explained below. You need to indicate if a message was received or sent by the
concerned eHealthBox. You can do this by looking where the message is situated or compare the currently
connected user and the Sender and/ or Destination element.
The following table displays the allowed combinations of the MoveMessage method:
| Source | Destination |
|---|
| INBOX | BININBOX |
| SENTBOX | BINSENTBOX |
| BININBOX | INBOX |
| BINSENTBOX | SENTBOX |
Request
In Source specify where the message is currently situated and in Destination where the message must be moved
to. In MessageId specify as many elements as there are messages to be moved. This method can only move 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 as defined in Chapter 8. The Business Error
enables you to identify which messages where not successfully moved, even though all other have been moved
successfully.
Basic flow
| Flow | Specifications |
|---|
| | ID | AP-UC08-BF | | Name | Move a message from one message box to another message box from the message list view | | Description | A 'message box' can be one of the following: inbox, sent box, bin inbox and bin sent box.
A table of allowed combinations can be found here. | | Actor(s) | One healthcare professional | | Requirements | - Atleast one message in one of the message boxes.
| | Trigger | A healthcare professional wants to move a message. | | Precondition(s) | - The user is logged in.
- The user wants to move 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 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 MoveMessage | | Endpoint(s) | |
|
Alternative flow 1
| Flow | Specifications |
|---|
| | ID | AP-UC08-AF01 | | Name | Move a message from one message box to another message box from the full message view | | Description | A 'message box' can be one of the following: inbox, sent box, bin inbox and bin sent box.
A table of allowed combinations can be found here. | | Actor(s) | One healthcare professional | | Requirements | - Atleast one message in one of the message boxes.
| | Trigger | A healthcare professional wants to move a message. | | Precondition(s) | - The user is logged in.
- The user wants to move 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 MoveMessage | | Endpoint(s) | |
|
Exception flow 1
| Flow | Specifications |
|---|
| | ID | AP-UC08-EF01 | | Name | Try to move a message to a not allowed message box | | Description | A 'message box' can be one of the following: inbox, sent box, bin inbox and bin sent box.
A table of allowed combinations can be found here. | | Actor(s) | One healthcare professional | | Requirements | - Atleast one message in one of the message boxes.
| | Trigger | A healthcare professional wants to move a message. | | Precondition(s) | - The user is logged in.
- The user wants to move 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 attempts to move this message to a not allowed message box. Example of not allowed combinations are (Inbox ↔ Sent box,
- An error message (Error ID: 812) is displayed to the user. The error message can, for example, be removed by pressing OK.
| | Postcondition(s) | - The user sees an error message relating to his/her issue.
- The ID of the error message is 812.
- The application keeps working as intended.
| | Test Data | GetMessagesList MoveMessage | | Endpoint(s) | |
|
Exception flow 2
| Flow | Specifications |
|---|
| | ID | AP-UC08-EF02 | | Name | Try to move a message with an invalid message id | | Description | / | | Actor(s) | One healthcare professional | | Requirements | - Atleast one message in one of the message boxes.
| | Trigger | A healthcare professional wants to move a message. | | Precondition(s) | - The user is logged in.
- The user wants to move 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 attempts to move this message with an invalid id.
- An error message (Error ID: 813) is displayed to the user.
The error message can, for example, be removed by pressing OK.
| | Postcondition(s) | - The user sees an error message relating to his/her issue.
- The ID of the error message is 813.
- The application keeps working as intended.
| | Test Data | GetMessagesList MoveMessage | | Endpoint(s) | |
|