POST api/v1/xref/{providerXRef}/infrastructure/notifications

Raise new notification for provider

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerXRef

string

Required

Body Parameters

Com.Healthbridge.Core.CommonDomain.Interface.Commands.RaiseNotification
NameDescriptionTypeAdditional information
Notification

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.NotificationVo

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Notification": {
    "NotificationId": "fb3b46f6-559a-41f6-b6aa-250d0bc7af89",
    "NotificationXRef": "sample string 2",
    "ProviderId": "b9dcd4c4-296d-4916-a4da-0bb3ce49984c",
    "Date": "2025-06-22T15:12:58Z",
    "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"
    }
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 1"
}

application/xml, text/xml

Sample: 
<RaiseNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 1</OriginatedSystem>
  <Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
    <d2p1:Actions>
      <d2p1:NotificationActionVo>
        <d2p1:ActionLink>sample string 3</d2p1:ActionLink>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:Modal>true</d2p1:Modal>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:NotificationActionVo>
      <d2p1:NotificationActionVo>
        <d2p1:ActionLink>sample string 3</d2p1:ActionLink>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:Modal>true</d2p1:Modal>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:NotificationActionVo>
    </d2p1:Actions>
    <d2p1:Body>sample string 8</d2p1:Body>
    <d2p1:BodyType>sample string 9</d2p1:BodyType>
    <d2p1:Category>sample string 7</d2p1:Category>
    <d2p1:Context>sample string 5</d2p1:Context>
    <d2p1: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>
    </d2p1:Data>
    <d2p1:Date>2025-06-22T15:12:58.3212029+02:00</d2p1:Date>
    <d2p1:NotificationId>fb3b46f6-559a-41f6-b6aa-250d0bc7af89</d2p1:NotificationId>
    <d2p1:NotificationXRef>sample string 2</d2p1:NotificationXRef>
    <d2p1:ProviderId>b9dcd4c4-296d-4916-a4da-0bb3ce49984c</d2p1:ProviderId>
    <d2p1:Subject>sample string 6</d2p1:Subject>
  </Notification>
</RaiseNotification>

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 'RaiseNotification'.

Response Information

Resource Description

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

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

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": "27aed484-ad8c-49f4-a801-02a562c1ded7",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>27aed484-ad8c-49f4-a801-02a562c1ded7</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>
</RestApiResultOfguid>