POST api/DataExport/AlarmList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DispositionList	string	None.
SiteGroupNum	integer	None.
IncludeOpActs	boolean	None.
UTCBeginDate	date	None.
UTCEndDate	date	None.
ReportCodeList	Collection of string	None.
SiteNum	integer	None.
TargetSiteGroup	integer	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DispositionList": "sample string 1",
  "SiteGroupNum": 1,
  "IncludeOpActs": true,
  "UTCBeginDate": "2024-05-01T13:11:05.9191447-04:00",
  "UTCEndDate": "2024-05-01T13:11:05.9191447-04:00",
  "ReportCodeList": [
    "sample string 1",
    "sample string 2"
  ],
  "SiteNum": 1,
  "TargetSiteGroup": 1,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:

<DataExportAlarmRequest 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>
  <SiteNum>1</SiteNum>
  <TargetSiteGroup>1</TargetSiteGroup>
  <ReportCodeList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReportCodeList>
  <UTCBeginDate>2024-05-01T13:11:05.9191447-04:00</UTCBeginDate>
  <UTCEndDate>2024-05-01T13:11:05.9191447-04:00</UTCEndDate>
  <IncludeOpActs>true</IncludeOpActs>
  <DispositionList>sample string 1</DispositionList>
  <SiteGroupNum>1</SiteGroupNum>
</DataExportAlarmRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ExportAlarmListQueryResult

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	string	None.
AlarmList	Collection of ExportAlarmListResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "AlarmList": [
    {
      "DevNum": 1,
      "SiteGroupNum": 1,
      "TransmitterCode": "sample string 1",
      "AddressName": "sample string 2",
      "Address": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zipcode": "sample string 7",
      "Date": "2024-05-01T13:11:05.9191447-04:00",
      "EventOpAct": "sample string 8",
      "SignalCode": "sample string 9",
      "Comment": "sample string 10",
      "Point": "sample string 11",
      "PointDescription": "sample string 12",
      "SiteNum": 13
    },
    {
      "DevNum": 1,
      "SiteGroupNum": 1,
      "TransmitterCode": "sample string 1",
      "AddressName": "sample string 2",
      "Address": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zipcode": "sample string 7",
      "Date": "2024-05-01T13:11:05.9191447-04:00",
      "EventOpAct": "sample string 8",
      "SignalCode": "sample string 9",
      "Comment": "sample string 10",
      "Point": "sample string 11",
      "PointDescription": "sample string 12",
      "SiteNum": 13
    }
  ]
}

application/xml, text/xml

Sample:

<ExportAlarmListQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <AlarmList>
    <ExportAlarmListResult>
      <Address>sample string 3</Address>
      <Address2>sample string 4</Address2>
      <AddressName>sample string 2</AddressName>
      <City>sample string 5</City>
      <Comment>sample string 10</Comment>
      <Date>2024-05-01T13:11:05.9191447-04:00</Date>
      <DevNum>1</DevNum>
      <EventOpAct>sample string 8</EventOpAct>
      <Point>sample string 11</Point>
      <PointDescription>sample string 12</PointDescription>
      <SignalCode>sample string 9</SignalCode>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteNum>13</SiteNum>
      <State>sample string 6</State>
      <TransmitterCode>sample string 1</TransmitterCode>
      <Zipcode>sample string 7</Zipcode>
    </ExportAlarmListResult>
    <ExportAlarmListResult>
      <Address>sample string 3</Address>
      <Address2>sample string 4</Address2>
      <AddressName>sample string 2</AddressName>
      <City>sample string 5</City>
      <Comment>sample string 10</Comment>
      <Date>2024-05-01T13:11:05.9191447-04:00</Date>
      <DevNum>1</DevNum>
      <EventOpAct>sample string 8</EventOpAct>
      <Point>sample string 11</Point>
      <PointDescription>sample string 12</PointDescription>
      <SignalCode>sample string 9</SignalCode>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteNum>13</SiteNum>
      <State>sample string 6</State>
      <TransmitterCode>sample string 1</TransmitterCode>
      <Zipcode>sample string 7</Zipcode>
    </ExportAlarmListResult>
  </AlarmList>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</ExportAlarmListQueryResult>