You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 76
Next »
Table of contents
Used documentation
GetMessagesList
The getMessagesList method provides a list of messages for a specific folder of your eHealthBox listed in order
by date (most recent first, index “1”). A consequence could be that if a new message arrives between two
consecutive queries, a message will be shown two times (message “1” becomes “2”, “2” becomes “3”, etc.). E.g.
if you requested the messages between “1” and “100” and then the messages between “101” and “200”, then
the message “100” would be the same as message “101”.
The messages contents are not yet returned by this method but it returns a list with all the information needed
to treat, filter, sorts the messages. The sender, recipient, title message, publication date, message size, custom
metas are all displayed for example.
Request
You can optionally request information of another of your mailboxes by specifying it via BoxId, This method can
only return 100 messages at a time; consequently, you must use it multiple times if necessary.
Response
The response contains a success status code and as many Message elements as there are messages in the
considered eHealthBox. Each element contains all necessary information to treat the message without
downloading each individual message.
GetAllEhMessagesList
The GetAllEhboxesMessagesList method provides a list of all the messages from all the eHealthBoxes of a user
(personal and enterprise eHealthBoxes) for a specific folder. This method repeatedly calls upon the
GetMessagesList method for all known eHealthBoxes of the currently connected user.
Request
This method can only return 100 messages at a time; consequently, you must call upon it multiple times if
necessary.
Response
The response contains a success status code and as many Message elements as there are messages in all the
eHealthBoxes of the currently connected user (personal and enterprise eHealthBoxes). Each element contains
all necessary information to treat the message without downloading each individual message. You can identify
which eHealthBox received the message via the Destination element.
Basic flow
| Flow | Specifications |
|---|
| | ID | AP-UC05-BF | | Name | View the messages in a specific folder | | Description | 'A specific folder' is in this case one of the following: inbox, sent box, bin inbox and bin sent box. | | Actor(s) | One healthcare professional | | Requirements | / | | Trigger | A healthcare professional wants to view his/her messages. | | Precondition(s) | - The user is logged in.
- The user wants to view his/her messages.
| | Flow | - See use case: login.
- The user can view the messages in a specific folder.
| | Postcondition(s) | - The user can see the page of his chosen message box.
- The list of messages that the users can see is correct.
| | Test Data | | | Endpoint(s) | |
|
Alternative flow 1
| Flow | Specifications |
|---|
| | ID | AP-UC05-AF01 | | Name | View the messages in a specific folder from all your eHealthBoxes |
| 'A specific folder' is in this case one of the following: inbox, sent box, bin inbox and bin sent box. | | Actor(s) | One healthcare professional | | Requirements | - Have two or more eHealthBoxes.
| | Trigger | A healthcare professional wants to view his/her messages from all his/her eHealthBoxes. | | Precondition(s) | - The user is logged in.
- The user wants to view his/her messages.
| | Flow | - See use case: login.
- The user can view the messages in a specific folder for all of his/her eHealthBoxes.
| | Postcondition(s) | - The user can see the page of his chosen message box.
- The list of messages that the users can see is correct.
| | Test Data | | | Endpoint(s) | |
|
| Flow | Specifications |
|---|
| | ID | AP-UC05-AF01 | | Name | View the messages in one of your message boxes from another eHealthBox | | Description | 'One of your message boxes' is in this case one of the following: inbox, sent box, bin inbox and bin sent box. | | Actor(s) | One healthcare professional | | Requirements | - Have two or more eHealthBoxes.
| | Trigger | A healthcare professional wants to view his/her messages from another eHealthBox. | | Precondition(s) | - The user is logged in.
- The user wants to view his/her messages.
| | Flow | - See use case: login.
- OPTIONAL: Information about the eHealthBox can be shown.
See use case: eHealthBox info. - The user can view the contents of one of his message boxes.
| | Postcondition(s) | - The user can see the page of his chosen message box.
- The list of messages that the users can see is correct.
| | Test Data | | | Endpoint(s) | |
|