POST api/History/XtHistory

Request Information

URI Parameters

None.

Body Parameters

XtHistoryRequest
NameDescriptionTypeAdditional information
FunctionName

string

None.
SiteNum

integer

None.
DevNum

integer

None.
ServerNum

integer

None.
HistorySeqNum

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",
  "SiteNum": 1,
  "DevNum": 1,
  "ServerNum": 1,
  "HistorySeqNum": 1,
  "MaxDateTime": "2025-12-14T17:42:48.7393665-05:00",
  "MinDateTime": "2025-12-14T17:42:48.7393665-05:00",
  "HighlightDateTime": "2025-12-14T17:42:48.7393665-05:00",
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample: 
<XtHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 4</StagesURL>
  <ApplicationCode>sample string 3</ApplicationCode>
  <SessionNum>2</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <FunctionName>sample string 1</FunctionName>
  <HighlightDateTime>2025-12-14T17:42:48.7393665-05:00</HighlightDateTime>
  <HistorySeqNum>1</HistorySeqNum>
  <MaxDateTime>2025-12-14T17:42:48.7393665-05:00</MaxDateTime>
  <MinDateTime>2025-12-14T17:42:48.7393665-05:00</MinDateTime>
  <ServerNum>1</ServerNum>
  <SiteNum>1</SiteNum>
</XtHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

XtHistoryQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.
ResultSet

Collection of XtHistoryResult

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": [
    {
      "AlarmDisposition": "sample string 1",
      "AlarmNumOrTest": "sample string 2",
      "AlternateSiteName": "sample string 3",
      "AreaNum": 1,
      "BackgroundStyle": "sample string 4",
      "BreakStyle": "sample string 5",
      "DevNum": 1,
      "DisplayDelay": "sample string 6",
      "EventOpAct": "sample string 7",
      "FirstSeqNum": 1,
      "FullClearFlag": true,
      "FunctionName": "sample string 8",
      "FunctionOption": "sample string 9",
      "HistoryActPlan": "sample string 10",
      "HistoryComment": "sample string 11",
      "HistoryDate": "2025-12-14T17:42:48.7393665-05:00",
      "HistoryDeviceDate": "2025-12-14T17:42:48.7393665-05:00",
      "HistorySeqNum": "sample string 12",
      "Line": "sample string 13",
      "NewEvent": "sample string 14",
      "PartialClearPriority": 1,
      "Phone": "sample string 15",
      "Point": "sample string 16",
      "PointDescription": "sample string 17",
      "RawMessage": "sample string 18",
      "ReceiveDate": "2025-12-14T17:42:48.7393665-05:00",
      "ScheduledDate": "2025-12-14T17:42:48.7393665-05:00",
      "ServerNum": 1,
      "ShortName": "sample string 19",
      "SigForm": "sample string 20",
      "SignalCode": "sample string 21",
      "SignalCodeDescription": "sample string 22",
      "SignalRuleDetails": "sample string 23",
      "SignalRuleNum": 1,
      "SignalStatus": "sample string 24",
      "SiteNum": 1,
      "StyleCode": "sample string 25",
      "TaskNum": 1,
      "TestDetails": "sample string 26",
      "TestEffectiveDate": "2025-12-14T17:42:48.7393665-05:00",
      "TestExpireDate": "2025-12-14T17:42:48.7393665-05:00",
      "TransmitterCode": "sample string 27",
      "UserName": "sample string 28",
      "UTCDate": "2025-12-14T17:42:48.7393665-05:00"
    },
    {
      "AlarmDisposition": "sample string 1",
      "AlarmNumOrTest": "sample string 2",
      "AlternateSiteName": "sample string 3",
      "AreaNum": 1,
      "BackgroundStyle": "sample string 4",
      "BreakStyle": "sample string 5",
      "DevNum": 1,
      "DisplayDelay": "sample string 6",
      "EventOpAct": "sample string 7",
      "FirstSeqNum": 1,
      "FullClearFlag": true,
      "FunctionName": "sample string 8",
      "FunctionOption": "sample string 9",
      "HistoryActPlan": "sample string 10",
      "HistoryComment": "sample string 11",
      "HistoryDate": "2025-12-14T17:42:48.7393665-05:00",
      "HistoryDeviceDate": "2025-12-14T17:42:48.7393665-05:00",
      "HistorySeqNum": "sample string 12",
      "Line": "sample string 13",
      "NewEvent": "sample string 14",
      "PartialClearPriority": 1,
      "Phone": "sample string 15",
      "Point": "sample string 16",
      "PointDescription": "sample string 17",
      "RawMessage": "sample string 18",
      "ReceiveDate": "2025-12-14T17:42:48.7393665-05:00",
      "ScheduledDate": "2025-12-14T17:42:48.7393665-05:00",
      "ServerNum": 1,
      "ShortName": "sample string 19",
      "SigForm": "sample string 20",
      "SignalCode": "sample string 21",
      "SignalCodeDescription": "sample string 22",
      "SignalRuleDetails": "sample string 23",
      "SignalRuleNum": 1,
      "SignalStatus": "sample string 24",
      "SiteNum": 1,
      "StyleCode": "sample string 25",
      "TaskNum": 1,
      "TestDetails": "sample string 26",
      "TestEffectiveDate": "2025-12-14T17:42:48.7393665-05:00",
      "TestExpireDate": "2025-12-14T17:42:48.7393665-05:00",
      "TransmitterCode": "sample string 27",
      "UserName": "sample string 28",
      "UTCDate": "2025-12-14T17:42:48.7393665-05:00"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample: 
<XtHistoryQueryResult 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>
    <XtHistoryResult>
      <AlarmDisposition>sample string 1</AlarmDisposition>
      <AlarmNumOrTest>sample string 2</AlarmNumOrTest>
      <AlternateSiteName>sample string 3</AlternateSiteName>
      <AreaNum>1</AreaNum>
      <BackgroundStyle>sample string 4</BackgroundStyle>
      <BreakStyle>sample string 5</BreakStyle>
      <DevNum>1</DevNum>
      <DisplayDelay>sample string 6</DisplayDelay>
      <EventOpAct>sample string 7</EventOpAct>
      <FirstSeqNum>1</FirstSeqNum>
      <FullClearFlag>true</FullClearFlag>
      <FunctionName>sample string 8</FunctionName>
      <FunctionOption>sample string 9</FunctionOption>
      <HistoryActPlan>sample string 10</HistoryActPlan>
      <HistoryComment>sample string 11</HistoryComment>
      <HistoryDate>2025-12-14T17:42:48.7393665-05:00</HistoryDate>
      <HistoryDeviceDate>2025-12-14T17:42:48.7393665-05:00</HistoryDeviceDate>
      <HistorySeqNum>sample string 12</HistorySeqNum>
      <Line>sample string 13</Line>
      <NewEvent>sample string 14</NewEvent>
      <PartialClearPriority>1</PartialClearPriority>
      <Phone>sample string 15</Phone>
      <Point>sample string 16</Point>
      <PointDescription>sample string 17</PointDescription>
      <RawMessage>sample string 18</RawMessage>
      <ReceiveDate>2025-12-14T17:42:48.7393665-05:00</ReceiveDate>
      <ScheduledDate>2025-12-14T17:42:48.7393665-05:00</ScheduledDate>
      <ServerNum>1</ServerNum>
      <ShortName>sample string 19</ShortName>
      <SigForm>sample string 20</SigForm>
      <SignalCode>sample string 21</SignalCode>
      <SignalCodeDescription>sample string 22</SignalCodeDescription>
      <SignalRuleDetails>sample string 23</SignalRuleDetails>
      <SignalRuleNum>1</SignalRuleNum>
      <SignalStatus>sample string 24</SignalStatus>
      <SiteNum>1</SiteNum>
      <StyleCode>sample string 25</StyleCode>
      <TaskNum>1</TaskNum>
      <TestDetails>sample string 26</TestDetails>
      <TestEffectiveDate>2025-12-14T17:42:48.7393665-05:00</TestEffectiveDate>
      <TestExpireDate>2025-12-14T17:42:48.7393665-05:00</TestExpireDate>
      <TransmitterCode>sample string 27</TransmitterCode>
      <UTCDate>2025-12-14T17:42:48.7393665-05:00</UTCDate>
      <UserName>sample string 28</UserName>
    </XtHistoryResult>
    <XtHistoryResult>
      <AlarmDisposition>sample string 1</AlarmDisposition>
      <AlarmNumOrTest>sample string 2</AlarmNumOrTest>
      <AlternateSiteName>sample string 3</AlternateSiteName>
      <AreaNum>1</AreaNum>
      <BackgroundStyle>sample string 4</BackgroundStyle>
      <BreakStyle>sample string 5</BreakStyle>
      <DevNum>1</DevNum>
      <DisplayDelay>sample string 6</DisplayDelay>
      <EventOpAct>sample string 7</EventOpAct>
      <FirstSeqNum>1</FirstSeqNum>
      <FullClearFlag>true</FullClearFlag>
      <FunctionName>sample string 8</FunctionName>
      <FunctionOption>sample string 9</FunctionOption>
      <HistoryActPlan>sample string 10</HistoryActPlan>
      <HistoryComment>sample string 11</HistoryComment>
      <HistoryDate>2025-12-14T17:42:48.7393665-05:00</HistoryDate>
      <HistoryDeviceDate>2025-12-14T17:42:48.7393665-05:00</HistoryDeviceDate>
      <HistorySeqNum>sample string 12</HistorySeqNum>
      <Line>sample string 13</Line>
      <NewEvent>sample string 14</NewEvent>
      <PartialClearPriority>1</PartialClearPriority>
      <Phone>sample string 15</Phone>
      <Point>sample string 16</Point>
      <PointDescription>sample string 17</PointDescription>
      <RawMessage>sample string 18</RawMessage>
      <ReceiveDate>2025-12-14T17:42:48.7393665-05:00</ReceiveDate>
      <ScheduledDate>2025-12-14T17:42:48.7393665-05:00</ScheduledDate>
      <ServerNum>1</ServerNum>
      <ShortName>sample string 19</ShortName>
      <SigForm>sample string 20</SigForm>
      <SignalCode>sample string 21</SignalCode>
      <SignalCodeDescription>sample string 22</SignalCodeDescription>
      <SignalRuleDetails>sample string 23</SignalRuleDetails>
      <SignalRuleNum>1</SignalRuleNum>
      <SignalStatus>sample string 24</SignalStatus>
      <SiteNum>1</SiteNum>
      <StyleCode>sample string 25</StyleCode>
      <TaskNum>1</TaskNum>
      <TestDetails>sample string 26</TestDetails>
      <TestEffectiveDate>2025-12-14T17:42:48.7393665-05:00</TestEffectiveDate>
      <TestExpireDate>2025-12-14T17:42:48.7393665-05:00</TestExpireDate>
      <TransmitterCode>sample string 27</TransmitterCode>
      <UTCDate>2025-12-14T17:42:48.7393665-05:00</UTCDate>
      <UserName>sample string 28</UserName>
    </XtHistoryResult>
  </ResultSet>
</XtHistoryQueryResult>