POST api/Device/EventRuleDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EventRuleNum	integer	None.
DevNum	integer	None.
SiteGroupNum	integer	None.
SiteType	string	None.
DispatchType	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "EventRuleNum": 1,
  "DevNum": 1,
  "SiteGroupNum": 1,
  "SiteType": "sample string 1",
  "DispatchType": "sample string 2",
  "SessionNum": 3,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 4",
  "StagesURL": "sample string 5"
}

application/xml, text/xml

Sample:

<EventRuleRequest 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>
  <DevNum>1</DevNum>
  <DispatchType>sample string 2</DispatchType>
  <EventRuleNum>1</EventRuleNum>
  <SiteGroupNum>1</SiteGroupNum>
  <SiteType>sample string 1</SiteType>
</EventRuleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EventRuleDetailQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of EventRuleDetailResult	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": [
    {
      "AbortByPointFlag": true,
      "AbortBySignalCodeFlag": true,
      "AbortLogEventCode": "sample string 1",
      "AbortLogEventCodeDescription": "sample string 2",
      "AbortOptionDescription": "sample string 3",
      "AbortOptionNum": 1,
      "AbortSuppressionPeriod": "sample string 4",
      "AlarmFlag": true,
      "AlarmOption": "sample string 5",
      "AlarmOptionDescription": "sample string 6",
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "Delay": "sample string 7",
      "Description": "sample string 8",
      "DevNum": 1,
      "DispatchType": "sample string 9",
      "EventCode": "sample string 10",
      "EventCodeDescription": "sample string 11",
      "EventRuleNum": 1,
      "FailToAbortEventCode": "sample string 12",
      "FailToAbortEventDescr": "sample string 13",
      "LogOnlyFlag": true,
      "OverrideEventCode": "sample string 14",
      "OverrideEventCodeDescription": "sample string 15",
      "Point": "sample string 16",
      "PrimarySecondaryAbortFlag": true,
      "Priority": 1,
      "PriorityDescription": "sample string 17",
      "RestoreWaitCount": 1,
      "RestoreWaitPeriod": "sample string 18",
      "ScheduleOption": "sample string 19",
      "ScheduleOptionDescription": "sample string 20",
      "ServiceTypeDescription": "sample string 21",
      "ServType": "sample string 22",
      "SigForm": "sample string 23",
      "SignalCode": "sample string 24",
      "SignalCodeDescription": "sample string 25",
      "SignalFormatDescription": "sample string 26",
      "SignalStatus": "sample string 27",
      "SignalStatusDescription": "sample string 28",
      "SiteGroupNum": 1,
      "SiteType": "sample string 29",
      "SuppressionByPointFlag": true,
      "SuppressionDuringAlarmOnlyFlag": true,
      "SuppressionEndServType": "sample string 30",
      "SuppressionEndServTypeDescription": "sample string 31",
      "SuppressionPeriod": "sample string 32",
      "AbortableSeconds": 1,
      "ActionAutoEvalDescription": "sample string 33",
      "ActionAutoEvalNum": 1,
      "AbortNewPriority": 1,
      "AbortNewPriorityDescription": "sample string 34",
      "HoursType": "sample string 35",
      "HoursTypeDescription": "sample string 36",
      "DispatchTypeDescription": "sample string 37",
      "SiteTypeDescription": "sample string 38",
      "InternalNotes": "sample string 39"
    },
    {
      "AbortByPointFlag": true,
      "AbortBySignalCodeFlag": true,
      "AbortLogEventCode": "sample string 1",
      "AbortLogEventCodeDescription": "sample string 2",
      "AbortOptionDescription": "sample string 3",
      "AbortOptionNum": 1,
      "AbortSuppressionPeriod": "sample string 4",
      "AlarmFlag": true,
      "AlarmOption": "sample string 5",
      "AlarmOptionDescription": "sample string 6",
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "Delay": "sample string 7",
      "Description": "sample string 8",
      "DevNum": 1,
      "DispatchType": "sample string 9",
      "EventCode": "sample string 10",
      "EventCodeDescription": "sample string 11",
      "EventRuleNum": 1,
      "FailToAbortEventCode": "sample string 12",
      "FailToAbortEventDescr": "sample string 13",
      "LogOnlyFlag": true,
      "OverrideEventCode": "sample string 14",
      "OverrideEventCodeDescription": "sample string 15",
      "Point": "sample string 16",
      "PrimarySecondaryAbortFlag": true,
      "Priority": 1,
      "PriorityDescription": "sample string 17",
      "RestoreWaitCount": 1,
      "RestoreWaitPeriod": "sample string 18",
      "ScheduleOption": "sample string 19",
      "ScheduleOptionDescription": "sample string 20",
      "ServiceTypeDescription": "sample string 21",
      "ServType": "sample string 22",
      "SigForm": "sample string 23",
      "SignalCode": "sample string 24",
      "SignalCodeDescription": "sample string 25",
      "SignalFormatDescription": "sample string 26",
      "SignalStatus": "sample string 27",
      "SignalStatusDescription": "sample string 28",
      "SiteGroupNum": 1,
      "SiteType": "sample string 29",
      "SuppressionByPointFlag": true,
      "SuppressionDuringAlarmOnlyFlag": true,
      "SuppressionEndServType": "sample string 30",
      "SuppressionEndServTypeDescription": "sample string 31",
      "SuppressionPeriod": "sample string 32",
      "AbortableSeconds": 1,
      "ActionAutoEvalDescription": "sample string 33",
      "ActionAutoEvalNum": 1,
      "AbortNewPriority": 1,
      "AbortNewPriorityDescription": "sample string 34",
      "HoursType": "sample string 35",
      "HoursTypeDescription": "sample string 36",
      "DispatchTypeDescription": "sample string 37",
      "SiteTypeDescription": "sample string 38",
      "InternalNotes": "sample string 39"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<EventRuleDetailQueryResult 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>
    <EventRuleDetailResult>
      <AbortByPointFlag>true</AbortByPointFlag>
      <AbortBySignalCodeFlag>true</AbortBySignalCodeFlag>
      <AbortLogEventCode>sample string 1</AbortLogEventCode>
      <AbortLogEventCodeDescription>sample string 2</AbortLogEventCodeDescription>
      <AbortNewPriority>1</AbortNewPriority>
      <AbortNewPriorityDescription>sample string 34</AbortNewPriorityDescription>
      <AbortOptionDescription>sample string 3</AbortOptionDescription>
      <AbortOptionNum>1</AbortOptionNum>
      <AbortSuppressionPeriod>sample string 4</AbortSuppressionPeriod>
      <AbortableSeconds>1</AbortableSeconds>
      <ActionAutoEvalDescription>sample string 33</ActionAutoEvalDescription>
      <ActionAutoEvalNum>1</ActionAutoEvalNum>
      <AlarmFlag>true</AlarmFlag>
      <AlarmOption>sample string 5</AlarmOption>
      <AlarmOptionDescription>sample string 6</AlarmOptionDescription>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <Delay>sample string 7</Delay>
      <Description>sample string 8</Description>
      <DevNum>1</DevNum>
      <DispatchType>sample string 9</DispatchType>
      <DispatchTypeDescription>sample string 37</DispatchTypeDescription>
      <EventCode>sample string 10</EventCode>
      <EventCodeDescription>sample string 11</EventCodeDescription>
      <EventRuleNum>1</EventRuleNum>
      <FailToAbortEventCode>sample string 12</FailToAbortEventCode>
      <FailToAbortEventDescr>sample string 13</FailToAbortEventDescr>
      <HoursType>sample string 35</HoursType>
      <HoursTypeDescription>sample string 36</HoursTypeDescription>
      <InternalNotes>sample string 39</InternalNotes>
      <LogOnlyFlag>true</LogOnlyFlag>
      <OverrideEventCode>sample string 14</OverrideEventCode>
      <OverrideEventCodeDescription>sample string 15</OverrideEventCodeDescription>
      <Point>sample string 16</Point>
      <PrimarySecondaryAbortFlag>true</PrimarySecondaryAbortFlag>
      <Priority>1</Priority>
      <PriorityDescription>sample string 17</PriorityDescription>
      <RestoreWaitCount>1</RestoreWaitCount>
      <RestoreWaitPeriod>sample string 18</RestoreWaitPeriod>
      <ScheduleOption>sample string 19</ScheduleOption>
      <ScheduleOptionDescription>sample string 20</ScheduleOptionDescription>
      <ServType>sample string 22</ServType>
      <ServiceTypeDescription>sample string 21</ServiceTypeDescription>
      <SigForm>sample string 23</SigForm>
      <SignalCode>sample string 24</SignalCode>
      <SignalCodeDescription>sample string 25</SignalCodeDescription>
      <SignalFormatDescription>sample string 26</SignalFormatDescription>
      <SignalStatus>sample string 27</SignalStatus>
      <SignalStatusDescription>sample string 28</SignalStatusDescription>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteType>sample string 29</SiteType>
      <SiteTypeDescription>sample string 38</SiteTypeDescription>
      <SuppressionByPointFlag>true</SuppressionByPointFlag>
      <SuppressionDuringAlarmOnlyFlag>true</SuppressionDuringAlarmOnlyFlag>
      <SuppressionEndServType>sample string 30</SuppressionEndServType>
      <SuppressionEndServTypeDescription>sample string 31</SuppressionEndServTypeDescription>
      <SuppressionPeriod>sample string 32</SuppressionPeriod>
    </EventRuleDetailResult>
    <EventRuleDetailResult>
      <AbortByPointFlag>true</AbortByPointFlag>
      <AbortBySignalCodeFlag>true</AbortBySignalCodeFlag>
      <AbortLogEventCode>sample string 1</AbortLogEventCode>
      <AbortLogEventCodeDescription>sample string 2</AbortLogEventCodeDescription>
      <AbortNewPriority>1</AbortNewPriority>
      <AbortNewPriorityDescription>sample string 34</AbortNewPriorityDescription>
      <AbortOptionDescription>sample string 3</AbortOptionDescription>
      <AbortOptionNum>1</AbortOptionNum>
      <AbortSuppressionPeriod>sample string 4</AbortSuppressionPeriod>
      <AbortableSeconds>1</AbortableSeconds>
      <ActionAutoEvalDescription>sample string 33</ActionAutoEvalDescription>
      <ActionAutoEvalNum>1</ActionAutoEvalNum>
      <AlarmFlag>true</AlarmFlag>
      <AlarmOption>sample string 5</AlarmOption>
      <AlarmOptionDescription>sample string 6</AlarmOptionDescription>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <Delay>sample string 7</Delay>
      <Description>sample string 8</Description>
      <DevNum>1</DevNum>
      <DispatchType>sample string 9</DispatchType>
      <DispatchTypeDescription>sample string 37</DispatchTypeDescription>
      <EventCode>sample string 10</EventCode>
      <EventCodeDescription>sample string 11</EventCodeDescription>
      <EventRuleNum>1</EventRuleNum>
      <FailToAbortEventCode>sample string 12</FailToAbortEventCode>
      <FailToAbortEventDescr>sample string 13</FailToAbortEventDescr>
      <HoursType>sample string 35</HoursType>
      <HoursTypeDescription>sample string 36</HoursTypeDescription>
      <InternalNotes>sample string 39</InternalNotes>
      <LogOnlyFlag>true</LogOnlyFlag>
      <OverrideEventCode>sample string 14</OverrideEventCode>
      <OverrideEventCodeDescription>sample string 15</OverrideEventCodeDescription>
      <Point>sample string 16</Point>
      <PrimarySecondaryAbortFlag>true</PrimarySecondaryAbortFlag>
      <Priority>1</Priority>
      <PriorityDescription>sample string 17</PriorityDescription>
      <RestoreWaitCount>1</RestoreWaitCount>
      <RestoreWaitPeriod>sample string 18</RestoreWaitPeriod>
      <ScheduleOption>sample string 19</ScheduleOption>
      <ScheduleOptionDescription>sample string 20</ScheduleOptionDescription>
      <ServType>sample string 22</ServType>
      <ServiceTypeDescription>sample string 21</ServiceTypeDescription>
      <SigForm>sample string 23</SigForm>
      <SignalCode>sample string 24</SignalCode>
      <SignalCodeDescription>sample string 25</SignalCodeDescription>
      <SignalFormatDescription>sample string 26</SignalFormatDescription>
      <SignalStatus>sample string 27</SignalStatus>
      <SignalStatusDescription>sample string 28</SignalStatusDescription>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteType>sample string 29</SiteType>
      <SiteTypeDescription>sample string 38</SiteTypeDescription>
      <SuppressionByPointFlag>true</SuppressionByPointFlag>
      <SuppressionDuringAlarmOnlyFlag>true</SuppressionDuringAlarmOnlyFlag>
      <SuppressionEndServType>sample string 30</SuppressionEndServType>
      <SuppressionEndServTypeDescription>sample string 31</SuppressionEndServTypeDescription>
      <SuppressionPeriod>sample string 32</SuppressionPeriod>
    </EventRuleDetailResult>
  </ResultSet>
</EventRuleDetailQueryResult>