...
Retrieves the messages of a particular User. Messages can be retrieved from different sources. Currently supported sources are: Email, Alert , ParameterizedAlert, or Document.Archived or Trashed messages are never returned.
To get a better understanding on how Parameterized Alerts are retrieved, take a look at the following document: Alerts and Notifications#AlertRetrieval
Parameters
Base URL: /getMessages
...
| Name | Type | Mandatory | Description |
|---|---|---|---|
| token | String | Yes | Security Token obtained before. |
| userId | String | Yes | The id of the logged in user. |
| type | ENUM | No | Possible values: ['ALL', 'ALERT', 'EMAIL', 'DOCUMENT',"PARAMETERIZEDALERT' ]. Default value: "ALL". The source of the messages. |
| location | ENUM | No | Possible values: ['INBOX', 'SENT', 'ARCHIVE']. Default value: "INBOX". |
| patientId | String | No | Used if we want to retrieve only those messages related to a specific patient. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"messagesFact": {
"statusFact": {
"success": true
}
,"messageObjects": [
{
"messageId": "25ff80818147e7ee6c0147e7f14d000005",
"type": "AlertParameterizedAlert",
"podId": "Pod CA",
"location": "INBOX",
"labels": [],
"messageDate": "38/0718/14",
"messageTime": "1309:2607",
"description": "No Skin To Skin Contact In 7 DaysAlert",
"from": "[S4-ALERT] No skin to skin contact in 7 days",
"title": " peggy 501##split##33wks500##split##33wks 998g999g",
"payload": "This patient has not had skin to skin contact for at least 7 consecutive days.",
"status": "Unread",
"priority": "HIGH",
"tasksCount": 10,
"tasksComplete": 0
},{
"messageId": "22",
...
}
]}} |