POST api/v1/infrastructure/notifications/bulk

Raise multiple notifications in one go

Request Information

URI Parameters

None.

Body Parameters

array of notifications

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.NotificationVo
NameDescriptionTypeAdditional information
NotificationId

globally unique identifier

None.
NotificationXRef

string

None.
ProviderId

globally unique identifier

None.
Date

date

None.
Context

string

None.
Subject

string

None.
Category

string

None.
Body

string

None.
BodyType

string

None.
Actions

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.NotificationActionVo

None.
Data

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "NotificationId": "c5640adf-393f-4fd7-aa12-4d3e960d14e5",
    "NotificationXRef": "sample string 2",
    "ProviderId": "f76e2c60-a22a-448e-b433-620b7fd27890",
    "Date": "2025-04-10T15:33:02Z",
    "Context": "sample string 5",
    "Subject": "sample string 6",
    "Category": "sample string 7",
    "Body": "sample string 8",
    "BodyType": "sample string 9",
    "Actions": [
      {
        "Description": "sample string 1",
        "Name": "sample string 2",
        "ActionLink": "sample string 3",
        "Modal": true
      },
      {
        "Description": "sample string 1",
        "Name": "sample string 2",
        "ActionLink": "sample string 3",
        "Modal": true
      }
    ],
    "Data": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  {
    "NotificationId": "c5640adf-393f-4fd7-aa12-4d3e960d14e5",
    "NotificationXRef": "sample string 2",
    "ProviderId": "f76e2c60-a22a-448e-b433-620b7fd27890",
    "Date": "2025-04-10T15:33:02Z",
    "Context": "sample string 5",
    "Subject": "sample string 6",
    "Category": "sample string 7",
    "Body": "sample string 8",
    "BodyType": "sample string 9",
    "Actions": [
      {
        "Description": "sample string 1",
        "Name": "sample string 2",
        "ActionLink": "sample string 3",
        "Modal": true
      },
      {
        "Description": "sample string 1",
        "Name": "sample string 2",
        "ActionLink": "sample string 3",
        "Modal": true
      }
    ],
    "Data": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfNotificationVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <NotificationVo>
    <Actions>
      <NotificationActionVo>
        <ActionLink>sample string 3</ActionLink>
        <Description>sample string 1</Description>
        <Modal>true</Modal>
        <Name>sample string 2</Name>
      </NotificationActionVo>
      <NotificationActionVo>
        <ActionLink>sample string 3</ActionLink>
        <Description>sample string 1</Description>
        <Modal>true</Modal>
        <Name>sample string 2</Name>
      </NotificationActionVo>
    </Actions>
    <Body>sample string 8</Body>
    <BodyType>sample string 9</BodyType>
    <Category>sample string 7</Category>
    <Context>sample string 5</Context>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Data>
    <Date>2025-04-10T15:33:02.7464077+02:00</Date>
    <NotificationId>c5640adf-393f-4fd7-aa12-4d3e960d14e5</NotificationId>
    <NotificationXRef>sample string 2</NotificationXRef>
    <ProviderId>f76e2c60-a22a-448e-b433-620b7fd27890</ProviderId>
    <Subject>sample string 6</Subject>
  </NotificationVo>
  <NotificationVo>
    <Actions>
      <NotificationActionVo>
        <ActionLink>sample string 3</ActionLink>
        <Description>sample string 1</Description>
        <Modal>true</Modal>
        <Name>sample string 2</Name>
      </NotificationActionVo>
      <NotificationActionVo>
        <ActionLink>sample string 3</ActionLink>
        <Description>sample string 1</Description>
        <Modal>true</Modal>
        <Name>sample string 2</Name>
      </NotificationActionVo>
    </Actions>
    <Body>sample string 8</Body>
    <BodyType>sample string 9</BodyType>
    <Category>sample string 7</Category>
    <Context>sample string 5</Context>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Data>
    <Date>2025-04-10T15:33:02.7464077+02:00</Date>
    <NotificationId>c5640adf-393f-4fd7-aa12-4d3e960d14e5</NotificationId>
    <NotificationXRef>sample string 2</NotificationXRef>
    <ProviderId>f76e2c60-a22a-448e-b433-620b7fd27890</ProviderId>
    <Subject>sample string 6</Subject>
  </NotificationVo>
</ArrayOfNotificationVo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'NotificationVo[]'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.String
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

string

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "sample string 4",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>sample string 4</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfstring>