POST api/History/AlarmHistoryEventList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FunctionName	string	None.
InputDateTime	date	None.
IncludeOpActFlag	boolean	None.
ReportCodeList	Collection of ReportCodeListRow	None.
AreaNum	integer	None.
MaxLines	integer	None.
SelectXmit	string	None.
SiteNum	integer	None.
DevNum	integer	None.
AlarmNum	integer	None.
MaxDateTime	date	None.
MinDateTime	date	None.
HighlightDateTime	date	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FunctionName": "sample string 1",
  "InputDateTime": "2025-05-03T23:13:14.359362-07:00",
  "IncludeOpActFlag": true,
  "ReportCodeList": [
    {
      "ReportCode": "sample string 1",
      "SelectedFlag": true
    },
    {
      "ReportCode": "sample string 1",
      "SelectedFlag": true
    }
  ],
  "AreaNum": 1,
  "MaxLines": 1,
  "SelectXmit": "sample string 2",
  "SiteNum": 1,
  "DevNum": 1,
  "AlarmNum": 1,
  "MaxDateTime": "2025-05-03T23:13:14.359362-07:00",
  "MinDateTime": "2025-05-03T23:13:14.359362-07:00",
  "HighlightDateTime": "2025-05-03T23:13:14.359362-07:00",
  "SessionNum": 3,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 4",
  "StagesURL": "sample string 5"
}

application/xml, text/xml

Sample:

<HistoryRequest 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>
  <AlarmNum>1</AlarmNum>
  <AreaNum>1</AreaNum>
  <DevNum>1</DevNum>
  <FunctionName>sample string 1</FunctionName>
  <HighlightDateTime>2025-05-03T23:13:14.359362-07:00</HighlightDateTime>
  <IncludeOpActFlag>true</IncludeOpActFlag>
  <InputDateTime>2025-05-03T23:13:14.359362-07:00</InputDateTime>
  <MaxDateTime>2025-05-03T23:13:14.359362-07:00</MaxDateTime>
  <MaxLines>1</MaxLines>
  <MinDateTime>2025-05-03T23:13:14.359362-07:00</MinDateTime>
  <ReportCodeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages">
    <d2p1:ReportCodeListRow>
      <d2p1:ReportCode>sample string 1</d2p1:ReportCode>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
    </d2p1:ReportCodeListRow>
    <d2p1:ReportCodeListRow>
      <d2p1:ReportCode>sample string 1</d2p1:ReportCode>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
    </d2p1:ReportCodeListRow>
  </ReportCodeList>
  <SelectXmit>sample string 2</SelectXmit>
  <SiteNum>1</SiteNum>
</HistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AlarmHistoryEventListQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of AlarmHistoryEventListResult	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": [
    {
      "ActionPlanFlag": true,
      "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"
              }
            ]
          }
        ]
      },
      "AdditionalDescription": "sample string 1",
      "AlarmDisposition": "sample string 2",
      "AlarmNum": 1,
      "AlarmNumOrTest": "sample string 3",
      "AlternateSiteName": "sample string 4",
      "AreaNum": 1,
      "BackgroundStyle": "sample string 5",
      "BreakStyle": "sample string 6",
      "CommunicationTime": "sample string 7",
      "DayofWeek": "sample string 8",
      "DisplayDelay": "sample string 9",
      "Elapsed": "sample string 10",
      "EventOpAct": "sample string 11",
      "FullClearFlag": true,
      "FunctionOption": "sample string 12",
      "HistoryActPlan": "sample string 13",
      "HistoryComment": "sample string 14",
      "HistoryCommentBig": "sample string 15",
      "HistoryDate": "2025-05-03T23:13:14.3749881-07:00",
      "HistoryDeviceDate": "2025-05-03T23:13:14.3749881-07:00",
      "HistorySeqNum": "sample string 16",
      "Line": "sample string 17",
      "MapFlag": "sample string 18",
      "MapURL": "sample string 19",
      "NewEvent": "sample string 20",
      "PartialClearPriority": 1,
      "Phone": "sample string 21",
      "Point": "sample string 22",
      "PointDescription": "sample string 23",
      "PointFlyout": "sample string 24",
      "RawMessage": "sample string 25",
      "ReceiveDate": "2025-05-03T23:13:14.3749881-07:00",
      "ScheduledDate": "2025-05-03T23:13:14.3749881-07:00",
      "ServerNum": 1,
      "ShortName": "sample string 26",
      "SigForm": "sample string 27",
      "SignalCode": "sample string 28",
      "SignalCodeDescription": "sample string 29",
      "SignalRuleDetails": "sample string 30",
      "SignalRuleNum": 1,
      "SignalStatus": "sample string 31",
      "StyleCode": "sample string 32",
      "StyleCode2": "sample string 33",
      "TaskNum": 1,
      "TestDetails": "sample string 34",
      "TestEffectiveDate": "2025-05-03T23:13:14.3749881-07:00",
      "TestExpireDate": "2025-05-03T23:13:14.3749881-07:00",
      "TransmitterCode": "sample string 35",
      "UserName": "sample string 36",
      "VideoFileNum": 1,
      "VideoPassword": "sample string 37",
      "WorkStation": "sample string 38",
      "AreaDescription": "sample string 39",
      "ModuleSubTypeDescription": "sample string 40",
      "ModuleTypeDescription": "sample string 41",
      "NodeTypeDescription": "sample string 42",
      "PointSubTypeDescription": "sample string 43",
      "PointTypeDescription": "sample string 44",
      "EventTroubleStatusDescription": "sample string 45",
      "PointFunction": "sample string 46"
    },
    {
      "ActionPlanFlag": true,
      "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"
              }
            ]
          }
        ]
      },
      "AdditionalDescription": "sample string 1",
      "AlarmDisposition": "sample string 2",
      "AlarmNum": 1,
      "AlarmNumOrTest": "sample string 3",
      "AlternateSiteName": "sample string 4",
      "AreaNum": 1,
      "BackgroundStyle": "sample string 5",
      "BreakStyle": "sample string 6",
      "CommunicationTime": "sample string 7",
      "DayofWeek": "sample string 8",
      "DisplayDelay": "sample string 9",
      "Elapsed": "sample string 10",
      "EventOpAct": "sample string 11",
      "FullClearFlag": true,
      "FunctionOption": "sample string 12",
      "HistoryActPlan": "sample string 13",
      "HistoryComment": "sample string 14",
      "HistoryCommentBig": "sample string 15",
      "HistoryDate": "2025-05-03T23:13:14.3749881-07:00",
      "HistoryDeviceDate": "2025-05-03T23:13:14.3749881-07:00",
      "HistorySeqNum": "sample string 16",
      "Line": "sample string 17",
      "MapFlag": "sample string 18",
      "MapURL": "sample string 19",
      "NewEvent": "sample string 20",
      "PartialClearPriority": 1,
      "Phone": "sample string 21",
      "Point": "sample string 22",
      "PointDescription": "sample string 23",
      "PointFlyout": "sample string 24",
      "RawMessage": "sample string 25",
      "ReceiveDate": "2025-05-03T23:13:14.3749881-07:00",
      "ScheduledDate": "2025-05-03T23:13:14.3749881-07:00",
      "ServerNum": 1,
      "ShortName": "sample string 26",
      "SigForm": "sample string 27",
      "SignalCode": "sample string 28",
      "SignalCodeDescription": "sample string 29",
      "SignalRuleDetails": "sample string 30",
      "SignalRuleNum": 1,
      "SignalStatus": "sample string 31",
      "StyleCode": "sample string 32",
      "StyleCode2": "sample string 33",
      "TaskNum": 1,
      "TestDetails": "sample string 34",
      "TestEffectiveDate": "2025-05-03T23:13:14.3749881-07:00",
      "TestExpireDate": "2025-05-03T23:13:14.3749881-07:00",
      "TransmitterCode": "sample string 35",
      "UserName": "sample string 36",
      "VideoFileNum": 1,
      "VideoPassword": "sample string 37",
      "WorkStation": "sample string 38",
      "AreaDescription": "sample string 39",
      "ModuleSubTypeDescription": "sample string 40",
      "ModuleTypeDescription": "sample string 41",
      "NodeTypeDescription": "sample string 42",
      "PointSubTypeDescription": "sample string 43",
      "PointTypeDescription": "sample string 44",
      "EventTroubleStatusDescription": "sample string 45",
      "PointFunction": "sample string 46"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<AlarmHistoryEventListQueryResult 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>
    <AlarmHistoryEventListResult>
      <ActionPlanFlag>true</ActionPlanFlag>
      <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>
      <AdditionalDescription>sample string 1</AdditionalDescription>
      <AlarmDisposition>sample string 2</AlarmDisposition>
      <AlarmNum>1</AlarmNum>
      <AlarmNumOrTest>sample string 3</AlarmNumOrTest>
      <AlternateSiteName>sample string 4</AlternateSiteName>
      <AreaDescription>sample string 39</AreaDescription>
      <AreaNum>1</AreaNum>
      <BackgroundStyle>sample string 5</BackgroundStyle>
      <BreakStyle>sample string 6</BreakStyle>
      <CommunicationTime>sample string 7</CommunicationTime>
      <DayofWeek>sample string 8</DayofWeek>
      <DisplayDelay>sample string 9</DisplayDelay>
      <Elapsed>sample string 10</Elapsed>
      <EventOpAct>sample string 11</EventOpAct>
      <EventTroubleStatusDescription>sample string 45</EventTroubleStatusDescription>
      <FullClearFlag>true</FullClearFlag>
      <FunctionOption>sample string 12</FunctionOption>
      <HistoryActPlan>sample string 13</HistoryActPlan>
      <HistoryComment>sample string 14</HistoryComment>
      <HistoryCommentBig>sample string 15</HistoryCommentBig>
      <HistoryDate>2025-05-03T23:13:14.3749881-07:00</HistoryDate>
      <HistoryDeviceDate>2025-05-03T23:13:14.3749881-07:00</HistoryDeviceDate>
      <HistorySeqNum>sample string 16</HistorySeqNum>
      <Line>sample string 17</Line>
      <MapFlag>sample string 18</MapFlag>
      <MapURL>sample string 19</MapURL>
      <ModuleSubTypeDescription>sample string 40</ModuleSubTypeDescription>
      <ModuleTypeDescription>sample string 41</ModuleTypeDescription>
      <NewEvent>sample string 20</NewEvent>
      <NodeTypeDescription>sample string 42</NodeTypeDescription>
      <PartialClearPriority>1</PartialClearPriority>
      <Phone>sample string 21</Phone>
      <Point>sample string 22</Point>
      <PointDescription>sample string 23</PointDescription>
      <PointFlyout>sample string 24</PointFlyout>
      <PointFunction>sample string 46</PointFunction>
      <PointSubTypeDescription>sample string 43</PointSubTypeDescription>
      <PointTypeDescription>sample string 44</PointTypeDescription>
      <RawMessage>sample string 25</RawMessage>
      <ReceiveDate>2025-05-03T23:13:14.3749881-07:00</ReceiveDate>
      <ScheduledDate>2025-05-03T23:13:14.3749881-07:00</ScheduledDate>
      <ServerNum>1</ServerNum>
      <ShortName>sample string 26</ShortName>
      <SigForm>sample string 27</SigForm>
      <SignalCode>sample string 28</SignalCode>
      <SignalCodeDescription>sample string 29</SignalCodeDescription>
      <SignalRuleDetails>sample string 30</SignalRuleDetails>
      <SignalRuleNum>1</SignalRuleNum>
      <SignalStatus>sample string 31</SignalStatus>
      <StyleCode>sample string 32</StyleCode>
      <StyleCode2>sample string 33</StyleCode2>
      <TaskNum>1</TaskNum>
      <TestDetails>sample string 34</TestDetails>
      <TestEffectiveDate>2025-05-03T23:13:14.3749881-07:00</TestEffectiveDate>
      <TestExpireDate>2025-05-03T23:13:14.3749881-07:00</TestExpireDate>
      <TransmitterCode>sample string 35</TransmitterCode>
      <UserName>sample string 36</UserName>
      <VideoFileNum>1</VideoFileNum>
      <VideoPassword>sample string 37</VideoPassword>
      <WorkStation>sample string 38</WorkStation>
    </AlarmHistoryEventListResult>
    <AlarmHistoryEventListResult>
      <ActionPlanFlag>true</ActionPlanFlag>
      <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>
      <AdditionalDescription>sample string 1</AdditionalDescription>
      <AlarmDisposition>sample string 2</AlarmDisposition>
      <AlarmNum>1</AlarmNum>
      <AlarmNumOrTest>sample string 3</AlarmNumOrTest>
      <AlternateSiteName>sample string 4</AlternateSiteName>
      <AreaDescription>sample string 39</AreaDescription>
      <AreaNum>1</AreaNum>
      <BackgroundStyle>sample string 5</BackgroundStyle>
      <BreakStyle>sample string 6</BreakStyle>
      <CommunicationTime>sample string 7</CommunicationTime>
      <DayofWeek>sample string 8</DayofWeek>
      <DisplayDelay>sample string 9</DisplayDelay>
      <Elapsed>sample string 10</Elapsed>
      <EventOpAct>sample string 11</EventOpAct>
      <EventTroubleStatusDescription>sample string 45</EventTroubleStatusDescription>
      <FullClearFlag>true</FullClearFlag>
      <FunctionOption>sample string 12</FunctionOption>
      <HistoryActPlan>sample string 13</HistoryActPlan>
      <HistoryComment>sample string 14</HistoryComment>
      <HistoryCommentBig>sample string 15</HistoryCommentBig>
      <HistoryDate>2025-05-03T23:13:14.3749881-07:00</HistoryDate>
      <HistoryDeviceDate>2025-05-03T23:13:14.3749881-07:00</HistoryDeviceDate>
      <HistorySeqNum>sample string 16</HistorySeqNum>
      <Line>sample string 17</Line>
      <MapFlag>sample string 18</MapFlag>
      <MapURL>sample string 19</MapURL>
      <ModuleSubTypeDescription>sample string 40</ModuleSubTypeDescription>
      <ModuleTypeDescription>sample string 41</ModuleTypeDescription>
      <NewEvent>sample string 20</NewEvent>
      <NodeTypeDescription>sample string 42</NodeTypeDescription>
      <PartialClearPriority>1</PartialClearPriority>
      <Phone>sample string 21</Phone>
      <Point>sample string 22</Point>
      <PointDescription>sample string 23</PointDescription>
      <PointFlyout>sample string 24</PointFlyout>
      <PointFunction>sample string 46</PointFunction>
      <PointSubTypeDescription>sample string 43</PointSubTypeDescription>
      <PointTypeDescription>sample string 44</PointTypeDescription>
      <RawMessage>sample string 25</RawMessage>
      <ReceiveDate>2025-05-03T23:13:14.3749881-07:00</ReceiveDate>
      <ScheduledDate>2025-05-03T23:13:14.3749881-07:00</ScheduledDate>
      <ServerNum>1</ServerNum>
      <ShortName>sample string 26</ShortName>
      <SigForm>sample string 27</SigForm>
      <SignalCode>sample string 28</SignalCode>
      <SignalCodeDescription>sample string 29</SignalCodeDescription>
      <SignalRuleDetails>sample string 30</SignalRuleDetails>
      <SignalRuleNum>1</SignalRuleNum>
      <SignalStatus>sample string 31</SignalStatus>
      <StyleCode>sample string 32</StyleCode>
      <StyleCode2>sample string 33</StyleCode2>
      <TaskNum>1</TaskNum>
      <TestDetails>sample string 34</TestDetails>
      <TestEffectiveDate>2025-05-03T23:13:14.3749881-07:00</TestEffectiveDate>
      <TestExpireDate>2025-05-03T23:13:14.3749881-07:00</TestExpireDate>
      <TransmitterCode>sample string 35</TransmitterCode>
      <UserName>sample string 36</UserName>
      <VideoFileNum>1</VideoFileNum>
      <VideoPassword>sample string 37</VideoPassword>
      <WorkStation>sample string 38</WorkStation>
    </AlarmHistoryEventListResult>
  </ResultSet>
</AlarmHistoryEventListQueryResult>