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

Sample:

{
  "TransferToken": "938f2a33-5e30-45b1-b2ea-29fbfee4ba2d",
  "AlertGUID": "9dc0a822-6645-4fe6-93f4-0f7f158c5c48",
  "NotificationAction": {
    "Id": 1,
    "ActionGUID": "ddd975f8-5963-4d03-a221-80a6cf2dc79e",
    "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": "f7fe38dc-7f47-4344-af80-2a8d760c310c",
    "UserGUID": "bbeb0036-b26e-4d71-b1be-6dd2d01c9752",
    "PatientGUID": "bd058275-8eb3-4ff1-9476-af43150fcead"
  },
  "Category": "sample string 2",
  "Description": "sample string 3",
  "Action": {
    "Id": 1,
    "ActionGUID": "ddd975f8-5963-4d03-a221-80a6cf2dc79e",
    "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": "f7fe38dc-7f47-4344-af80-2a8d760c310c",
    "UserGUID": "bbeb0036-b26e-4d71-b1be-6dd2d01c9752",
    "PatientGUID": "bd058275-8eb3-4ff1-9476-af43150fcead"
  },
  "ActionGUID": "07fb3ef8-adf4-4cc1-a7eb-4165c2c3c4c4",
  "Url": "sample string 4",
  "ModuleID": 1,
  "ModuleParameter": "sample string 5",
  "IconUrl": "sample string 6",
  "Group": "d02deb26-5291-4c17-97ed-311b3e48de9f"
}

application/xml, text/xml

Sample:

<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <Action>
    <PatientGUID>bd058275-8eb3-4ff1-9476-af43150fcead</PatientGUID>
    <ActionGUID>ddd975f8-5963-4d03-a221-80a6cf2dc79e</ActionGUID>
    <ActionGroup>sample string 10</ActionGroup>
    <ActionGroupGUID>f7fe38dc-7f47-4344-af80-2a8d760c310c</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>bbeb0036-b26e-4d71-b1be-6dd2d01c9752</UserGUID>
    <UserInitials>sample string 13</UserInitials>
  </Action>
  <ActionGUID>07fb3ef8-adf4-4cc1-a7eb-4165c2c3c4c4</ActionGUID>
  <AlertGUID>9dc0a822-6645-4fe6-93f4-0f7f158c5c48</AlertGUID>
  <Category>sample string 2</Category>
  <Description>sample string 3</Description>
  <Group>d02deb26-5291-4c17-97ed-311b3e48de9f</Group>
  <IconUrl>sample string 6</IconUrl>
  <ModuleID>1</ModuleID>
  <ModuleParameter>sample string 5</ModuleParameter>
  <NotificationAction>
    <PatientGUID>bd058275-8eb3-4ff1-9476-af43150fcead</PatientGUID>
    <ActionGUID>ddd975f8-5963-4d03-a221-80a6cf2dc79e</ActionGUID>
    <ActionGroup>sample string 10</ActionGroup>
    <ActionGroupGUID>f7fe38dc-7f47-4344-af80-2a8d760c310c</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>bbeb0036-b26e-4d71-b1be-6dd2d01c9752</UserGUID>
    <UserInitials>sample string 13</UserInitials>
  </NotificationAction>
  <TransferToken>938f2a33-5e30-45b1-b2ea-29fbfee4ba2d</TransferToken>
  <Url>sample string 4</Url>
</Notification>

application/x-www-form-urlencoded

Sample:

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

Sample:

{
  "WasRetransmitted": true
}

application/xml, text/xml

Sample:

<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>