POST api/DataExport/SignalRuleList
Request Information
URI Parameters
None.
Body Parameters
DataExportSignalRuleRequestName | Description | Type | Additional information |
---|---|---|---|
IncludeDefaultZonesFlag | boolean |
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:
{ "IncludeDefaultZonesFlag": true, "SiteNum": 1, "TargetSiteGroup": 1, "SessionNum": 1, "SessionPassword": "QEA=", "ApplicationCode": "sample string 2", "StagesURL": "sample string 3" }
application/xml, text/xml
Sample:
<DataExportSignalRuleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 3</StagesURL> <ApplicationCode>sample string 2</ApplicationCode> <SessionNum>1</SessionNum> <SessionPassword>QEA=</SessionPassword> <SiteNum>1</SiteNum> <TargetSiteGroup>1</TargetSiteGroup> <IncludeDefaultZonesFlag>true</IncludeDefaultZonesFlag> </DataExportSignalRuleRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ExportSignalRulesQueryResultName | Description | Type | Additional information |
---|---|---|---|
Success | boolean |
None. |
|
ErrorMessage | string |
None. |
|
SignalRuleList | Collection of ExportSignalRulesResult |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "ErrorMessage": "sample string 2", "SignalRuleList": [ { "DevNum": 1, "SignalRuleNum": 2, "Point": "sample string 3", "SignalStatus": "sample string 4", "SignalCode": "sample string 5", "AreaNum": 1, "EventCode": "sample string 6", "SchedNum": 1, "AlternateTransmitterCode": "sample string 7", "ReportsRestoreFlag": "A", "Description": "sample string 9", "EqLoc": "sample string 10", "EqType": "sample string 11", "ActionPlanNum": 1, "AlarmConfirmation": "sample string 12", "SiteGroupNum": 1, "SiteGroupSchedNum": 1, "SeparateAlarmFlag": "A", "Priority": 1, "DelaySeconds": 1, "AlarmFlag": "A", "VerifyScheduleFlag": "A", "VerifyUserFlag": "A", "AutoProcess": "sample string 13", "UserID": "sample string 14", "SignalOption": "sample string 15", "DeviceStatus": "sample string 16", "ServType": "sample string 17", "RestoreWaitSeconds": 1, "RestoreWaitCount": 1, "TimerTestNum": 1, "TimerTestHours": 1, "TimerTestMinutes": 1, "FailTimerTestEvent": "sample string 18", "Comment": "sample string 19", "SiteNum": 20 }, { "DevNum": 1, "SignalRuleNum": 2, "Point": "sample string 3", "SignalStatus": "sample string 4", "SignalCode": "sample string 5", "AreaNum": 1, "EventCode": "sample string 6", "SchedNum": 1, "AlternateTransmitterCode": "sample string 7", "ReportsRestoreFlag": "A", "Description": "sample string 9", "EqLoc": "sample string 10", "EqType": "sample string 11", "ActionPlanNum": 1, "AlarmConfirmation": "sample string 12", "SiteGroupNum": 1, "SiteGroupSchedNum": 1, "SeparateAlarmFlag": "A", "Priority": 1, "DelaySeconds": 1, "AlarmFlag": "A", "VerifyScheduleFlag": "A", "VerifyUserFlag": "A", "AutoProcess": "sample string 13", "UserID": "sample string 14", "SignalOption": "sample string 15", "DeviceStatus": "sample string 16", "ServType": "sample string 17", "RestoreWaitSeconds": 1, "RestoreWaitCount": 1, "TimerTestNum": 1, "TimerTestHours": 1, "TimerTestMinutes": 1, "FailTimerTestEvent": "sample string 18", "Comment": "sample string 19", "SiteNum": 20 } ] }
application/xml, text/xml
Sample:
<ExportSignalRulesQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <ErrorMessage>sample string 2</ErrorMessage> <SignalRuleList> <ExportSignalRulesResult> <ActionPlanNum>1</ActionPlanNum> <AlarmConfirmation>sample string 12</AlarmConfirmation> <AlarmFlag>65</AlarmFlag> <AlternateTransmitterCode>sample string 7</AlternateTransmitterCode> <AreaNum>1</AreaNum> <AutoProcess>sample string 13</AutoProcess> <Comment>sample string 19</Comment> <DelaySeconds>1</DelaySeconds> <Description>sample string 9</Description> <DevNum>1</DevNum> <DeviceStatus>sample string 16</DeviceStatus> <EqLoc>sample string 10</EqLoc> <EqType>sample string 11</EqType> <EventCode>sample string 6</EventCode> <FailTimerTestEvent>sample string 18</FailTimerTestEvent> <Point>sample string 3</Point> <Priority>1</Priority> <ReportsRestoreFlag>65</ReportsRestoreFlag> <RestoreWaitCount>1</RestoreWaitCount> <RestoreWaitSeconds>1</RestoreWaitSeconds> <SchedNum>1</SchedNum> <SeparateAlarmFlag>65</SeparateAlarmFlag> <ServType>sample string 17</ServType> <SignalCode>sample string 5</SignalCode> <SignalOption>sample string 15</SignalOption> <SignalRuleNum>2</SignalRuleNum> <SignalStatus>sample string 4</SignalStatus> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSchedNum>1</SiteGroupSchedNum> <SiteNum>20</SiteNum> <TimerTestHours>1</TimerTestHours> <TimerTestMinutes>1</TimerTestMinutes> <TimerTestNum>1</TimerTestNum> <UserID>sample string 14</UserID> <VerifyScheduleFlag>65</VerifyScheduleFlag> <VerifyUserFlag>65</VerifyUserFlag> </ExportSignalRulesResult> <ExportSignalRulesResult> <ActionPlanNum>1</ActionPlanNum> <AlarmConfirmation>sample string 12</AlarmConfirmation> <AlarmFlag>65</AlarmFlag> <AlternateTransmitterCode>sample string 7</AlternateTransmitterCode> <AreaNum>1</AreaNum> <AutoProcess>sample string 13</AutoProcess> <Comment>sample string 19</Comment> <DelaySeconds>1</DelaySeconds> <Description>sample string 9</Description> <DevNum>1</DevNum> <DeviceStatus>sample string 16</DeviceStatus> <EqLoc>sample string 10</EqLoc> <EqType>sample string 11</EqType> <EventCode>sample string 6</EventCode> <FailTimerTestEvent>sample string 18</FailTimerTestEvent> <Point>sample string 3</Point> <Priority>1</Priority> <ReportsRestoreFlag>65</ReportsRestoreFlag> <RestoreWaitCount>1</RestoreWaitCount> <RestoreWaitSeconds>1</RestoreWaitSeconds> <SchedNum>1</SchedNum> <SeparateAlarmFlag>65</SeparateAlarmFlag> <ServType>sample string 17</ServType> <SignalCode>sample string 5</SignalCode> <SignalOption>sample string 15</SignalOption> <SignalRuleNum>2</SignalRuleNum> <SignalStatus>sample string 4</SignalStatus> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSchedNum>1</SiteGroupSchedNum> <SiteNum>20</SiteNum> <TimerTestHours>1</TimerTestHours> <TimerTestMinutes>1</TimerTestMinutes> <TimerTestNum>1</TimerTestNum> <UserID>sample string 14</UserID> <VerifyScheduleFlag>65</VerifyScheduleFlag> <VerifyUserFlag>65</VerifyUserFlag> </ExportSignalRulesResult> </SignalRuleList> <Success>true</Success> </ExportSignalRulesQueryResult>