Table of contents
Used documentation
GetBoxInfo
The getBoxInfo method allows an authenticated user to receive general information about his mailbox: the
current used size of your mailbox, the maximum allowed size of your mailbox, and the number of messages,
which could not be received because the mailbox was full. These messages are still waiting to be put in your
mailbox. You need to clean your mailbox until the current size is lower than the max size. The messages will then
enter into your mailbox.
Request
You can optionally request information of another of your mailboxes by specifying it via BoxId.
Response
The response contains a success status code and general information on the eHealthBox as explained below. The
BoxId element enables you to discover information on the current eHealthBox if you currently do not have any.
Attention should be paid to NbrMessagesInStandBy larger than zero and if CurrentSize > MaxSize.
Basic flow
| Flow | Specifications |
|---|
| | ID | UC407-BF | | Name | View the eHealthBox info on the home screen | | Description | / | | Actor(s) | One healthcare professional | | Requirements | / | | Trigger | A healthcare professional wants to see the info of his/her eHealthBox. | | Precondition(s) | - The user is logged in.
- The user wants to see the info of his/her eHealthBox.
| | Flow | - See use case: login.
- Open the eHealthBox.
The information about the eHealthBox is displayed here.
| | Postcondition(s) | - The information is correctly displayed.
| | Test Data | GetBoxInfo | | Endpoint(s) | |
|
Alternative flow 1
| Flow | Specifications |
|---|
| | ID | UC407-AF01 | | Name | View the eHealthBox info on a seperate screen | | Description | / | | Actor(s) | One healthcare professional | | Requirements | / | | Trigger | A healthcare professional wants to see the info of his/her eHealthBox. | | Precondition(s) | - The user is logged in.
- The user wants to see the info of his/her eHealthBox.
| | Flow | - See use case: login.
- Open the information page.
The information about the eHealthBox is now displayed.
| | Postcondition(s) | - The information is correctly displayed.
| | Test Data | GetBoxInfo | | Endpoint(s) | |
|
Exception flow 1
| Flow | Specifications |
|---|
| | ID | UC407-EF01 | | Name | Attempt to get information from a non-existing eHealthBox | | Description | / | | Actor(s) | One healthcare professional | | Requirements | / | | Trigger | A healthcare professional wants to see the info of his/her eHealthBox. | | Precondition(s) | - The user is logged in.
- The user wants to see the info of his/her eHealthBox.
| | Flow | - See use case: login.
- Attempt to request information of a non-existing eHealthBox. This will cause an error message to be displayed saying "Invalid BoxId".
| | Postcondition(s) | - The information is correctly displayed.
| | Test Data | GetBoxInfo | | Endpoint(s) | |
|