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.
NotificationName | 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": "2ee9dfca-cb35-4f07-a128-833ec913e142", "AlertGUID": "be9ac77e-fbd1-448d-ab5a-58478011d093", "NotificationAction": { "Id": 1, "ActionGUID": "bb411ae0-77e0-4c7f-8581-180b25a57fea", "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": "6098a9bc-b2bf-47d0-9d3b-08f07abd0547", "UserGUID": "c6b4d9d8-6edb-42b3-a894-9c7edc0e4364", "PatientGUID": "ed96bdf8-138a-4f70-9ef1-29b018d8be7d" }, "Category": "sample string 2", "Description": "sample string 3", "Action": { "Id": 1, "ActionGUID": "bb411ae0-77e0-4c7f-8581-180b25a57fea", "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": "6098a9bc-b2bf-47d0-9d3b-08f07abd0547", "UserGUID": "c6b4d9d8-6edb-42b3-a894-9c7edc0e4364", "PatientGUID": "ed96bdf8-138a-4f70-9ef1-29b018d8be7d" }, "ActionGUID": "78fefed1-b359-4e24-905d-7969562ee473", "Url": "sample string 4", "ModuleID": 1, "ModuleParameter": "sample string 5", "IconUrl": "sample string 6", "Group": "de68f3d0-d8b7-4ce5-9d55-da782b11073a" }
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>ed96bdf8-138a-4f70-9ef1-29b018d8be7d</PatientGUID> <ActionGUID>bb411ae0-77e0-4c7f-8581-180b25a57fea</ActionGUID> <ActionGroup>sample string 10</ActionGroup> <ActionGroupGUID>6098a9bc-b2bf-47d0-9d3b-08f07abd0547</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>c6b4d9d8-6edb-42b3-a894-9c7edc0e4364</UserGUID> <UserInitials>sample string 13</UserInitials> </Action> <ActionGUID>78fefed1-b359-4e24-905d-7969562ee473</ActionGUID> <AlertGUID>be9ac77e-fbd1-448d-ab5a-58478011d093</AlertGUID> <Category>sample string 2</Category> <Description>sample string 3</Description> <Group>de68f3d0-d8b7-4ce5-9d55-da782b11073a</Group> <IconUrl>sample string 6</IconUrl> <ModuleID>1</ModuleID> <ModuleParameter>sample string 5</ModuleParameter> <NotificationAction> <PatientGUID>ed96bdf8-138a-4f70-9ef1-29b018d8be7d</PatientGUID> <ActionGUID>bb411ae0-77e0-4c7f-8581-180b25a57fea</ActionGUID> <ActionGroup>sample string 10</ActionGroup> <ActionGroupGUID>6098a9bc-b2bf-47d0-9d3b-08f07abd0547</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>c6b4d9d8-6edb-42b3-a894-9c7edc0e4364</UserGUID> <UserInitials>sample string 13</UserInitials> </NotificationAction> <TransferToken>2ee9dfca-cb35-4f07-a128-833ec913e142</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.
NotificationResponseName | 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>