POST Notification/PostNotification

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
model 
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "WebPortalKey": 2,
  "NotificationText": "sample string 3",
  "NotificationIcon": "sample string 4",
  "LoginTypeBitmask": 5,
  "DisplayOrder": 6,
  "DisplayStartTime": "2026-02-03T19:28:38.2619905-06:00",
  "DisplayEndTime": "2026-02-03T19:28:38.2619905-06:00",
  "CreateDate": "2026-02-03T19:28:38.2619905-06:00",
  "WhoLastChanged": "sample string 9",
  "WhenLastChanged": "2026-02-03T19:28:38.2619905-06:00",
  "NotificationTitle": "sample string 11",
  "portal": {
    "webPortalKey": 1,
    "friendlyName": "sample string 2",
    "displayName": "sample string 3",
    "contentPath": "sample string 4",
    "uploadPath": "sample string 5",
    "landingPageURL": "sample string 6",
    "DefaultLayoutPage": "sample string 7",
    "nextPublishDate": "2026-02-03T19:28:38.2619905-06:00",
    "isActive": true,
    "pageTitle": "sample string 10",
    "NotificationsActive": true,
    "NotificationAddress": "sample string 12",
    "PortalDetails": [
      {
        "Id": 1,
        "webPortalKey": 2,
        "FriendlyName": "sample string 3",
        "OwnerDesc": "sample string 4",
        "ownerType": 5,
        "ownerTypeValueId": 6,
        "ownerKey": 7,
        "nextPublishDate": "2026-02-03T19:28:38.2619905-06:00",
        "isActive": true,
        "IncludeChildAff": true,
        "AllowEnrollment": true,
        "NotificationsActive": true,
        "AuthCode": "sample string 13",
        "NotificationAddress": "sample string 14"
      },
      {
        "Id": 1,
        "webPortalKey": 2,
        "FriendlyName": "sample string 3",
        "OwnerDesc": "sample string 4",
        "ownerType": 5,
        "ownerTypeValueId": 6,
        "ownerKey": 7,
        "nextPublishDate": "2026-02-03T19:28:38.2619905-06:00",
        "isActive": true,
        "IncludeChildAff": true,
        "AllowEnrollment": true,
        "NotificationsActive": true,
        "AuthCode": "sample string 13",
        "NotificationAddress": "sample string 14"
      },
      {
        "Id": 1,
        "webPortalKey": 2,
        "FriendlyName": "sample string 3",
        "OwnerDesc": "sample string 4",
        "ownerType": 5,
        "ownerTypeValueId": 6,
        "ownerKey": 7,
        "nextPublishDate": "2026-02-03T19:28:38.2619905-06:00",
        "isActive": true,
        "IncludeChildAff": true,
        "AllowEnrollment": true,
        "NotificationsActive": true,
        "AuthCode": "sample string 13",
        "NotificationAddress": "sample string 14"
      }
    ],
    "PortalConfigurations": [
      {
        "Id": 1,
        "webPortalKey": 2,
        "configurationTypeDesc": "sample string 3",
        "ConfigurationTypeValueID": 4,
        "configurationValue": "sample string 5"
      },
      {
        "Id": 1,
        "webPortalKey": 2,
        "configurationTypeDesc": "sample string 3",
        "ConfigurationTypeValueID": 4,
        "configurationValue": "sample string 5"
      },
      {
        "Id": 1,
        "webPortalKey": 2,
        "configurationTypeDesc": "sample string 3",
        "ConfigurationTypeValueID": 4,
        "configurationValue": "sample string 5"
      }
    ],
    "DuplicateUser": 13
  },
  "NotificationDivClass": "sample string 12",
  "ColumnCount": 13,
  "notificationType": 1,
  "LastChanged": "sample string 9 - 02/03/2026"
}

application/xml, text/xml

Sample: 
<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <ColumnCount>13</ColumnCount>
  <CreateDate>2026-02-03T19:28:38.2619905-06:00</CreateDate>
  <DisplayEndTime>2026-02-03T19:28:38.2619905-06:00</DisplayEndTime>
  <DisplayOrder>6</DisplayOrder>
  <DisplayStartTime>2026-02-03T19:28:38.2619905-06:00</DisplayStartTime>
  <Id>1</Id>
  <LoginTypeBitmask>5</LoginTypeBitmask>
  <NotificationDivClass>sample string 12</NotificationDivClass>
  <NotificationIcon>sample string 4</NotificationIcon>
  <NotificationText>sample string 3</NotificationText>
  <NotificationTitle>sample string 11</NotificationTitle>
  <WebPortalKey>2</WebPortalKey>
  <WhenLastChanged>2026-02-03T19:28:38.2619905-06:00</WhenLastChanged>
  <WhoLastChanged>sample string 9</WhoLastChanged>
  <notificationType>Standard</notificationType>
  <portal>
    <DefaultLayoutPage>sample string 7</DefaultLayoutPage>
    <DuplicateUser>13</DuplicateUser>
    <NotificationAddress>sample string 12</NotificationAddress>
    <NotificationsActive>true</NotificationsActive>
    <PortalConfigurations>
      <WebPortalConfiguration>
        <ConfigurationTypeValueID>4</ConfigurationTypeValueID>
        <Id>1</Id>
        <configurationTypeDesc>sample string 3</configurationTypeDesc>
        <configurationValue>sample string 5</configurationValue>
        <webPortalKey>2</webPortalKey>
      </WebPortalConfiguration>
      <WebPortalConfiguration>
        <ConfigurationTypeValueID>4</ConfigurationTypeValueID>
        <Id>1</Id>
        <configurationTypeDesc>sample string 3</configurationTypeDesc>
        <configurationValue>sample string 5</configurationValue>
        <webPortalKey>2</webPortalKey>
      </WebPortalConfiguration>
      <WebPortalConfiguration>
        <ConfigurationTypeValueID>4</ConfigurationTypeValueID>
        <Id>1</Id>
        <configurationTypeDesc>sample string 3</configurationTypeDesc>
        <configurationValue>sample string 5</configurationValue>
        <webPortalKey>2</webPortalKey>
      </WebPortalConfiguration>
    </PortalConfigurations>
    <PortalDetails>
      <WebPortalDetail>
        <AllowEnrollment>true</AllowEnrollment>
        <AuthCode>sample string 13</AuthCode>
        <FriendlyName>sample string 3</FriendlyName>
        <Id>1</Id>
        <IncludeChildAff>true</IncludeChildAff>
        <NotificationAddress>sample string 14</NotificationAddress>
        <NotificationsActive>true</NotificationsActive>
        <OwnerDesc>sample string 4</OwnerDesc>
        <isActive>true</isActive>
        <nextPublishDate>2026-02-03T19:28:38.2619905-06:00</nextPublishDate>
        <ownerKey>7</ownerKey>
        <ownerType>5</ownerType>
        <ownerTypeValueId>6</ownerTypeValueId>
        <webPortalKey>2</webPortalKey>
      </WebPortalDetail>
      <WebPortalDetail>
        <AllowEnrollment>true</AllowEnrollment>
        <AuthCode>sample string 13</AuthCode>
        <FriendlyName>sample string 3</FriendlyName>
        <Id>1</Id>
        <IncludeChildAff>true</IncludeChildAff>
        <NotificationAddress>sample string 14</NotificationAddress>
        <NotificationsActive>true</NotificationsActive>
        <OwnerDesc>sample string 4</OwnerDesc>
        <isActive>true</isActive>
        <nextPublishDate>2026-02-03T19:28:38.2619905-06:00</nextPublishDate>
        <ownerKey>7</ownerKey>
        <ownerType>5</ownerType>
        <ownerTypeValueId>6</ownerTypeValueId>
        <webPortalKey>2</webPortalKey>
      </WebPortalDetail>
      <WebPortalDetail>
        <AllowEnrollment>true</AllowEnrollment>
        <AuthCode>sample string 13</AuthCode>
        <FriendlyName>sample string 3</FriendlyName>
        <Id>1</Id>
        <IncludeChildAff>true</IncludeChildAff>
        <NotificationAddress>sample string 14</NotificationAddress>
        <NotificationsActive>true</NotificationsActive>
        <OwnerDesc>sample string 4</OwnerDesc>
        <isActive>true</isActive>
        <nextPublishDate>2026-02-03T19:28:38.2619905-06:00</nextPublishDate>
        <ownerKey>7</ownerKey>
        <ownerType>5</ownerType>
        <ownerTypeValueId>6</ownerTypeValueId>
        <webPortalKey>2</webPortalKey>
      </WebPortalDetail>
    </PortalDetails>
    <contentPath>sample string 4</contentPath>
    <displayName>sample string 3</displayName>
    <friendlyName>sample string 2</friendlyName>
    <isActive>true</isActive>
    <landingPageURL>sample string 6</landingPageURL>
    <nextPublishDate>2026-02-03T19:28:38.2619905-06:00</nextPublishDate>
    <pageTitle>sample string 10</pageTitle>
    <uploadPath>sample string 5</uploadPath>
    <webPortalKey>1</webPortalKey>
  </portal>
</Notification>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

No documentation available.

Response body formats

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

Sample:

Sample not available.