POST api/SiteGroup/XtAlarmBuffer

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DisplayDelayedFlag	boolean	None.
UnaccessedOnlyFlag	boolean	None.
ThisOperatorOnlyFlag	boolean	None.
AppUserSearch	string	None.
MinPriority	integer	None.
MaxPriority	integer	None.
SiteGroupNum	integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DisplayDelayedFlag": true,
  "UnaccessedOnlyFlag": true,
  "ThisOperatorOnlyFlag": true,
  "AppUserSearch": "sample string 1",
  "MinPriority": 1,
  "MaxPriority": 1,
  "SiteGroupNum": 1,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:

<XtAlarmBufferRequest 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>
  <SiteGroupNum>1</SiteGroupNum>
  <AppUserSearch>sample string 1</AppUserSearch>
  <DisplayDelayedFlag>true</DisplayDelayedFlag>
  <MaxPriority>1</MaxPriority>
  <MinPriority>1</MinPriority>
  <ThisOperatorOnlyFlag>true</ThisOperatorOnlyFlag>
  <UnaccessedOnlyFlag>true</UnaccessedOnlyFlag>
</XtAlarmBufferRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

XtAlarmBufferQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of XtAlarmBufferResult	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": [
    {
      "AlarmDate": "2024-05-01T11:20:55.6947091-04:00",
      "AlarmOperator": "sample string 1",
      "City": "sample string 2",
      "Color": "sample string 3",
      "DevNum": 1,
      "DisplayDelayedFlag": true,
      "EventCode": "sample string 4",
      "EventCodeDescription": "sample string 5",
      "FunctionOption": "sample string 6",
      "LockOperator": "sample string 7",
      "MaxPriority": 1,
      "MinPriority": 1,
      "PointStatus": "sample string 8",
      "Priority": 1,
      "SiteGroupSearch": "sample string 9",
      "SiteGroupSummary": {
        "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"
              }
            ]
          }
        ]
      },
      "SiteGroupSummaryFO": {
        "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"
              }
            ]
          }
        ]
      },
      "SiteName": "sample string 10",
      "SiteNum": 1,
      "SiteType": "sample string 11",
      "SiteTypeDescription": "sample string 12",
      "State": "sample string 13",
      "ThisOperatorOnlyFlag": true,
      "TimeAgo": "sample string 14",
      "Title": "sample string 15",
      "TransmitterCode": "sample string 16",
      "UnaccessedOnlyFlag": true
    },
    {
      "AlarmDate": "2024-05-01T11:20:55.6947091-04:00",
      "AlarmOperator": "sample string 1",
      "City": "sample string 2",
      "Color": "sample string 3",
      "DevNum": 1,
      "DisplayDelayedFlag": true,
      "EventCode": "sample string 4",
      "EventCodeDescription": "sample string 5",
      "FunctionOption": "sample string 6",
      "LockOperator": "sample string 7",
      "MaxPriority": 1,
      "MinPriority": 1,
      "PointStatus": "sample string 8",
      "Priority": 1,
      "SiteGroupSearch": "sample string 9",
      "SiteGroupSummary": {
        "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"
              }
            ]
          }
        ]
      },
      "SiteGroupSummaryFO": {
        "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"
              }
            ]
          }
        ]
      },
      "SiteName": "sample string 10",
      "SiteNum": 1,
      "SiteType": "sample string 11",
      "SiteTypeDescription": "sample string 12",
      "State": "sample string 13",
      "ThisOperatorOnlyFlag": true,
      "TimeAgo": "sample string 14",
      "Title": "sample string 15",
      "TransmitterCode": "sample string 16",
      "UnaccessedOnlyFlag": true
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<XtAlarmBufferQueryResult 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>
    <XtAlarmBufferResult>
      <AlarmDate>2024-05-01T11:20:55.6947091-04:00</AlarmDate>
      <AlarmOperator>sample string 1</AlarmOperator>
      <City>sample string 2</City>
      <Color>sample string 3</Color>
      <DevNum>1</DevNum>
      <DisplayDelayedFlag>true</DisplayDelayedFlag>
      <EventCode>sample string 4</EventCode>
      <EventCodeDescription>sample string 5</EventCodeDescription>
      <FunctionOption>sample string 6</FunctionOption>
      <LockOperator>sample string 7</LockOperator>
      <MaxPriority>1</MaxPriority>
      <MinPriority>1</MinPriority>
      <PointStatus>sample string 8</PointStatus>
      <Priority>1</Priority>
      <SiteGroupSearch>sample string 9</SiteGroupSearch>
      <SiteGroupSummary>
        <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>
      </SiteGroupSummary>
      <SiteGroupSummaryFO>
        <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>
      </SiteGroupSummaryFO>
      <SiteName>sample string 10</SiteName>
      <SiteNum>1</SiteNum>
      <SiteType>sample string 11</SiteType>
      <SiteTypeDescription>sample string 12</SiteTypeDescription>
      <State>sample string 13</State>
      <ThisOperatorOnlyFlag>true</ThisOperatorOnlyFlag>
      <TimeAgo>sample string 14</TimeAgo>
      <Title>sample string 15</Title>
      <TransmitterCode>sample string 16</TransmitterCode>
      <UnaccessedOnlyFlag>true</UnaccessedOnlyFlag>
    </XtAlarmBufferResult>
    <XtAlarmBufferResult>
      <AlarmDate>2024-05-01T11:20:55.6947091-04:00</AlarmDate>
      <AlarmOperator>sample string 1</AlarmOperator>
      <City>sample string 2</City>
      <Color>sample string 3</Color>
      <DevNum>1</DevNum>
      <DisplayDelayedFlag>true</DisplayDelayedFlag>
      <EventCode>sample string 4</EventCode>
      <EventCodeDescription>sample string 5</EventCodeDescription>
      <FunctionOption>sample string 6</FunctionOption>
      <LockOperator>sample string 7</LockOperator>
      <MaxPriority>1</MaxPriority>
      <MinPriority>1</MinPriority>
      <PointStatus>sample string 8</PointStatus>
      <Priority>1</Priority>
      <SiteGroupSearch>sample string 9</SiteGroupSearch>
      <SiteGroupSummary>
        <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>
      </SiteGroupSummary>
      <SiteGroupSummaryFO>
        <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>
      </SiteGroupSummaryFO>
      <SiteName>sample string 10</SiteName>
      <SiteNum>1</SiteNum>
      <SiteType>sample string 11</SiteType>
      <SiteTypeDescription>sample string 12</SiteTypeDescription>
      <State>sample string 13</State>
      <ThisOperatorOnlyFlag>true</ThisOperatorOnlyFlag>
      <TimeAgo>sample string 14</TimeAgo>
      <Title>sample string 15</Title>
      <TransmitterCode>sample string 16</TransmitterCode>
      <UnaccessedOnlyFlag>true</UnaccessedOnlyFlag>
    </XtAlarmBufferResult>
  </ResultSet>
</XtAlarmBufferQueryResult>