POST Api/AppriseAlert/AddOrUpdateAppriseAlert

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HDR_ALERT_ID	decimal number	None.
HDR_ALERT_SYSTEM_FROM_PHONE	string	None.
HDR_MESSAGE	string	None.
HDR_SUBJECT	string	None.
HDR_ALERT_Scheduled_Date	date	None.
HDR_ALERT_TYPE	string	None.
HDR_ALERT_VOICE_GENDER	string	None.
HDR_ALERT_VOICE_OPTION	decimal number	None.
HDR_CLASSROOM	string	None.
HDR_FAMILIES	integer	None.
HDR_BUSES	integer	None.
HDR_EMPLOYEES	integer	None.
HDR_NONEMPLOYEES	integer	None.
HDR_FAVORITE	integer	None.
HDR_SEND_TEXT	integer	None.
HDR_SEND_VOICE	integer	None.
HDR_SEND_CHAT	integer	None.
HDR_SEND_EMAIL	integer	None.
HDR_AMD_TYPE	string	None.
HDR_AppriseGreeting	string	None.
HDR_GROUP	decimal number	None.
HDR_DISTRICTCASE	integer	None.
CampusName	string	None.
UserID	string	None.
DeviceID	string	None.
DeviceOS	string	None.
Version	string	None.
accessToken	string	Required Matching regular expression pattern: ^a4768b1a-b5c1-4561-86e7-324b8a368354$

Request Formats

application/json, text/json

Sample:

{
  "HDR_ALERT_ID": 1.0,
  "HDR_ALERT_SYSTEM_FROM_PHONE": "sample string 2",
  "HDR_MESSAGE": "sample string 3",
  "HDR_SUBJECT": "sample string 4",
  "HDR_ALERT_Scheduled_Date": "2025-05-31T22:17:37.5096996-04:00",
  "HDR_ALERT_TYPE": "sample string 5",
  "HDR_ALERT_VOICE_GENDER": "sample string 6",
  "HDR_ALERT_VOICE_OPTION": 1.0,
  "HDR_CLASSROOM": "sample string 7",
  "HDR_FAMILIES": 1,
  "HDR_BUSES": 1,
  "HDR_EMPLOYEES": 1,
  "HDR_NONEMPLOYEES": 1,
  "HDR_FAVORITE": 1,
  "HDR_SEND_TEXT": 1,
  "HDR_SEND_VOICE": 1,
  "HDR_SEND_CHAT": 1,
  "HDR_SEND_EMAIL": 1,
  "HDR_AMD_TYPE": "sample string 8",
  "HDR_AppriseGreeting": "sample string 9",
  "HDR_GROUP": 1.0,
  "HDR_DISTRICTCASE": 1,
  "CampusName": "sample string 10",
  "UserID": "sample string 11",
  "DeviceID": "sample string 12",
  "DeviceOS": "sample string 13",
  "Version": "sample string 14",
  "accessToken": "sample string 15"
}

text/html

Sample:

{"HDR_ALERT_ID":1.0,"HDR_ALERT_SYSTEM_FROM_PHONE":"sample string 2","HDR_MESSAGE":"sample string 3","HDR_SUBJECT":"sample string 4","HDR_ALERT_Scheduled_Date":"2025-05-31T22:17:37.5096996-04:00","HDR_ALERT_TYPE":"sample string 5","HDR_ALERT_VOICE_GENDER":"sample string 6","HDR_ALERT_VOICE_OPTION":1.0,"HDR_CLASSROOM":"sample string 7","HDR_FAMILIES":1,"HDR_BUSES":1,"HDR_EMPLOYEES":1,"HDR_NONEMPLOYEES":1,"HDR_FAVORITE":1,"HDR_SEND_TEXT":1,"HDR_SEND_VOICE":1,"HDR_SEND_CHAT":1,"HDR_SEND_EMAIL":1,"HDR_AMD_TYPE":"sample string 8","HDR_AppriseGreeting":"sample string 9","HDR_GROUP":1.0,"HDR_DISTRICTCASE":1,"CampusName":"sample string 10","UserID":"sample string 11","DeviceID":"sample string 12","DeviceOS":"sample string 13","Version":"sample string 14","accessToken":"sample string 15"}

application/xml, text/xml

Sample:

<All_Alert_Message_HDRViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
  <CampusName>sample string 10</CampusName>
  <DeviceID>sample string 12</DeviceID>
  <DeviceOS>sample string 13</DeviceOS>
  <UserID>sample string 11</UserID>
  <Version>sample string 14</Version>
  <accessToken>sample string 15</accessToken>
  <HDR_ALERT_ID>1</HDR_ALERT_ID>
  <HDR_ALERT_SYSTEM_FROM_PHONE>sample string 2</HDR_ALERT_SYSTEM_FROM_PHONE>
  <HDR_ALERT_Scheduled_Date>2025-05-31T22:17:37.5096996-04:00</HDR_ALERT_Scheduled_Date>
  <HDR_ALERT_TYPE>sample string 5</HDR_ALERT_TYPE>
  <HDR_ALERT_VOICE_GENDER>sample string 6</HDR_ALERT_VOICE_GENDER>
  <HDR_ALERT_VOICE_OPTION>1</HDR_ALERT_VOICE_OPTION>
  <HDR_AMD_TYPE>sample string 8</HDR_AMD_TYPE>
  <HDR_AppriseGreeting>sample string 9</HDR_AppriseGreeting>
  <HDR_BUSES>1</HDR_BUSES>
  <HDR_CLASSROOM>sample string 7</HDR_CLASSROOM>
  <HDR_DISTRICTCASE>1</HDR_DISTRICTCASE>
  <HDR_EMPLOYEES>1</HDR_EMPLOYEES>
  <HDR_FAMILIES>1</HDR_FAMILIES>
  <HDR_FAVORITE>1</HDR_FAVORITE>
  <HDR_GROUP>1</HDR_GROUP>
  <HDR_MESSAGE>sample string 3</HDR_MESSAGE>
  <HDR_NONEMPLOYEES>1</HDR_NONEMPLOYEES>
  <HDR_SEND_CHAT>1</HDR_SEND_CHAT>
  <HDR_SEND_EMAIL>1</HDR_SEND_EMAIL>
  <HDR_SEND_TEXT>1</HDR_SEND_TEXT>
  <HDR_SEND_VOICE>1</HDR_SEND_VOICE>
  <HDR_SUBJECT>sample string 4</HDR_SUBJECT>
</All_Alert_Message_HDRViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />