POST api/History/AlDispHistory
Request Information
URI Parameters
None.
Body Parameters
HistoryRequestName | Description | 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:26:44.2276743-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:26:44.2276743-07:00", "MinDateTime": "2025-05-03T23:26:44.2276743-07:00", "HighlightDateTime": "2025-05-03T23:26:44.2276743-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:26:44.2276743-07:00</HighlightDateTime> <IncludeOpActFlag>true</IncludeOpActFlag> <InputDateTime>2025-05-03T23:26:44.2276743-07:00</InputDateTime> <MaxDateTime>2025-05-03T23:26:44.2276743-07:00</MaxDateTime> <MaxLines>1</MaxLines> <MinDateTime>2025-05-03T23:26:44.2276743-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
AlDispHistoryQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of AlDispHistoryResult |
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": [ { "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" } ] } ] }, "AdditionalDataFlag": true, "AdditionalDescription": "sample string 1", "AlarmDisposition": "sample string 2", "AlarmFlag": true, "AlarmNumOrTest": "sample string 3", "AlternateSiteName": "sample string 4", "AreaDescription": "sample string 5", "AreaNum": 1, "AutoNotifyOption": "sample string 6", "AutoNotifyRecipient": "sample string 7", "BackgroundStyle": "sample string 8", "BreakStyle": "sample string 9", "CameraList": "sample string 10", "CommunicationTime": "sample string 11", "DayofWeek": "sample string 12", "DevNum": 1, "DispatchingSiteNum": 1, "Display1": "sample string 13", "Display2": "sample string 14", "DisplayDelay": "sample string 15", "Elapsed": "sample string 16", "EventCode": "sample string 17", "EventOpAct": "sample string 18", "FullClearFlag": true, "FunctionName": "sample string 19", "FunctionOption": "sample string 20", "HistoryActPlan": "sample string 21", "HistoryComment": "sample string 22", "HistoryCommentBig": "sample string 23", "HistoryDate": "2025-05-03T23:26:44.2433-07:00", "HistoryDeviceDate": "2025-05-03T23:26:44.2433-07:00", "HistorySeqNum": "sample string 24", "Latitude": 1.0, "Line": "sample string 25", "Longitude": 1.0, "MapFlag": "sample string 26", "MapURL": "sample string 27", "NewEvent": "sample string 28", "PartialClearPriority": 1, "Phone": "sample string 29", "Point": "sample string 30", "PointDescription": "sample string 31", "PointFlyout": "sample string 32", "Priority": 1, "RawMessage": "sample string 33", "ReceiveDate": "2025-05-03T23:26:44.2433-07:00", "ReceivedInfo": "sample string 34", "ScheduledDate": "2025-05-03T23:26:44.2433-07:00", "SecurityStatusInBlock": "sample string 35", "ServerNum": 1, "ServiceTypeDescription": "sample string 36", "ShortName": "sample string 37", "SigForm": "sample string 38", "SignalCode": "sample string 39", "SignalCodeDescription": "sample string 40", "SignalInfo": "sample string 41", "SignalRuleComment": "sample string 42", "SignalRuleDetails": "sample string 43", "SignalRuleInfo": "sample string 44", "SignalRuleNum": 1, "SignalStatus": "sample string 45", "SiteNum": 1, "StyleCode": "sample string 46", "StyleCode2": "sample string 47", "TaskDescription": "sample string 48", "TaskInfo": "sample string 49", "TaskNum": 1, "TestAuthorization": "sample string 50", "TestDetails": "sample string 51", "TestEffectiveDate": "2025-05-03T23:26:44.2433-07:00", "TestExpireDate": "2025-05-03T23:26:44.2433-07:00", "Title": "sample string 52", "TransmitterCode": "sample string 53", "URLTarget": "sample string 54", "UserName": "sample string 55", "UTCDate": "2025-05-03T23:26:44.2433-07:00", "VideoFileNum": 1, "VideoPassword": "sample string 56", "VideoReference": "sample string 57", "VideoViewer": "sample string 58", "VoiceRecProgramPath": "sample string 59", "WorkStation": "sample string 60", "StyleCode3": "sample string 61", "IntegrationPlatform": "sample string 62", "ModuleSubTypeDescription": "sample string 63", "ModuleTypeDescription": "sample string 64", "NodeTypeDescription": "sample string 65", "PointSubTypeDescription": "sample string 66", "PointTypeDescription": "sample string 67", "EventTroubleStatusDescription": "sample string 68", "PointFunction": "sample string 69" }, { "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" } ] } ] }, "AdditionalDataFlag": true, "AdditionalDescription": "sample string 1", "AlarmDisposition": "sample string 2", "AlarmFlag": true, "AlarmNumOrTest": "sample string 3", "AlternateSiteName": "sample string 4", "AreaDescription": "sample string 5", "AreaNum": 1, "AutoNotifyOption": "sample string 6", "AutoNotifyRecipient": "sample string 7", "BackgroundStyle": "sample string 8", "BreakStyle": "sample string 9", "CameraList": "sample string 10", "CommunicationTime": "sample string 11", "DayofWeek": "sample string 12", "DevNum": 1, "DispatchingSiteNum": 1, "Display1": "sample string 13", "Display2": "sample string 14", "DisplayDelay": "sample string 15", "Elapsed": "sample string 16", "EventCode": "sample string 17", "EventOpAct": "sample string 18", "FullClearFlag": true, "FunctionName": "sample string 19", "FunctionOption": "sample string 20", "HistoryActPlan": "sample string 21", "HistoryComment": "sample string 22", "HistoryCommentBig": "sample string 23", "HistoryDate": "2025-05-03T23:26:44.2433-07:00", "HistoryDeviceDate": "2025-05-03T23:26:44.2433-07:00", "HistorySeqNum": "sample string 24", "Latitude": 1.0, "Line": "sample string 25", "Longitude": 1.0, "MapFlag": "sample string 26", "MapURL": "sample string 27", "NewEvent": "sample string 28", "PartialClearPriority": 1, "Phone": "sample string 29", "Point": "sample string 30", "PointDescription": "sample string 31", "PointFlyout": "sample string 32", "Priority": 1, "RawMessage": "sample string 33", "ReceiveDate": "2025-05-03T23:26:44.2433-07:00", "ReceivedInfo": "sample string 34", "ScheduledDate": "2025-05-03T23:26:44.2433-07:00", "SecurityStatusInBlock": "sample string 35", "ServerNum": 1, "ServiceTypeDescription": "sample string 36", "ShortName": "sample string 37", "SigForm": "sample string 38", "SignalCode": "sample string 39", "SignalCodeDescription": "sample string 40", "SignalInfo": "sample string 41", "SignalRuleComment": "sample string 42", "SignalRuleDetails": "sample string 43", "SignalRuleInfo": "sample string 44", "SignalRuleNum": 1, "SignalStatus": "sample string 45", "SiteNum": 1, "StyleCode": "sample string 46", "StyleCode2": "sample string 47", "TaskDescription": "sample string 48", "TaskInfo": "sample string 49", "TaskNum": 1, "TestAuthorization": "sample string 50", "TestDetails": "sample string 51", "TestEffectiveDate": "2025-05-03T23:26:44.2433-07:00", "TestExpireDate": "2025-05-03T23:26:44.2433-07:00", "Title": "sample string 52", "TransmitterCode": "sample string 53", "URLTarget": "sample string 54", "UserName": "sample string 55", "UTCDate": "2025-05-03T23:26:44.2433-07:00", "VideoFileNum": 1, "VideoPassword": "sample string 56", "VideoReference": "sample string 57", "VideoViewer": "sample string 58", "VoiceRecProgramPath": "sample string 59", "WorkStation": "sample string 60", "StyleCode3": "sample string 61", "IntegrationPlatform": "sample string 62", "ModuleSubTypeDescription": "sample string 63", "ModuleTypeDescription": "sample string 64", "NodeTypeDescription": "sample string 65", "PointSubTypeDescription": "sample string 66", "PointTypeDescription": "sample string 67", "EventTroubleStatusDescription": "sample string 68", "PointFunction": "sample string 69" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<AlDispHistoryQueryResult 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> <AlDispHistoryResult> <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> <AdditionalDataFlag>true</AdditionalDataFlag> <AdditionalDescription>sample string 1</AdditionalDescription> <AlarmDisposition>sample string 2</AlarmDisposition> <AlarmFlag>true</AlarmFlag> <AlarmNumOrTest>sample string 3</AlarmNumOrTest> <AlternateSiteName>sample string 4</AlternateSiteName> <AreaDescription>sample string 5</AreaDescription> <AreaNum>1</AreaNum> <AutoNotifyOption>sample string 6</AutoNotifyOption> <AutoNotifyRecipient>sample string 7</AutoNotifyRecipient> <BackgroundStyle>sample string 8</BackgroundStyle> <BreakStyle>sample string 9</BreakStyle> <CameraList>sample string 10</CameraList> <CommunicationTime>sample string 11</CommunicationTime> <DayofWeek>sample string 12</DayofWeek> <DevNum>1</DevNum> <DispatchingSiteNum>1</DispatchingSiteNum> <Display1>sample string 13</Display1> <Display2>sample string 14</Display2> <DisplayDelay>sample string 15</DisplayDelay> <Elapsed>sample string 16</Elapsed> <EventCode>sample string 17</EventCode> <EventOpAct>sample string 18</EventOpAct> <EventTroubleStatusDescription>sample string 68</EventTroubleStatusDescription> <FullClearFlag>true</FullClearFlag> <FunctionName>sample string 19</FunctionName> <FunctionOption>sample string 20</FunctionOption> <HistoryActPlan>sample string 21</HistoryActPlan> <HistoryComment>sample string 22</HistoryComment> <HistoryCommentBig>sample string 23</HistoryCommentBig> <HistoryDate>2025-05-03T23:26:44.2433-07:00</HistoryDate> <HistoryDeviceDate>2025-05-03T23:26:44.2433-07:00</HistoryDeviceDate> <HistorySeqNum>sample string 24</HistorySeqNum> <IntegrationPlatform>sample string 62</IntegrationPlatform> <Latitude>1</Latitude> <Line>sample string 25</Line> <Longitude>1</Longitude> <MapFlag>sample string 26</MapFlag> <MapURL>sample string 27</MapURL> <ModuleSubTypeDescription>sample string 63</ModuleSubTypeDescription> <ModuleTypeDescription>sample string 64</ModuleTypeDescription> <NewEvent>sample string 28</NewEvent> <NodeTypeDescription>sample string 65</NodeTypeDescription> <PartialClearPriority>1</PartialClearPriority> <Phone>sample string 29</Phone> <Point>sample string 30</Point> <PointDescription>sample string 31</PointDescription> <PointFlyout>sample string 32</PointFlyout> <PointFunction>sample string 69</PointFunction> <PointSubTypeDescription>sample string 66</PointSubTypeDescription> <PointTypeDescription>sample string 67</PointTypeDescription> <Priority>1</Priority> <RawMessage>sample string 33</RawMessage> <ReceiveDate>2025-05-03T23:26:44.2433-07:00</ReceiveDate> <ReceivedInfo>sample string 34</ReceivedInfo> <ScheduledDate>2025-05-03T23:26:44.2433-07:00</ScheduledDate> <SecurityStatusInBlock>sample string 35</SecurityStatusInBlock> <ServerNum>1</ServerNum> <ServiceTypeDescription>sample string 36</ServiceTypeDescription> <ShortName>sample string 37</ShortName> <SigForm>sample string 38</SigForm> <SignalCode>sample string 39</SignalCode> <SignalCodeDescription>sample string 40</SignalCodeDescription> <SignalInfo>sample string 41</SignalInfo> <SignalRuleComment>sample string 42</SignalRuleComment> <SignalRuleDetails>sample string 43</SignalRuleDetails> <SignalRuleInfo>sample string 44</SignalRuleInfo> <SignalRuleNum>1</SignalRuleNum> <SignalStatus>sample string 45</SignalStatus> <SiteNum>1</SiteNum> <StyleCode>sample string 46</StyleCode> <StyleCode2>sample string 47</StyleCode2> <StyleCode3>sample string 61</StyleCode3> <TaskDescription>sample string 48</TaskDescription> <TaskInfo>sample string 49</TaskInfo> <TaskNum>1</TaskNum> <TestAuthorization>sample string 50</TestAuthorization> <TestDetails>sample string 51</TestDetails> <TestEffectiveDate>2025-05-03T23:26:44.2433-07:00</TestEffectiveDate> <TestExpireDate>2025-05-03T23:26:44.2433-07:00</TestExpireDate> <Title>sample string 52</Title> <TransmitterCode>sample string 53</TransmitterCode> <URLTarget>sample string 54</URLTarget> <UTCDate>2025-05-03T23:26:44.2433-07:00</UTCDate> <UserName>sample string 55</UserName> <VideoFileNum>1</VideoFileNum> <VideoPassword>sample string 56</VideoPassword> <VideoReference>sample string 57</VideoReference> <VideoViewer>sample string 58</VideoViewer> <VoiceRecProgramPath>sample string 59</VoiceRecProgramPath> <WorkStation>sample string 60</WorkStation> </AlDispHistoryResult> <AlDispHistoryResult> <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> <AdditionalDataFlag>true</AdditionalDataFlag> <AdditionalDescription>sample string 1</AdditionalDescription> <AlarmDisposition>sample string 2</AlarmDisposition> <AlarmFlag>true</AlarmFlag> <AlarmNumOrTest>sample string 3</AlarmNumOrTest> <AlternateSiteName>sample string 4</AlternateSiteName> <AreaDescription>sample string 5</AreaDescription> <AreaNum>1</AreaNum> <AutoNotifyOption>sample string 6</AutoNotifyOption> <AutoNotifyRecipient>sample string 7</AutoNotifyRecipient> <BackgroundStyle>sample string 8</BackgroundStyle> <BreakStyle>sample string 9</BreakStyle> <CameraList>sample string 10</CameraList> <CommunicationTime>sample string 11</CommunicationTime> <DayofWeek>sample string 12</DayofWeek> <DevNum>1</DevNum> <DispatchingSiteNum>1</DispatchingSiteNum> <Display1>sample string 13</Display1> <Display2>sample string 14</Display2> <DisplayDelay>sample string 15</DisplayDelay> <Elapsed>sample string 16</Elapsed> <EventCode>sample string 17</EventCode> <EventOpAct>sample string 18</EventOpAct> <EventTroubleStatusDescription>sample string 68</EventTroubleStatusDescription> <FullClearFlag>true</FullClearFlag> <FunctionName>sample string 19</FunctionName> <FunctionOption>sample string 20</FunctionOption> <HistoryActPlan>sample string 21</HistoryActPlan> <HistoryComment>sample string 22</HistoryComment> <HistoryCommentBig>sample string 23</HistoryCommentBig> <HistoryDate>2025-05-03T23:26:44.2433-07:00</HistoryDate> <HistoryDeviceDate>2025-05-03T23:26:44.2433-07:00</HistoryDeviceDate> <HistorySeqNum>sample string 24</HistorySeqNum> <IntegrationPlatform>sample string 62</IntegrationPlatform> <Latitude>1</Latitude> <Line>sample string 25</Line> <Longitude>1</Longitude> <MapFlag>sample string 26</MapFlag> <MapURL>sample string 27</MapURL> <ModuleSubTypeDescription>sample string 63</ModuleSubTypeDescription> <ModuleTypeDescription>sample string 64</ModuleTypeDescription> <NewEvent>sample string 28</NewEvent> <NodeTypeDescription>sample string 65</NodeTypeDescription> <PartialClearPriority>1</PartialClearPriority> <Phone>sample string 29</Phone> <Point>sample string 30</Point> <PointDescription>sample string 31</PointDescription> <PointFlyout>sample string 32</PointFlyout> <PointFunction>sample string 69</PointFunction> <PointSubTypeDescription>sample string 66</PointSubTypeDescription> <PointTypeDescription>sample string 67</PointTypeDescription> <Priority>1</Priority> <RawMessage>sample string 33</RawMessage> <ReceiveDate>2025-05-03T23:26:44.2433-07:00</ReceiveDate> <ReceivedInfo>sample string 34</ReceivedInfo> <ScheduledDate>2025-05-03T23:26:44.2433-07:00</ScheduledDate> <SecurityStatusInBlock>sample string 35</SecurityStatusInBlock> <ServerNum>1</ServerNum> <ServiceTypeDescription>sample string 36</ServiceTypeDescription> <ShortName>sample string 37</ShortName> <SigForm>sample string 38</SigForm> <SignalCode>sample string 39</SignalCode> <SignalCodeDescription>sample string 40</SignalCodeDescription> <SignalInfo>sample string 41</SignalInfo> <SignalRuleComment>sample string 42</SignalRuleComment> <SignalRuleDetails>sample string 43</SignalRuleDetails> <SignalRuleInfo>sample string 44</SignalRuleInfo> <SignalRuleNum>1</SignalRuleNum> <SignalStatus>sample string 45</SignalStatus> <SiteNum>1</SiteNum> <StyleCode>sample string 46</StyleCode> <StyleCode2>sample string 47</StyleCode2> <StyleCode3>sample string 61</StyleCode3> <TaskDescription>sample string 48</TaskDescription> <TaskInfo>sample string 49</TaskInfo> <TaskNum>1</TaskNum> <TestAuthorization>sample string 50</TestAuthorization> <TestDetails>sample string 51</TestDetails> <TestEffectiveDate>2025-05-03T23:26:44.2433-07:00</TestEffectiveDate> <TestExpireDate>2025-05-03T23:26:44.2433-07:00</TestExpireDate> <Title>sample string 52</Title> <TransmitterCode>sample string 53</TransmitterCode> <URLTarget>sample string 54</URLTarget> <UTCDate>2025-05-03T23:26:44.2433-07:00</UTCDate> <UserName>sample string 55</UserName> <VideoFileNum>1</VideoFileNum> <VideoPassword>sample string 56</VideoPassword> <VideoReference>sample string 57</VideoReference> <VideoViewer>sample string 58</VideoViewer> <VoiceRecProgramPath>sample string 59</VoiceRecProgramPath> <WorkStation>sample string 60</WorkStation> </AlDispHistoryResult> </ResultSet> </AlDispHistoryQueryResult>