POST api/patients/byguid/{patientGuid}/notifications
Sends a notification
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientGuid |
The patient Guid |
globally unique identifier |
Required |
Body Parameters
The notification sent.
Notification| Name | Description | Type | Additional information |
|---|---|---|---|
| TransferToken |
A unique token for this transfer. Used to handle (ignore) redundant retransmissions. |
globally unique identifier |
None. |
| AlertGUID |
Identifies the alert. Can be null, if no alerts should be made. |
globally unique identifier |
None. |
| NotificationAction |
Is used to add a NotificationAction. Can be null, if no notification action should be made. |
Action |
None. |
| Category |
The category of the alert. Only a (semi)fixed set of values are allowed to pass through from the cloud. |
string |
None. |
| Description |
The alerts description. |
string |
None. |
| Action |
Is used to add an action. Can only be non-null, if ActionGUID is null. Can be null. |
Action |
None. |
| ActionGUID |
Is used to reference an existing action. Can only be non-null, if Action is null. Can be null. |
globally unique identifier |
None. |
| Url |
An url for a web page (that can be opened from the Dashboard), associated with the alert. Can be null. |
string |
None. |
| ModuleID |
The ID of a Noah module (that can be opened from the Dashboard), associated with the alert. Can be null. |
integer |
None. |
| ModuleParameter |
A string passed (by command line) to the module when opening it. Can be null. |
string |
None. |
| IconUrl |
An url for an image. Used to show on a button that opens the Url. Can be null. |
string |
None. |
| Group |
Notifications with same Group value are in group, and are presented as that on the Dashboard. Can be null. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
{
"TransferToken": "fc6f8a1b-4ef9-40aa-b59c-58070529b76f",
"AlertGUID": "4970d3bb-4c37-4291-a096-6594974b0e0f",
"NotificationAction": {
"Id": 1,
"ActionGUID": "7832d37d-3f96-41e8-b36e-126be6fe91ea",
"SessionID": 3,
"CreateDate": "sample string 4",
"ModuleID": 5,
"Description": "sample string 6",
"DataTypeCode": 7,
"DataFmtStd": 8,
"DataFmtExt": 9,
"ActionGroup": "sample string 10",
"DeviceType": 11,
"LastModifiedDate": "sample string 12",
"UserInitials": "sample string 13",
"ActionReferences": [
1,
2
],
"PublicData": "QEA=",
"PrivateData": "QEA=",
"ActionGroupGUID": "2a12362d-f5ce-45c2-946e-deccf2669507",
"UserGUID": "c1f6b4e7-5243-4883-9a6a-aefbd2f0c40d",
"PatientGUID": "5edd223d-e847-458c-a18c-b29ba0fb97cb"
},
"Category": "sample string 2",
"Description": "sample string 3",
"Action": {
"Id": 1,
"ActionGUID": "7832d37d-3f96-41e8-b36e-126be6fe91ea",
"SessionID": 3,
"CreateDate": "sample string 4",
"ModuleID": 5,
"Description": "sample string 6",
"DataTypeCode": 7,
"DataFmtStd": 8,
"DataFmtExt": 9,
"ActionGroup": "sample string 10",
"DeviceType": 11,
"LastModifiedDate": "sample string 12",
"UserInitials": "sample string 13",
"ActionReferences": [
1,
2
],
"PublicData": "QEA=",
"PrivateData": "QEA=",
"ActionGroupGUID": "2a12362d-f5ce-45c2-946e-deccf2669507",
"UserGUID": "c1f6b4e7-5243-4883-9a6a-aefbd2f0c40d",
"PatientGUID": "5edd223d-e847-458c-a18c-b29ba0fb97cb"
},
"ActionGUID": "029bf91b-fac0-49c5-b4ae-5ecc8238d648",
"Url": "sample string 4",
"ModuleID": 1,
"ModuleParameter": "sample string 5",
"IconUrl": "sample string 6",
"Group": "6871bd5d-b80e-4179-9ab4-c799e5edd6f3"
}
application/xml, text/xml
<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
<Action>
<PatientGUID>5edd223d-e847-458c-a18c-b29ba0fb97cb</PatientGUID>
<ActionGUID>7832d37d-3f96-41e8-b36e-126be6fe91ea</ActionGUID>
<ActionGroup>sample string 10</ActionGroup>
<ActionGroupGUID>2a12362d-f5ce-45c2-946e-deccf2669507</ActionGroupGUID>
<ActionReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</ActionReferences>
<CreateDate>sample string 4</CreateDate>
<DataFmtExt>9</DataFmtExt>
<DataFmtStd>8</DataFmtStd>
<DataTypeCode>7</DataTypeCode>
<Description>sample string 6</Description>
<DeviceType>11</DeviceType>
<Id>1</Id>
<LastModifiedDate>sample string 12</LastModifiedDate>
<ModuleID>5</ModuleID>
<PrivateData>QEA=</PrivateData>
<PublicData>QEA=</PublicData>
<SessionID>3</SessionID>
<UserGUID>c1f6b4e7-5243-4883-9a6a-aefbd2f0c40d</UserGUID>
<UserInitials>sample string 13</UserInitials>
</Action>
<ActionGUID>029bf91b-fac0-49c5-b4ae-5ecc8238d648</ActionGUID>
<AlertGUID>4970d3bb-4c37-4291-a096-6594974b0e0f</AlertGUID>
<Category>sample string 2</Category>
<Description>sample string 3</Description>
<Group>6871bd5d-b80e-4179-9ab4-c799e5edd6f3</Group>
<IconUrl>sample string 6</IconUrl>
<ModuleID>1</ModuleID>
<ModuleParameter>sample string 5</ModuleParameter>
<NotificationAction>
<PatientGUID>5edd223d-e847-458c-a18c-b29ba0fb97cb</PatientGUID>
<ActionGUID>7832d37d-3f96-41e8-b36e-126be6fe91ea</ActionGUID>
<ActionGroup>sample string 10</ActionGroup>
<ActionGroupGUID>2a12362d-f5ce-45c2-946e-deccf2669507</ActionGroupGUID>
<ActionReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</ActionReferences>
<CreateDate>sample string 4</CreateDate>
<DataFmtExt>9</DataFmtExt>
<DataFmtStd>8</DataFmtStd>
<DataTypeCode>7</DataTypeCode>
<Description>sample string 6</Description>
<DeviceType>11</DeviceType>
<Id>1</Id>
<LastModifiedDate>sample string 12</LastModifiedDate>
<ModuleID>5</ModuleID>
<PrivateData>QEA=</PrivateData>
<PublicData>QEA=</PublicData>
<SessionID>3</SessionID>
<UserGUID>c1f6b4e7-5243-4883-9a6a-aefbd2f0c40d</UserGUID>
<UserInitials>sample string 13</UserInitials>
</NotificationAction>
<TransferToken>fc6f8a1b-4ef9-40aa-b59c-58070529b76f</TransferToken>
<Url>sample string 4</Url>
</Notification>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The response to the sent notification.
NotificationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| WasRetransmitted |
Indicates if the Notification was retransmitted. |
boolean |
None. |
Response Formats
application/json, text/json
{
"WasRetransmitted": true
}
application/xml, text/xml
<NotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model"> <WasRetransmitted>true</WasRetransmitted> </NotificationResponse>