POST api/History/SiteAlarmHistory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Date	date	None.
MaxDateTime	date	None.
MinDateTime	date	None.
HighlightDateTime	date	None.
AlarmNum	integer	None.
FunctionName	string	None.
MultiSiteFlag	boolean	None.
SiteNum	integer	None.
DevNum	integer	None.
TransmitterCode	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Date": "2025-12-14T17:42:50.9353285-05:00",
  "MaxDateTime": "2025-12-14T17:42:50.9353285-05:00",
  "MinDateTime": "2025-12-14T17:42:50.9353285-05:00",
  "HighlightDateTime": "2025-12-14T17:42:50.9353285-05:00",
  "AlarmNum": 1,
  "FunctionName": "sample string 1",
  "MultiSiteFlag": true,
  "SiteNum": 1,
  "DevNum": 1,
  "TransmitterCode": "sample string 2",
  "SessionNum": 3,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 4",
  "StagesURL": "sample string 5"
}

application/xml, text/xml

Sample:

<SiteAlarmHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 5</StagesURL>
  <ApplicationCode>sample string 4</ApplicationCode>
  <SessionNum>3</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <SiteNum>1</SiteNum>
  <TransmitterCode>sample string 2</TransmitterCode>
  <AlarmNum>1</AlarmNum>
  <Date>2025-12-14T17:42:50.9353285-05:00</Date>
  <FunctionName>sample string 1</FunctionName>
  <HighlightDateTime>2025-12-14T17:42:50.9353285-05:00</HighlightDateTime>
  <MaxDateTime>2025-12-14T17:42:50.9353285-05:00</MaxDateTime>
  <MinDateTime>2025-12-14T17:42:50.9353285-05:00</MinDateTime>
  <MultiSiteFlag>true</MultiSiteFlag>
</SiteAlarmHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SiteAlarmHistoryQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of SiteAlarmHistoryResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "ActionPlanDescription": "sample string 1",
      "ActionPlanNotesXml": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "ActionPlanNum": 1,
      "ActionPlanType": "sample string 2",
      "ActionPlanVersionNum": 1,
      "AlarmDataFlag": true,
      "AlarmDate": "2025-12-14T17:42:50.9509399-05:00",
      "AlarmDisposition": "sample string 3",
      "AlarmFlag": true,
      "AlarmHistoryGraph": [
        {
          "AlarmNum": 1,
          "StyleCode": "sample string 1"
        },
        {
          "AlarmNum": 1,
          "StyleCode": "sample string 1"
        }
      ],
      "AlarmNum": 1,
      "AppUserNum": 1,
      "ChatFlag": true,
      "ChatNum": 1,
      "Date": "2025-12-14T17:42:50.9509399-05:00",
      "DevNum": 1,
      "EventCode": "sample string 4",
      "EventCodeDescription": "sample string 5",
      "FullClearDate": "2025-12-14T17:42:50.9509399-05:00",
      "FunctionOption": "sample string 6",
      "GPSFlag": true,
      "GuardReportFunction": "sample string 7",
      "JobNum": 1,
      "JobReason": "sample string 8",
      "JobType": "sample string 9",
      "JobTypeDescription": "sample string 10",
      "MultiSiteFlag": true,
      "Point": "sample string 11",
      "Priority": 1,
      "Prompt": "sample string 12",
      "PullDownDate": "2025-12-14T17:42:50.9509399-05:00",
      "PullDownTime": "sample string 13",
      "Reference": "sample string 14",
      "ShortAlarmNum": 1,
      "ShortName": "sample string 15",
      "SiteName": "sample string 16",
      "SiteNum": 1,
      "StyleCode2": "sample string 17",
      "TitleSiteName": "sample string 18",
      "TransmitterCode": "sample string 19",
      "VariationNum": 1,
      "HandleTime": "sample string 20",
      "TimeToFirstAction": "sample string 21"
    },
    {
      "ActionPlanDescription": "sample string 1",
      "ActionPlanNotesXml": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "ActionPlanNum": 1,
      "ActionPlanType": "sample string 2",
      "ActionPlanVersionNum": 1,
      "AlarmDataFlag": true,
      "AlarmDate": "2025-12-14T17:42:50.9509399-05:00",
      "AlarmDisposition": "sample string 3",
      "AlarmFlag": true,
      "AlarmHistoryGraph": [
        {
          "AlarmNum": 1,
          "StyleCode": "sample string 1"
        },
        {
          "AlarmNum": 1,
          "StyleCode": "sample string 1"
        }
      ],
      "AlarmNum": 1,
      "AppUserNum": 1,
      "ChatFlag": true,
      "ChatNum": 1,
      "Date": "2025-12-14T17:42:50.9509399-05:00",
      "DevNum": 1,
      "EventCode": "sample string 4",
      "EventCodeDescription": "sample string 5",
      "FullClearDate": "2025-12-14T17:42:50.9509399-05:00",
      "FunctionOption": "sample string 6",
      "GPSFlag": true,
      "GuardReportFunction": "sample string 7",
      "JobNum": 1,
      "JobReason": "sample string 8",
      "JobType": "sample string 9",
      "JobTypeDescription": "sample string 10",
      "MultiSiteFlag": true,
      "Point": "sample string 11",
      "Priority": 1,
      "Prompt": "sample string 12",
      "PullDownDate": "2025-12-14T17:42:50.9509399-05:00",
      "PullDownTime": "sample string 13",
      "Reference": "sample string 14",
      "ShortAlarmNum": 1,
      "ShortName": "sample string 15",
      "SiteName": "sample string 16",
      "SiteNum": 1,
      "StyleCode2": "sample string 17",
      "TitleSiteName": "sample string 18",
      "TransmitterCode": "sample string 19",
      "VariationNum": 1,
      "HandleTime": "sample string 20",
      "TimeToFirstAction": "sample string 21"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<SiteAlarmHistoryQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <SiteAlarmHistoryResult>
      <ActionPlanDescription>sample string 1</ActionPlanDescription>
      <ActionPlanNotesXml>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </ActionPlanNotesXml>
      <ActionPlanNum>1</ActionPlanNum>
      <ActionPlanType>sample string 2</ActionPlanType>
      <ActionPlanVersionNum>1</ActionPlanVersionNum>
      <AlarmDataFlag>true</AlarmDataFlag>
      <AlarmDate>2025-12-14T17:42:50.9509399-05:00</AlarmDate>
      <AlarmDisposition>sample string 3</AlarmDisposition>
      <AlarmFlag>true</AlarmFlag>
      <AlarmHistoryGraph>
        <AlarmHistoryGraphRow>
          <AlarmNum>1</AlarmNum>
          <StyleCode>sample string 1</StyleCode>
        </AlarmHistoryGraphRow>
        <AlarmHistoryGraphRow>
          <AlarmNum>1</AlarmNum>
          <StyleCode>sample string 1</StyleCode>
        </AlarmHistoryGraphRow>
      </AlarmHistoryGraph>
      <AlarmNum>1</AlarmNum>
      <AppUserNum>1</AppUserNum>
      <ChatFlag>true</ChatFlag>
      <ChatNum>1</ChatNum>
      <Date>2025-12-14T17:42:50.9509399-05:00</Date>
      <DevNum>1</DevNum>
      <EventCode>sample string 4</EventCode>
      <EventCodeDescription>sample string 5</EventCodeDescription>
      <FullClearDate>2025-12-14T17:42:50.9509399-05:00</FullClearDate>
      <FunctionOption>sample string 6</FunctionOption>
      <GPSFlag>true</GPSFlag>
      <GuardReportFunction>sample string 7</GuardReportFunction>
      <HandleTime>sample string 20</HandleTime>
      <JobNum>1</JobNum>
      <JobReason>sample string 8</JobReason>
      <JobType>sample string 9</JobType>
      <JobTypeDescription>sample string 10</JobTypeDescription>
      <MultiSiteFlag>true</MultiSiteFlag>
      <Point>sample string 11</Point>
      <Priority>1</Priority>
      <Prompt>sample string 12</Prompt>
      <PullDownDate>2025-12-14T17:42:50.9509399-05:00</PullDownDate>
      <PullDownTime>sample string 13</PullDownTime>
      <Reference>sample string 14</Reference>
      <ShortAlarmNum>1</ShortAlarmNum>
      <ShortName>sample string 15</ShortName>
      <SiteName>sample string 16</SiteName>
      <SiteNum>1</SiteNum>
      <StyleCode2>sample string 17</StyleCode2>
      <TimeToFirstAction>sample string 21</TimeToFirstAction>
      <TitleSiteName>sample string 18</TitleSiteName>
      <TransmitterCode>sample string 19</TransmitterCode>
      <VariationNum>1</VariationNum>
    </SiteAlarmHistoryResult>
    <SiteAlarmHistoryResult>
      <ActionPlanDescription>sample string 1</ActionPlanDescription>
      <ActionPlanNotesXml>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </ActionPlanNotesXml>
      <ActionPlanNum>1</ActionPlanNum>
      <ActionPlanType>sample string 2</ActionPlanType>
      <ActionPlanVersionNum>1</ActionPlanVersionNum>
      <AlarmDataFlag>true</AlarmDataFlag>
      <AlarmDate>2025-12-14T17:42:50.9509399-05:00</AlarmDate>
      <AlarmDisposition>sample string 3</AlarmDisposition>
      <AlarmFlag>true</AlarmFlag>
      <AlarmHistoryGraph>
        <AlarmHistoryGraphRow>
          <AlarmNum>1</AlarmNum>
          <StyleCode>sample string 1</StyleCode>
        </AlarmHistoryGraphRow>
        <AlarmHistoryGraphRow>
          <AlarmNum>1</AlarmNum>
          <StyleCode>sample string 1</StyleCode>
        </AlarmHistoryGraphRow>
      </AlarmHistoryGraph>
      <AlarmNum>1</AlarmNum>
      <AppUserNum>1</AppUserNum>
      <ChatFlag>true</ChatFlag>
      <ChatNum>1</ChatNum>
      <Date>2025-12-14T17:42:50.9509399-05:00</Date>
      <DevNum>1</DevNum>
      <EventCode>sample string 4</EventCode>
      <EventCodeDescription>sample string 5</EventCodeDescription>
      <FullClearDate>2025-12-14T17:42:50.9509399-05:00</FullClearDate>
      <FunctionOption>sample string 6</FunctionOption>
      <GPSFlag>true</GPSFlag>
      <GuardReportFunction>sample string 7</GuardReportFunction>
      <HandleTime>sample string 20</HandleTime>
      <JobNum>1</JobNum>
      <JobReason>sample string 8</JobReason>
      <JobType>sample string 9</JobType>
      <JobTypeDescription>sample string 10</JobTypeDescription>
      <MultiSiteFlag>true</MultiSiteFlag>
      <Point>sample string 11</Point>
      <Priority>1</Priority>
      <Prompt>sample string 12</Prompt>
      <PullDownDate>2025-12-14T17:42:50.9509399-05:00</PullDownDate>
      <PullDownTime>sample string 13</PullDownTime>
      <Reference>sample string 14</Reference>
      <ShortAlarmNum>1</ShortAlarmNum>
      <ShortName>sample string 15</ShortName>
      <SiteName>sample string 16</SiteName>
      <SiteNum>1</SiteNum>
      <StyleCode2>sample string 17</StyleCode2>
      <TimeToFirstAction>sample string 21</TimeToFirstAction>
      <TitleSiteName>sample string 18</TitleSiteName>
      <TransmitterCode>sample string 19</TransmitterCode>
      <VariationNum>1</VariationNum>
    </SiteAlarmHistoryResult>
  </ResultSet>
</SiteAlarmHistoryQueryResult>