GET api/v1/{providerId}/infrastructure/notifications

Get active notifications for provider

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Array of all 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.

Response Formats

application/json, text/json

Sample: 
[
  {
    "NotificationId": "6c550ee8-c926-4de6-8704-e08b48ffffc9",
    "NotificationXRef": "sample string 2",
    "ProviderId": "b44c2513-f632-4635-a5d0-91724733ebce",
    "Date": "2025-04-16T03:43:00Z",
    "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": "6c550ee8-c926-4de6-8704-e08b48ffffc9",
    "NotificationXRef": "sample string 2",
    "ProviderId": "b44c2513-f632-4635-a5d0-91724733ebce",
    "Date": "2025-04-16T03:43:00Z",
    "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-16T03:43:00.219151+02:00</Date>
    <NotificationId>6c550ee8-c926-4de6-8704-e08b48ffffc9</NotificationId>
    <NotificationXRef>sample string 2</NotificationXRef>
    <ProviderId>b44c2513-f632-4635-a5d0-91724733ebce</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-16T03:43:00.219151+02:00</Date>
    <NotificationId>6c550ee8-c926-4de6-8704-e08b48ffffc9</NotificationId>
    <NotificationXRef>sample string 2</NotificationXRef>
    <ProviderId>b44c2513-f632-4635-a5d0-91724733ebce</ProviderId>
    <Subject>sample string 6</Subject>
  </NotificationVo>
</ArrayOfNotificationVo>