POST api/GetCommunicationAlert

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DateCreated	date	None.
BranchID	integer	None.
CommunicationAlertId	integer	None.
CompanyID	integer	None.
ComsGroupID	integer	None.
ComsTypeID	integer	None.
Deleted	integer	None.
LastDays	integer	None.
RecurringDays	integer	None.
ReturnReasonID	integer	None.
TemplateID	integer	None.
Name	string	None.
Type	string	None.
UserData	Collection of UserData	None.
CompanyData	Collection of CompanyData	None.
BranchData	Collection of BranchData	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "DateCreated": "2026-10-07T11:49:52.6271277+02:00",
    "BranchID": 2,
    "CommunicationAlertId": 3,
    "CompanyID": 4,
    "ComsGroupID": 5,
    "ComsTypeID": 6,
    "Deleted": 7,
    "LastDays": 8,
    "RecurringDays": 9,
    "ReturnReasonID": 10,
    "TemplateID": 11,
    "Name": "sample string 12",
    "Type": "sample string 13",
    "UserData": [
      {
        "UserUID": "sample string 1",
        "UserKey": "sample string 2",
        "CompanyKey": "sample string 3",
        "SessionKey": "sample string 4",
        "PatientKey": "sample string 5"
      },
      {
        "UserUID": "sample string 1",
        "UserKey": "sample string 2",
        "CompanyKey": "sample string 3",
        "SessionKey": "sample string 4",
        "PatientKey": "sample string 5"
      }
    ],
    "CompanyData": [
      {
        "CompanyName": "sample string 1",
        "CompanyUID": "sample string 2",
        "Source": "sample string 3"
      },
      {
        "CompanyName": "sample string 1",
        "CompanyUID": "sample string 2",
        "Source": "sample string 3"
      }
    ],
    "BranchData": [
      {
        "BranchName": "sample string 1",
        "BranchUID": "sample string 2",
        "Source": "sample string 3"
      },
      {
        "BranchName": "sample string 1",
        "BranchUID": "sample string 2",
        "Source": "sample string 3"
      }
    ]
  },
  {
    "DateCreated": "2026-10-07T11:49:52.6271277+02:00",
    "BranchID": 2,
    "CommunicationAlertId": 3,
    "CompanyID": 4,
    "ComsGroupID": 5,
    "ComsTypeID": 6,
    "Deleted": 7,
    "LastDays": 8,
    "RecurringDays": 9,
    "ReturnReasonID": 10,
    "TemplateID": 11,
    "Name": "sample string 12",
    "Type": "sample string 13",
    "UserData": [
      {
        "UserUID": "sample string 1",
        "UserKey": "sample string 2",
        "CompanyKey": "sample string 3",
        "SessionKey": "sample string 4",
        "PatientKey": "sample string 5"
      },
      {
        "UserUID": "sample string 1",
        "UserKey": "sample string 2",
        "CompanyKey": "sample string 3",
        "SessionKey": "sample string 4",
        "PatientKey": "sample string 5"
      }
    ],
    "CompanyData": [
      {
        "CompanyName": "sample string 1",
        "CompanyUID": "sample string 2",
        "Source": "sample string 3"
      },
      {
        "CompanyName": "sample string 1",
        "CompanyUID": "sample string 2",
        "Source": "sample string 3"
      }
    ],
    "BranchData": [
      {
        "BranchName": "sample string 1",
        "BranchUID": "sample string 2",
        "Source": "sample string 3"
      },
      {
        "BranchName": "sample string 1",
        "BranchUID": "sample string 2",
        "Source": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfJsonCommunicationAlerts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Heardat_API.Models">
  <JsonCommunicationAlerts>
    <BranchData>
      <BranchData>
        <BranchName>sample string 1</BranchName>
        <BranchUID>sample string 2</BranchUID>
        <Source>sample string 3</Source>
      </BranchData>
      <BranchData>
        <BranchName>sample string 1</BranchName>
        <BranchUID>sample string 2</BranchUID>
        <Source>sample string 3</Source>
      </BranchData>
    </BranchData>
    <BranchID>2</BranchID>
    <CommunicationAlertId>3</CommunicationAlertId>
    <CompanyData>
      <CompanyData>
        <CompanyName>sample string 1</CompanyName>
        <CompanyUID>sample string 2</CompanyUID>
        <Source>sample string 3</Source>
      </CompanyData>
      <CompanyData>
        <CompanyName>sample string 1</CompanyName>
        <CompanyUID>sample string 2</CompanyUID>
        <Source>sample string 3</Source>
      </CompanyData>
    </CompanyData>
    <CompanyID>4</CompanyID>
    <ComsGroupID>5</ComsGroupID>
    <ComsTypeID>6</ComsTypeID>
    <DateCreated>2026-10-07T11:49:52.6271277+02:00</DateCreated>
    <Deleted>7</Deleted>
    <LastDays>8</LastDays>
    <Name>sample string 12</Name>
    <RecurringDays>9</RecurringDays>
    <ReturnReasonID>10</ReturnReasonID>
    <TemplateID>11</TemplateID>
    <Type>sample string 13</Type>
    <UserDataListItems>
      <UserData>
        <CompanyKey>sample string 3</CompanyKey>
        <PatientKey>sample string 5</PatientKey>
        <SessionKey>sample string 4</SessionKey>
        <UserKey>sample string 2</UserKey>
        <UserUID>sample string 1</UserUID>
      </UserData>
      <UserData>
        <CompanyKey>sample string 3</CompanyKey>
        <PatientKey>sample string 5</PatientKey>
        <SessionKey>sample string 4</SessionKey>
        <UserKey>sample string 2</UserKey>
        <UserUID>sample string 1</UserUID>
      </UserData>
    </UserDataListItems>
  </JsonCommunicationAlerts>
  <JsonCommunicationAlerts>
    <BranchData>
      <BranchData>
        <BranchName>sample string 1</BranchName>
        <BranchUID>sample string 2</BranchUID>
        <Source>sample string 3</Source>
      </BranchData>
      <BranchData>
        <BranchName>sample string 1</BranchName>
        <BranchUID>sample string 2</BranchUID>
        <Source>sample string 3</Source>
      </BranchData>
    </BranchData>
    <BranchID>2</BranchID>
    <CommunicationAlertId>3</CommunicationAlertId>
    <CompanyData>
      <CompanyData>
        <CompanyName>sample string 1</CompanyName>
        <CompanyUID>sample string 2</CompanyUID>
        <Source>sample string 3</Source>
      </CompanyData>
      <CompanyData>
        <CompanyName>sample string 1</CompanyName>
        <CompanyUID>sample string 2</CompanyUID>
        <Source>sample string 3</Source>
      </CompanyData>
    </CompanyData>
    <CompanyID>4</CompanyID>
    <ComsGroupID>5</ComsGroupID>
    <ComsTypeID>6</ComsTypeID>
    <DateCreated>2026-10-07T11:49:52.6271277+02:00</DateCreated>
    <Deleted>7</Deleted>
    <LastDays>8</LastDays>
    <Name>sample string 12</Name>
    <RecurringDays>9</RecurringDays>
    <ReturnReasonID>10</ReturnReasonID>
    <TemplateID>11</TemplateID>
    <Type>sample string 13</Type>
    <UserDataListItems>
      <UserData>
        <CompanyKey>sample string 3</CompanyKey>
        <PatientKey>sample string 5</PatientKey>
        <SessionKey>sample string 4</SessionKey>
        <UserKey>sample string 2</UserKey>
        <UserUID>sample string 1</UserUID>
      </UserData>
      <UserData>
        <CompanyKey>sample string 3</CompanyKey>
        <PatientKey>sample string 5</PatientKey>
        <SessionKey>sample string 4</SessionKey>
        <UserKey>sample string 2</UserKey>
        <UserUID>sample string 1</UserUID>
      </UserData>
    </UserDataListItems>
  </JsonCommunicationAlerts>
</ArrayOfJsonCommunicationAlerts>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.